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.
Dependencies: EthernetInterface NTPClient SDFileSystem TextLCD WebSocketClient mbed-rtos mbed Socket lwip-eth lwip-sys lwip FATFileSystem
TCPSocketServer Class Reference
TCP Server. More...
#include <TCPSocketServer.h>
Inherits Socket.
Public Member Functions | |
| TCPSocketServer () | |
| Instantiate a TCP Server. | |
| int | bind (int port) |
| Bind a socket to a specific port. | |
| int | listen (int backlog=1) |
| Start listening for incoming connections. | |
| int | accept (TCPSocketConnection &connection) |
| Accept a new connection. | |
| 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
TCP Server.
Definition at line 26 of file TCPSocketServer.h.
Constructor & Destructor Documentation
| TCPSocketServer | ( | ) |
Instantiate a TCP Server.
Definition at line 25 of file TCPSocketServer.cpp.
Member Function Documentation
| int accept | ( | TCPSocketConnection & | connection ) |
Accept a new connection.
- Parameters:
-
connection A TCPSocketConnection instance that will handle the incoming connection.
- Returns:
- 0 on success, -1 on failure.
Definition at line 60 of file TCPSocketServer.cpp.
| int bind | ( | int | port ) |
Bind a socket to a specific port.
- Parameters:
-
port The port to listen for incoming connections on.
- Returns:
- 0 on success, -1 on failure.
Definition at line 29 of file TCPSocketServer.cpp.
| int close | ( | ) | [inherited] |
Close the socket file descriptor.
Definition at line 72 of file Socket.cpp.
| int get_option | ( | int | level, |
| int | optname, | ||
| void * | optval, | ||
| socklen_t * | optlen | ||
| ) | [inherited] |
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 48 of file Socket.cpp.
| int listen | ( | int | backlog = 1 ) |
Start listening for incoming connections.
- Parameters:
-
backlog number of pending connections that can be queued up at any one time [Default: 1].
- Returns:
- 0 on success, -1 on failure.
Definition at line 48 of file TCPSocketServer.cpp.
| void set_blocking | ( | bool | blocking, |
| unsigned int | timeout = 1500 |
||
| ) | [inherited] |
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 27 of file Socket.cpp.
| int set_option | ( | int | level, |
| int | optname, | ||
| const void * | optval, | ||
| socklen_t | optlen | ||
| ) | [inherited] |
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 44 of file Socket.cpp.
Generated on Tue Jul 12 2022 14:08:13 by
1.7.2