Jon Bloom / MTS-Socket

reverted HTTPCLient debug back to defaulted off

Dependencies:   HTTPClient-SSL

Fork of MTS-Socket by Keith Ruenheck

Embed: (wiki syntax)

« Back to documentation index

TCPSocketConnection Class Reference
Public Member Functions

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.
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 (bool shutdown=true)
 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.

Detailed Description

TCP socket connection.

Definition at line 10 of file TCPSocketConnection.h.

Constructor & Destructor Documentation

TCPSocketConnection (  )

TCP socket connection.

Definition at line 9 of file TCPSocketConnection.cpp.

Member Function Documentation

int close ( bool  shutdown = true ) [inherited]

Close the socket file descriptor.

Definition at line 14 of file Socket.cpp.

int connect ( const char *  host,
const int  port 
)

Connects this TCP socket to the server.

Parameters:
hostThe host to connect to. It can either be an IP Address or a hostname that will be resolved with DNS.
portThe host's port to connect to.
Returns:
0 on success, -1 on failure.

Definition at line 13 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 39 of file Endpoint.cpp.

int get_port ( void   ) [inherited]

Get the port of this endpoint.

Returns:
The port of this endpoint

Definition at line 44 of file Endpoint.cpp.

bool is_connected ( void   )

Check if the socket is connected.

Returns:
true if connected, false otherwise.

Definition at line 25 of file TCPSocketConnection.cpp.

int receive ( char *  data,
int  length 
)

Receive data from the remote host.

Parameters:
dataThe buffer in which to store the data received from the host.
lengthThe maximum length of the buffer.
Returns:
the number of received bytes on success (>=0) or -1 on failure

Definition at line 58 of file TCPSocketConnection.cpp.

int receive_all ( char *  data,
int  length 
)

Receive all the data from the remote host.

Parameters:
dataThe buffer in which to store the data received from the host.
lengthThe maximum length of the buffer.
Returns:
the number of received bytes on success (>=0) or -1 on failure

Definition at line 80 of file TCPSocketConnection.cpp.

void reset_address ( void   ) [inherited]

Reset the address of this endpoint.

Definition at line 19 of file Endpoint.cpp.

int send ( char *  data,
int  length 
)

Send data to the remote host.

Parameters:
dataThe buffer to send to the host.
lengthThe length of the buffer to send.
Returns:
the number of written bytes on success (>=0) or -1 on failure

Definition at line 30 of file TCPSocketConnection.cpp.

int send_all ( char *  data,
int  length 
)

Send all the data to the remote host.

Parameters:
dataThe buffer to send to the host.
lengthThe length of the buffer to send.
Returns:
the number of written bytes on success (>=0) or -1 on failure

Definition at line 48 of file TCPSocketConnection.cpp.

int set_address ( const char *  host,
const int  port 
) [inherited]

Set the address of this endpoint.

Parameters:
hostThe endpoint address (it can either be an IP Address or a hostname that will be resolved with DNS).
portThe endpoint port
Returns:
0 on success, -1 on failure (when an hostname cannot be resolved by DNS).

Definition at line 25 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:
blockingtrue for blocking mode, false for non-blocking mode.
timeouttimeout in ms [Default: (1500)ms].

Definition at line 9 of file Socket.cpp.

Generated on Wed Jul 13 2022 10:29:47 by  doxygen 1.7.2