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.
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. | |
| int | open (NetworkStack *stack) |
| Opens a socket. | |
| int | close () |
| Close the socket. | |
| int | bind (uint16_t port) |
| Bind a specific address to a socket. | |
| int | bind (const char *address, uint16_t port) |
| Bind a specific address to a socket. | |
| int | 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 | attach (mbed::Callback< void()> func) |
| Register a callback on state change of the socket. | |
| template<typename T , typename M > | |
| 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
| void attach | ( | 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.
- Parameters:
-
func Function to call on state change
| int 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 72 of file Socket.cpp.
| int 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 79 of file Socket.cpp.
| int 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 86 of file Socket.cpp.
| int 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.
| 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.
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.
- Parameters:
-
obj Pointer to object to call method on method Method to call on state change
| int 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 101 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 107 of file Socket.cpp.
Generated on Tue Jul 12 2022 18:19:42 by
1.7.2