for EthernetInterface library compatibility.\\ ** Unoffical fix. may be a problem. **

Dependents:   SNIC-httpclient-example SNIC-ntpclient-example

Fork of SNICInterface by muRata

Embed: (wiki syntax)

« Back to documentation index

TCPSocketServer Class Reference

TCPSocketServer Class Reference

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

#include <TCPSocketServer.h>

Inherits Socket.

Public Member Functions

 TCPSocketServer ()
 Instantiate a TCP Server.
int bind (unsigned short port)
 Bind a socket to a specific port.
int listen (int backlog=1)
 Start listening for incoming connections.
int accept (TCPSocketConnection *connection)
 Accept a new connection.
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.

Detailed Description

Interface class for TCP server socket of using SNIC UART.

Definition at line 31 of file TCPSocketServer.h.


Constructor & Destructor Documentation

Instantiate a TCP Server.

Definition at line 26 of file TCPSocketServer.cpp.


Member Function Documentation

int accept ( TCPSocketConnection connection )

Accept a new connection.

Parameters:
connectionA TCPSocketConnection instance that will handle the incoming connection.
Returns:
0 on success, -1 on failure.

Definition at line 159 of file TCPSocketServer.cpp.

int bind ( unsigned short  port )

Bind a socket to a specific port.

Parameters:
portThe port to listen for incoming connections on.
Returns:
0 on success, -1 on failure.

Definition at line 34 of file TCPSocketServer.cpp.

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 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 listen ( int  backlog = 1 )

Start listening for incoming connections.

Parameters:
backlognumber of pending connections that can be queued up at any one time [Default: 1].
Returns:
0 on success, -1 on failure.

Definition at line 101 of file TCPSocketServer.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.