BA / SerialCom

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.

Fork of OmniWheels by Gustav Atmel

Embed: (wiki syntax)

« Back to documentation index

Fnet_polling
Typedefs | Functions

Fnet_polling

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_paramThis 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:
servicePointer to the service-polling routine.
service_paramService-polling-routine-specific parameter.
Returns:
This function returns:
  • Service descriptor, if no error occurs.
  • 0 if 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.

See also:
fnet_poll_service_register(), fnet_poll_service_unregister()

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:
descService 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 Fri Jul 22 2022 04:54:11 by  doxygen 1.7.2