KDDI Fx0 hackathon / SNICInterface

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.

Embed: (wiki syntax)

« Back to documentation index

TCPSocketConnection Class Reference
Public Member Functions

TCPSocketConnection Class Reference

Interface class for TCP socket of using SNIC UART. More...

#include <TCPSocketConnection.h>

Inherits Socket, and Endpoint.

Public Member Functions

 TCPSocketConnection ()
 TCP socket connection.
int connect (const char *ip_addr_p, unsigned short port)
 Connects this TCP socket to the server.
bool is_connected (void)
 Check if the socket is connected.
int send (char *data_p, int length)
 Send data to the remote host.
int send_all (char *data_p, int length)
 Send data to the remote host.
int receive (char *data_p, int length)
 Receive data from the remote host.
int receive_all (char *data_p, int length)
 Send data to 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 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 (bool shutdown=true)
 Close the socket.
void reset_address (void)
 Reset the address of this endpoint.
int set_address (const char *host_p, 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

Interface class for TCP socket of using SNIC UART.

Definition at line 30 of file TCPSocketConnection.h.

Constructor & Destructor Documentation

TCPSocketConnection (  )

TCP socket connection.

Definition at line 24 of file TCPSocketConnection.cpp.

Member Function Documentation

int close ( bool  shutdown = true ) [inherited]

Close the socket.

Parameters:
shutdownfree the left-over data in message queues

Definition at line 48 of file Socket.cpp.

int connect ( const char *  ip_addr_p,
unsigned short  port 
)

Connects this TCP socket to the server.

Parameters:
hostThe strings of ip address.
portThe host's port to connect to.
Returns:
0 on success, -1 on failure.
Note:
This function is blocked until a returns. When you use it by UI thread, be careful.

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

int get_option ( int  level,
int  optname,
void *  optval,
socklen_t *  optlen 
) [inherited]

Get socket options.

Parameters:
levelstack level (see: lwip/sockets.h)
optnameoption ID
optvalbuffer pointer where to write the option value
socklen_tlength of the option value
Returns:
0 on success, -1 on failure

Definition at line 44 of file Socket.cpp.

int get_port ( void   ) [inherited]

Get the port of this endpoint.

Returns:
The port of this endpoint

Definition at line 55 of file Endpoint.cpp.

bool is_connected ( void   )

Check if the socket is connected.

Returns:
true if connected, false otherwise.

Definition at line 128 of file TCPSocketConnection.cpp.

int receive ( char *  data_p,
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 202 of file TCPSocketConnection.cpp.

int receive_all ( char *  data_p,
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 264 of file TCPSocketConnection.cpp.

void reset_address ( void   ) [inherited]

Reset the address of this endpoint.

Definition at line 35 of file Endpoint.cpp.

int send ( char *  data_p,
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 135 of file TCPSocketConnection.cpp.

int send_all ( char *  data_p,
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 197 of file TCPSocketConnection.cpp.

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

Set the address of this endpoint.

Parameters:
host_pThe 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 40 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 31 of file Socket.cpp.

int set_option ( int  level,
int  optname,
const void *  optval,
socklen_t  optlen 
) [inherited]

Set socket options.

Parameters:
levelstack level (see: lwip/sockets.h)
optnameoption ID
optvaloption value
socklen_tlength of the option value
Returns:
0 on success, -1 on failure

Definition at line 40 of file Socket.cpp.

Generated on Thu Jul 14 2022 20:28:29 by  doxygen 1.7.2