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

Socket Class Reference

Socket Class Reference

Socket file descriptor and select wrapper. More...

#include <Socket.h>

Inherited by TCPSocketConnection, TCPSocketServer, and UDPSocket.

Public Member Functions

 Socket ()
 Socket.
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

Socket file descriptor and select wrapper.

Definition at line 36 of file Socket.h.


Constructor & Destructor Documentation

Socket (  )

Socket.

Definition at line 26 of file Socket.cpp.


Member Function Documentation

int close ( bool  shutdown = true )

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 
)

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.

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.

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 
)

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.