Base class for IP Based Networking Libraries
Dependencies: DnsQuery
Dependents: TempTower BSDInterfaceTests HelloBSDInterface ESP8266InterfaceTests ... more
TCPSocket Class Reference
TCP socket connection. More...
#include <TCPSocket.h>
Inherits Socket.
Public Member Functions | |
TCPSocket () | |
Create an uninitialized socket. | |
TCPSocket (NetworkStack *iface) | |
Create a socket on a network stack. | |
virtual int | open (NetworkStack *iface) |
Opens a socket. | |
int | connect (const char *host, uint16_t port) |
Connects TCP socket to a remote host. | |
int | connect (const SocketAddress &address) |
Connects TCP socket to a remote host. | |
int | send (const void *data, unsigned size) |
Send data over a TCP socket. | |
int | recv (void *data, unsigned size) |
Receive data over a TCP 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 (FunctionPointer callback) |
Register a callback on state change of the socket. | |
template<typename T , typename M > | |
void | attach (T *tptr, M mptr) |
Register a callback on state change of the socket. | |
Friends | |
class | TCPServer |
Detailed Description
TCP socket connection.
Definition at line 25 of file TCPSocket.h.
Constructor & Destructor Documentation
TCPSocket | ( | ) |
Create an uninitialized socket.
Must call open to initialize the socket on a network stack.
Definition at line 20 of file TCPSocket.cpp.
TCPSocket | ( | NetworkStack * | iface ) |
Create a socket on a network stack.
Creates and opens a socket on the specified network stack.
- Parameters:
-
iface Network stack as target for socket
Definition at line 24 of file TCPSocket.cpp.
Member Function Documentation
void attach | ( | FunctionPointer | callback ) | [inherited] |
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:
-
callback Function to call on state change
Definition at line 124 of file Socket.cpp.
void attach | ( | T * | tptr, |
M | mptr | ||
) | [inherited] |
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:
-
tptr Pointer to object to call method on mptr Method to call on state change
int bind | ( | const char * | address, |
uint16_t | port | ||
) | [inherited] |
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 68 of file Socket.cpp.
int bind | ( | const SocketAddress & | address ) | [inherited] |
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 74 of file Socket.cpp.
int bind | ( | uint16_t | port ) | [inherited] |
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 62 of file Socket.cpp.
int close | ( | ) | [inherited] |
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 49 of file Socket.cpp.
int connect | ( | const SocketAddress & | address ) |
Connects TCP socket to a remote host.
Initiates a connection to a remote server specified by the indicated address.
- Parameters:
-
address The SocketAddress of the remote host
- Returns:
- 0 on success, negative error code on failure
Definition at line 34 of file TCPSocket.cpp.
int connect | ( | const char * | host, |
uint16_t | port | ||
) |
Connects TCP socket to a remote host.
Initiates a connection to a remote server specified by either a domain name or an IP address and a port.
- Parameters:
-
host Hostname of the remote host port Port of the remote host
- Returns:
- 0 on success, negative error code on failure
Definition at line 43 of file TCPSocket.cpp.
int open | ( | NetworkStack * | iface ) | [virtual] |
Opens a socket.
Creates a network socket on the specified network stack. Not needed if stack is passed to the socket's constructor.
- Parameters:
-
iface Network stack as target for socket
- Returns:
- 0 on success, negative error code on failure
Implements Socket.
Definition at line 29 of file TCPSocket.cpp.
int recv | ( | void * | data, |
unsigned | size | ||
) |
Receive data over a TCP socket.
The socket must be connected to a remote host. Returns the number of bytes received into the buffer.
By default, recv blocks until data is sent. If socket is set to non-blocking or times out, NSAPI_ERROR_WOULD_BLOCK is returned immediately.
- Parameters:
-
data Destination buffer for data received from the host size Size of the buffer in bytes
- Returns:
- Number of received bytes on success, negative error code on failure
Definition at line 77 of file TCPSocket.cpp.
int send | ( | const void * | data, |
unsigned | size | ||
) |
Send data over a TCP socket.
The socket must be connected to a remote host. Returns the number of bytes sent from the buffer.
By default, send blocks until data is sent. If socket is set to non-blocking or times out, NSAPI_ERROR_WOULD_BLOCK is returned immediately.
- Parameters:
-
data Buffer of data to send to the host size Size of the buffer in bytes
- Returns:
- Number of sent bytes on success, negative error code on failure
Definition at line 53 of file TCPSocket.cpp.
void set_blocking | ( | bool | blocking ) | [inherited] |
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 83 of file Socket.cpp.
void set_timeout | ( | int | timeout ) | [inherited] |
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 -1 removes the timeout from the socket.
set_timeout(-1) is equivalent to set_blocking(false) set_timeout(0) is equivalent to set_blocking(true)
- Parameters:
-
timeout Timeout in milliseconds
Definition at line 88 of file Socket.cpp.
Generated on Tue Jul 12 2022 14:52:52 by 1.7.2