BSD socket service API.
More...
BSD socket service API.
- Since
- 3.6
- Version
- 0.2.0
◆ NET_SOCKET_SERVICE_SYNC_DEFINE
| #define NET_SOCKET_SERVICE_SYNC_DEFINE |
( |
| name, |
|
|
| cb, |
|
|
| count ) |
#include <zephyr/net/socket_service.h>
Value:__z_net_socket_service_define(name, cb, count)
Statically define a network socket service.
The user callback is called synchronously for this service meaning that the service API will wait until the user callback returns before continuing with next socket service.
The socket service can be accessed outside the module where it is defined using:
Main structure holding socket service configuration information.
Definition socket_service.h:71
- Note
- This macro cannot be used together with a static keyword. If such a use-case is desired, use NET_SOCKET_SERVICE_SYNC_DEFINE_STATIC instead.
- Parameters
-
| name | Name of the service. |
| cb | Callback function that is called for socket activity. |
| count | How many pollable sockets is needed for this service. |
◆ NET_SOCKET_SERVICE_SYNC_DEFINE_STATIC
| #define NET_SOCKET_SERVICE_SYNC_DEFINE_STATIC |
( |
| name, |
|
|
| cb, |
|
|
| count ) |
#include <zephyr/net/socket_service.h>
Value:__z_net_socket_service_define(name, cb, count, static)
Statically define a network socket service in a private (static) scope.
The user callback is called synchronously for this service meaning that the service API will wait until the user callback returns before continuing with next socket service.
- Parameters
-
| name | Name of the service. |
| cb | Callback function that is called for socket activity. |
| count | How many pollable sockets is needed for this service. |
◆ net_socket_service_cb_t
#include <zephyr/net/socket_service.h>
Callback used while iterating over socket services.
- Parameters
-
| svc | Pointer to current socket service. |
| user_data | A valid pointer to user data or NULL |
◆ net_socket_service_handler_t
#include <zephyr/net/socket_service.h>
The signature for a net socket service handler function.
The function will be invoked by the socket service.
- Parameters
-
| pev | the socket service event that provided the handler. |
◆ net_socket_service_close()
#include <zephyr/net/socket_service.h>
Unregister pollable sockets and automatically close the socket.
- Parameters
-
| service | Pointer to a service description. |
- Return values
-
| 0 | No error |
| -ENOENT | Service is not found. |
| -EIO | The socket service thread is not running. |
◆ net_socket_service_foreach()
#include <zephyr/net/socket_service.h>
Go through all the socket services and call callback for each service.
- Parameters
-
| cb | User-supplied callback function to call |
| user_data | User specified data |
◆ net_socket_service_register()
#include <zephyr/net/socket_service.h>
Register pollable sockets.
- Parameters
-
| service | Pointer to a service description. |
| fds | Socket array to poll. |
| len | Length of the socket array. |
| user_data | User specific data. |
- Return values
-
| 0 | No error |
| -ENOENT | Service is not found. |
| -ENOMEM | Too many sockets for this service. |
| -EIO | The socket service thread is not running. |
◆ net_socket_service_register_single_fd()
#include <zephyr/net/socket_service.h>
Register a single pollable socket to a socket service by placing it in the first free slot of the service's event array.
Unlike net_socket_service_register(), existing entries are left untouched, so this can be called repeatedly to add sockets one at a time.
- Parameters
-
| service | Pointer to a service description. |
| pfd | Pollable socket. |
| user_data | User specific data passed to the callback for this socket. |
- Return values
-
| 0 | No error |
| -ENOENT | Service is not found. |
| -EINVAL | pfd is NULL or its file descriptor is negative. |
| -EEXIST | The file descriptor is already registered with the service. |
| -ENOMEM | All file descriptor slots of the service are in use. |
| -EIO | The socket service thread is not running. |
◆ net_socket_service_unregister()
#include <zephyr/net/socket_service.h>
Unregister pollable sockets.
- Parameters
-
| service | Pointer to a service description. |
- Return values
-
| 0 | No error |
| -ENOENT | Service is not found. |
| -EIO | The socket service thread is not running. |
◆ net_socket_service_unregister_single_fd()
#include <zephyr/net/socket_service.h>
Unregister a single pollable socket from a socket service.
The socket is not closed. If the socket is already scheduled to be closed by net_socket_service_close(), it is left registered so that the close still happens, and -ENOENT is returned.
- Parameters
-
| service | Pointer to a service description. |
| fd | File descriptor of the pollable socket. |
- Return values
-
| 0 | No error |
| -EINVAL | fd is negative. |
| -ENOENT | Service is not found, or fd is not registered with the service (or is scheduled to be closed). |
| -EIO | The socket service thread is not running. |