Marco Zecchini
Rtos API example
Socket Class Reference
[Netsocket]
Abstract socket class. More...
#include <Socket.h>
Inherited by TCPServer, TCPSocket, and UDPSocket.
Public Member Functions | |
| virtual | ~Socket () |
| Destroy a socket. | |
| nsapi_error_t | open (NetworkStack *stack) |
| Opens a socket. | |
| nsapi_error_t | close () |
| Close the socket. | |
| int | join_multicast_group (const SocketAddress &address) |
| Subscribes to an IP multicast group. | |
| int | leave_multicast_group (const SocketAddress &address) |
| Leave an IP multicast group. | |
| nsapi_error_t | bind (uint16_t port) |
| Bind a specific address to a socket. | |
| nsapi_error_t | bind (const char *address, uint16_t port) |
| Bind a specific address to a socket. | |
| nsapi_error_t | bind (const SocketAddress &address) |
| Bind a specific address to a socket. | |
| void | set_blocking (bool blocking) |
| Set blocking or non-blocking mode of the socket. | |
| void | set_timeout (int timeout) |
| Set timeout on blocking socket operations. | |
| void | sigio (mbed::Callback< void()> func) |
| Register a callback on state change of the socket. | |
| template<typename T , typename M > | |
| MBED_DEPRECATED_SINCE("mbed-os-5.4","The behaviour of Socket::attach differs from other attach functions in ""mbed OS and has been known to cause confusion. Replaced by Socket::sigio.") void attach(mbed | MBED_DEPRECATED_SINCE ("mbed-os-5.1","The attach function does not support cv-qualifiers. Replaced by ""attach(callback(obj, method)).") void attach(T *obj |
| Register a callback on state change of the socket. | |
Detailed Description
Abstract socket class.
Definition at line 32 of file Socket.h.
Constructor & Destructor Documentation
| virtual ~Socket | ( | ) | [virtual] |
Member Function Documentation
| nsapi_error_t bind | ( | uint16_t | port ) |
Bind a specific address to a socket.
Binding a socket specifies the address and port on which to recieve data.
- Parameters:
-
port Local port to bind
- Returns:
- 0 on success, negative error code on failure.
Definition at line 95 of file Socket.cpp.
| nsapi_error_t bind | ( | const SocketAddress & | address ) |
Bind a specific address to a socket.
Binding a socket specifies the address and port on which to recieve data. If the IP address is zeroed, only the port is bound.
- Parameters:
-
address Local address to bind
- Returns:
- 0 on success, negative error code on failure.
Definition at line 109 of file Socket.cpp.
| nsapi_error_t bind | ( | const char * | address, |
| uint16_t | port | ||
| ) |
Bind a specific address to a socket.
Binding a socket specifies the address and port on which to recieve data. If the IP address is zeroed, only the port is bound.
- Parameters:
-
address Null-terminated local address to bind port Local port to bind
- Returns:
- 0 on success, negative error code on failure.
Definition at line 102 of file Socket.cpp.
| nsapi_error_t close | ( | void | ) |
Close the socket.
Closes any open connection and deallocates any memory associated with the socket. Called from destructor if socket is not closed.
- Returns:
- 0 on success, negative error code on failure
Definition at line 52 of file Socket.cpp.
| int join_multicast_group | ( | const SocketAddress & | address ) |
Subscribes to an IP multicast group.
- Parameters:
-
address Multicast group IP address
- Returns:
- Negative error code on failure
Reimplemented in TCPSocket.
Definition at line 84 of file Socket.cpp.
| int leave_multicast_group | ( | const SocketAddress & | address ) |
Leave an IP multicast group.
- Parameters:
-
address Multicast group IP address
- Returns:
- Negative error code on failure
Definition at line 89 of file Socket.cpp.
| MBED_DEPRECATED_SINCE ("mbed-os-5.4", "The behaviour of Socket::attach differs from other attach functions in " "mbed OS and has been known to cause confusion. Replaced by Socket::sigio.") void attach(mbed MBED_DEPRECATED_SINCE | ( | "mbed-os-5.1" | , |
| "The attach function does not support cv-qualifiers. Replaced by ""attach(callback(obj, method))." | |||
| ) |
Register a callback on state change of the socket.
- See also:
- Socket::sigio
Register a callback on state change of the socket
- See also:
- Socket::sigio
| nsapi_error_t open | ( | NetworkStack * | stack ) |
Opens a socket.
Creates a network socket on the network stack of the given network interface. Not needed if stack is passed to the socket's constructor.
- Parameters:
-
stack Network stack as target for socket
- Returns:
- 0 on success, negative error code on failure
Definition at line 27 of file Socket.cpp.
| void set_blocking | ( | bool | blocking ) |
Set blocking or non-blocking mode of the socket.
Initially all sockets are in blocking mode. In non-blocking mode blocking operations such as send/recv/accept return NSAPI_ERROR_WOULD_BLOCK if they can not continue.
set_blocking(false) is equivalent to set_timeout(-1) set_blocking(true) is equivalent to set_timeout(0)
- Parameters:
-
blocking true for blocking mode, false for non-blocking mode.
Definition at line 124 of file Socket.cpp.
| void set_timeout | ( | int | timeout ) |
Set timeout on blocking socket operations.
Initially all sockets have unbounded timeouts. NSAPI_ERROR_WOULD_BLOCK is returned if a blocking operation takes longer than the specified timeout. A timeout of 0 removes the timeout from the socket. A negative value give the socket an unbounded timeout.
set_timeout(0) is equivalent to set_blocking(false) set_timeout(-1) is equivalent to set_blocking(true)
- Parameters:
-
timeout Timeout in milliseconds
Definition at line 130 of file Socket.cpp.
| void sigio | ( | mbed::Callback< void()> | func ) |
Register a callback on state change of the socket.
The specified callback will be called on state changes such as when the socket can recv/send/accept successfully and on when an error occurs. The callback may also be called spuriously without reason.
The callback may be called in an interrupt context and should not perform expensive operations such as recv/send calls.
Note! This is not intended as a replacement for a poll or attach-like asynchronous api, but rather as a building block for constructing such functionality. The exact timing of when the registered function is called is not guaranteed and susceptible to change.
- Parameters:
-
func Function to call on state change
Generated on Sun Jul 17 2022 08:25:42 by
1.7.2