V.06 11/3
Dependencies: FT6206 SDFileSystem SPI_TFT_ILI9341 TFT_fonts
Fork of ATT_AWS_IoT_demo by
WNCTCPSocketConnection Class Reference
TCP socket connection. More...
#include <WNCTCPSocketConnection.h>
Inherits WNCSocket, and WNCEndpoint.
Public Member Functions | |
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. | |
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. | |
int | close (void) |
Close the socket. | |
void | reset_address (void) |
Reset the address of the endpoint by clearning the internal endpoint IP address. | |
int | set_address (const char *host, const int port) |
Set the address of the endpoint. | |
char * | get_address (void) |
Get the IP address of the endpoint. | |
int | get_port (void) |
Get the port of the endpoint. |
Detailed Description
TCP socket connection.
Definition at line 34 of file WNCTCPSocketConnection.h.
Member Function Documentation
int close | ( | void | ) |
Close the socket.
- Parameters:
-
none
- Returns:
- 0 if closed successfully, -1 on failure
Definition at line 117 of file WNCTCPSocketConnection.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 49 of file WNCTCPSocketConnection.cpp.
char * get_address | ( | void | ) | [inherited] |
Get the IP address of the endpoint.
- Returns:
- The IP address of the endpoint.
Definition at line 71 of file WNCEndpoint.cpp.
int get_port | ( | void | ) | [inherited] |
Get the port of the endpoint.
- Returns:
- The port of the endpoint
Definition at line 75 of file WNCEndpoint.cpp.
bool is_connected | ( | void | ) |
Check if the socket is connected.
- Returns:
- true if connected, false otherwise.
Definition at line 55 of file WNCTCPSocketConnection.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 75 of file WNCTCPSocketConnection.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 113 of file WNCTCPSocketConnection.cpp.
void reset_address | ( | void | ) | [inherited] |
Reset the address of the endpoint by clearning the internal endpoint IP address.
- Parameters:
-
none
- Returns:
- none.
Definition at line 35 of file WNCEndpoint.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 59 of file WNCTCPSocketConnection.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 109 of file WNCTCPSocketConnection.cpp.
int set_address | ( | const char * | host, |
const int | port | ||
) | [inherited] |
Set the address of the 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 45 of file WNCEndpoint.cpp.
void set_blocking | ( | bool | blocking, |
unsigned int | timeout = 1500 |
||
) |
Set blocking or non-blocking mode of the socket and a timeout.
- Parameters:
-
blocking true for blocking mode, false for non-blocking mode.
- Returns:
- none
Reimplemented from WNCSocket.
Definition at line 37 of file WNCTCPSocketConnection.cpp.
Generated on Tue Jul 12 2022 14:16:20 by 1.7.2