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.
Fork of
WIZnet_Library
by 
WIZnet
TCPSocketConnection Class Reference
TCP socket connection. More...
#include <TCPSocketConnection.h>
Inherits Socket, and Endpoint.
Public Member Functions | |
| TCPSocketConnection () | |
| TCP socket connection. | |
| int | connect (const char *host, const int port) |
| Connects this TCP socket to the server. | |
| bool | is_connected (void) |
| Check if the socket is connected. | |
| bool | is_fin_received (void) |
| Check if FIN signal received. | |
| int | send (char *data, int length) |
| Send data to the remote host. | |
| int | send_all (char *data, int length) |
| Send all the data to the remote host. | |
| int | receive (char *data, int length) |
| Receive data from the remote host. | |
| int | receive_all (char *data, int length) |
| Receive all the data from the remote host. | |
| 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 | close () |
| Close the socket file descriptor. | |
| void | reset_address (void) |
| Reset the address of this endpoint. | |
| int | set_address (const char *host, const int port) |
| Set the address of this endpoint. | |
| char * | get_address (void) |
| Get the IP address of this endpoint. | |
| int | get_port (void) |
| Get the port of this endpoint. | |
Friends | |
| class | TCPSocketServer |
Detailed Description
TCP socket connection.
Definition at line 28 of file TCPSocketConnection.h.
Constructor & Destructor Documentation
TCP socket connection.
Definition at line 21 of file TCPSocketConnection.cpp.
Member Function Documentation
| int close | ( | ) | [inherited] |
Close the socket file descriptor.
Definition at line 33 of file Socket.cpp.
| int connect | ( | const char * | host, |
| const int | port | ||
| ) |
Connects this TCP socket to the server.
- Parameters:
-
host The host to connect to. It can either be an IP Address or a hostname that will be resolved with DNS. port The host's port to connect to.
- Returns:
- 0 on success, -1 on failure.
Definition at line 25 of file TCPSocketConnection.cpp.
| char * get_address | ( | void | ) | [inherited] |
Get the IP address of this endpoint.
- Returns:
- The IP address of this endpoint.
Definition at line 46 of file Endpoint.cpp.
| int get_port | ( | void | ) | [inherited] |
Get the port of this endpoint.
- Returns:
- The port of this endpoint
Definition at line 50 of file Endpoint.cpp.
| bool is_connected | ( | void | ) |
Check if the socket is connected.
- Returns:
- true if connected, false otherwise.
Definition at line 42 of file TCPSocketConnection.cpp.
| bool is_fin_received | ( | void | ) |
Check if FIN signal received.
- Returns:
- true if received, false otherwise.
Definition at line 48 of file TCPSocketConnection.cpp.
| int receive | ( | char * | data, |
| int | length | ||
| ) |
Receive data from the remote host.
- Parameters:
-
data The buffer in which to store the data received from the host. length The maximum length of the buffer.
- Returns:
- the number of received bytes on success (>=0) or -1 on failure
Definition at line 87 of file TCPSocketConnection.cpp.
| int receive_all | ( | char * | data, |
| int | length | ||
| ) |
Receive all the data from the remote host.
- Parameters:
-
data The buffer in which to store the data received from the host. length The maximum length of the buffer.
- Returns:
- the number of received bytes on success (>=0) or -1 on failure
Definition at line 100 of file TCPSocketConnection.cpp.
| void reset_address | ( | void | ) | [inherited] |
Reset the address of this endpoint.
Definition at line 26 of file Endpoint.cpp.
| int send | ( | char * | data, |
| int | length | ||
| ) |
Send data to the remote host.
- Parameters:
-
data The buffer to send to the host. length The length of the buffer to send.
- Returns:
- the number of written bytes on success (>=0) or -1 on failure
Definition at line 53 of file TCPSocketConnection.cpp.
| int send_all | ( | char * | data, |
| int | length | ||
| ) |
Send all the data to the remote host.
- Parameters:
-
data The buffer to send to the host. length The length of the buffer to send.
- Returns:
- the number of written bytes on success (>=0) or -1 on failure
Definition at line 66 of file TCPSocketConnection.cpp.
| int set_address | ( | const char * | host, |
| const int | port | ||
| ) | [inherited] |
Set the address of this endpoint.
- Parameters:
-
host The endpoint address (it can either be an IP Address or a hostname that will be resolved with DNS). port The endpoint port
- Returns:
- 0 on success, -1 on failure (when an hostname cannot be resolved by DNS).
Definition at line 31 of file Endpoint.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 28 of file Socket.cpp.
Generated on Thu Jul 14 2022 08:03:44 by
1.7.2