Mistake on this page?
Report an issue in GitHub or email us
Public Member Functions | Protected Member Functions | Protected Attributes
Socket Class Referenceabstract

#include <Socket.h>

Inheritance diagram for Socket:
TCPServer TCPSocket UDPSocket EchoSocket

Public Member Functions

virtual ~Socket ()
 
nsapi_error_t open (NetworkStack *stack)
 
template<typename S >
nsapi_error_t open (S *stack)
 
nsapi_error_t close ()
 
int join_multicast_group (const SocketAddress &address)
 
int leave_multicast_group (const SocketAddress &address)
 
nsapi_error_t bind (uint16_t port)
 
nsapi_error_t bind (const char *address, uint16_t port)
 
nsapi_error_t bind (const SocketAddress &address)
 
void set_blocking (bool blocking)
 
void set_timeout (int timeout)
 
nsapi_error_t setsockopt (int level, int optname, const void *optval, unsigned optlen)
 
nsapi_error_t getsockopt (int level, int optname, void *optval, unsigned *optlen)
 
void sigio (mbed::Callback< void()> func)
 
void attach (mbed::Callback< void()> func)
 
template<typename T , typename M >
void attach (T *obj, M method)
 

Protected Member Functions

virtual nsapi_protocol_t get_proto ()=0
 
virtual void event ()=0
 
int modify_multicast_group (const SocketAddress &address, nsapi_socket_option_t socketopt)
 

Protected Attributes

NetworkStack_stack
 
nsapi_socket_t _socket
 
uint32_t _timeout
 
mbed::Callback< void()> _event
 
mbed::Callback< void()> _callback
 
rtos::Mutex _lock
 

Detailed Description

Abstract socket class

Constructor & Destructor Documentation

virtual Socket::~Socket ( )
inlinevirtual

Destroy a socket

Closes socket if the socket is still open

Member Function Documentation

void Socket::attach ( mbed::Callback< void()>  func)

Register a callback on state change of the socket

See also
Socket::sigio
Deprecated:
The behaviour of Socket::attach differs from other attach functions in mbed OS and has been known to cause confusion. Replaced by Socket::sigio.
template<typename T , typename M >
void Socket::attach ( T *  obj,
method 
)
inline

Register a callback on state change of the socket

See also
Socket::sigio
Deprecated:
The attach function does not support cv-qualifiers. Replaced by attach(callback(obj, method)).
nsapi_error_t Socket::bind ( uint16_t  port)

Bind a specific address to a socket

Binding a socket specifies the address and port on which to receive data.

Parameters
portLocal port to bind
Returns
0 on success, negative error code on failure.
nsapi_error_t Socket::bind ( const char *  address,
uint16_t  port 
)

Bind a specific address to a socket

Binding a socket specifies the address and port on which to receive data. If the IP address is zeroed, only the port is bound.

Parameters
addressNull-terminated local address to bind
portLocal port to bind
Returns
0 on success, negative error code on failure.
nsapi_error_t Socket::bind ( const SocketAddress address)

Bind a specific address to a socket

Binding a socket specifies the address and port on which to receive data. If the IP address is zeroed, only the port is bound.

Parameters
addressLocal address to bind
Returns
0 on success, negative error code on failure.
nsapi_error_t Socket::close ( void  )

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
int Socket::join_multicast_group ( const SocketAddress address)

Subscribes to an IP multicast group

Parameters
addressMulticast group IP address
Returns
Negative error code on failure
int Socket::leave_multicast_group ( const SocketAddress address)

Leave an IP multicast group

Parameters
addressMulticast group IP address
Returns
Negative error code on failure
nsapi_error_t Socket::open ( NetworkStack stack)

Opens a socket

Creates a network socket on the network stack of the given network interface. Not needed if stack is passed to the socket's constructor.

Parameters
stackNetwork stack as target for socket
Returns
0 on success, negative error code on failure
void Socket::set_blocking ( bool  blocking)

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
blockingtrue for blocking mode, false for non-blocking mode.
void Socket::set_timeout ( int  timeout)

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 0 removes the timeout from the socket. A negative value give the socket an unbounded timeout.

set_timeout(0) is equivalent to set_blocking(false) set_timeout(-1) is equivalent to set_blocking(true)

Parameters
timeoutTimeout in milliseconds
void Socket::sigio ( mbed::Callback< void()>  func)

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.

Note! This is not intended as a replacement for a poll or attach-like asynchronous api, but rather as a building block for constructing such functionality. The exact timing of when the registered function is called is not guaranteed and susceptible to change.

Parameters
funcFunction to call on state change

The documentation for this class was generated from the following files:
Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.