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
Socket file descriptor and select wrapper. More...
#include <Socket.h>
Inherited by TCPSocketConnection, TCPSocketServer, and UDPSocket.
Public Member Functions | |
| Socket () | |
| Socket. | |
| void | set_blocking (bool blocking, unsigned int timeout=1500) |
| Set blocking or non-blocking mode of the socket and a timeout on blocking socket operations. | |
| int | set_option (int level, int optname, const void *optval, socklen_t optlen) |
| Set socket options. | |
| int | get_option (int level, int optname, void *optval, socklen_t *optlen) |
| Get socket options. | |
| int | close () |
| Close the socket file descriptor. | |
Detailed Description
Socket file descriptor and select wrapper.
Definition at line 29 of file Socket.h.
Constructor & Destructor Documentation
| Socket | ( | ) |
Definition at line 22 of file Socket.cpp.
Member Function Documentation
| int close | ( | ) |
Close the socket file descriptor.
Definition at line 97 of file Socket.cpp.
| int get_option | ( | int | level, |
| int | optname, | ||
| void * | optval, | ||
| socklen_t * | optlen | ||
| ) |
Get socket options.
- Parameters:
-
level stack level (see: lwip/sockets.h) optname option ID optval buffer pointer where to write the option value socklen_t length of the option value
- Returns:
- 0 on success, -1 on failure
Definition at line 60 of file Socket.cpp.
| void set_blocking | ( | bool | blocking, |
| unsigned int | timeout = 1500 |
||
| ) |
Set blocking or non-blocking mode of the socket and a timeout on blocking socket operations.
- Parameters:
-
blocking true for blocking mode, false for non-blocking mode. timeout timeout in ms [Default: (1500)ms].
Definition at line 47 of file Socket.cpp.
| int set_option | ( | int | level, |
| int | optname, | ||
| const void * | optval, | ||
| socklen_t | optlen | ||
| ) |
Set socket options.
- Parameters:
-
level stack level (see: lwip/sockets.h) optname option ID optval option value socklen_t length of the option value
- Returns:
- 0 on success, -1 on failure
Definition at line 52 of file Socket.cpp.
Generated on Tue Jul 12 2022 18:55:02 by
1.7.2