Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependents: TYBLE16_simple_data_logger TYBLE16_MP3_Air
Typedefs | |
| typedef fnet_uint32_t | fnet_poll_desc_t |
| Descriptor of a registered service. | |
| typedef void(* | fnet_poll_service_t )(void *service_param) |
| Service callback function prototype. | |
Functions | |
| void | fnet_poll_service (void) |
| Main polling function. | |
| void | fnet_poll_service_release (void) |
| Unregisters all registered service routines. | |
| fnet_poll_desc_t | fnet_poll_service_register (fnet_poll_service_t service, void *service_param) |
| Registers the service routine in the polling list. | |
| void | fnet_poll_service_unregister (fnet_poll_desc_t desc) |
| Unregisters the service routine. | |
Detailed Description
The polling mechanism enables the execution of registered services (DHCP client, TFTP client, Shell, Telnet server or HTTP server) in "background" - during the application idle time. Typically, the polling callback is registered during the service initialization (for example the fnet_http_init() or other service initialization function). In order to make the polling mechanism work, the user application should call the fnet_poll_service() API function periodically, during the idle time.
Configuration parameters:
- FNET_CFG_POLL_MAX
Typedef Documentation
| typedef fnet_uint32_t fnet_poll_desc_t |
Descriptor of a registered service.
Definition at line 48 of file fnet_poll.h.
| typedef void(* fnet_poll_service_t)(void *service_param) |
Service callback function prototype.
- Parameters:
-
service_param This parameter is assigned during a service registration by the fnet_poll_service_register().
Definition at line 58 of file fnet_poll.h.
Function Documentation
| void fnet_poll_service | ( | void | ) |
Main polling function.
- See also:
- fnet_poll_service_register()
This function calls all registered service routines.
The user application should call this function periodically, after any service initialization.
Definition at line 51 of file fnet_poll.c.
| fnet_poll_desc_t fnet_poll_service_register | ( | fnet_poll_service_t | service, |
| void * | service_param | ||
| ) |
Registers the service routine in the polling list.
- Parameters:
-
service Pointer to the service-polling routine. service_param Service-polling-routine-specific parameter.
- Returns:
- This function returns:
- Service descriptor, if no error occurs.
0if an error occurs.
- See also:
- fnet_poll_service_unregister()
This function adds the service routine into the polling list.
This function is usually called during a service initialization. User application should not call this function directly.
Definition at line 76 of file fnet_poll.c.
| void fnet_poll_service_release | ( | void | ) |
Unregisters all registered service routines.
This function unregisters all registered service routines from the polling list.
Definition at line 68 of file fnet_poll.c.
| void fnet_poll_service_unregister | ( | fnet_poll_desc_t | desc ) |
Unregisters the service routine.
- Parameters:
-
desc Service descriptor to be unregistered.
- See also:
- fnet_poll_service_register()
This function unregisters the service routine assigned to the desc descriptor.
This function is usually called during a service release. User application should not call this function directly.
Definition at line 107 of file fnet_poll.c.
Generated on Tue Jul 12 2022 13:55:26 by
1.7.2