NetworkSocketAPI / NetworkSocketAPI

Base class for IP Based Networking Libraries

Dependencies:   DnsQuery

Dependents:   TempTower BSDInterfaceTests HelloBSDInterface ESP8266InterfaceTests ... more

Embed: (wiki syntax)

« Back to documentation index

UDPSocket Class Reference
Public Member Functions

UDPSocket Class Reference

UDP socket. More...

#include <UDPSocket.h>

Inherits Socket.

Public Member Functions

 UDPSocket ()
 Create an uninitialized socket.
 UDPSocket (NetworkStack *iface)
 Create a socket on a network stack.
virtual int open (NetworkStack *iface)
 Opens a socket.
int sendto (const char *host, uint16_t port, const void *data, unsigned size)
 Send a packet over a UDP socket.
int sendto (const SocketAddress &address, const void *data, unsigned size)
 Send a packet over a UDP socket.
int recvfrom (SocketAddress *address, void *data, unsigned size)
 Receive a packet over a UDP socket.
int close ()
 Close the socket.
int bind (uint16_t port)
 Bind a specific address to a socket.
int bind (const char *address, uint16_t port)
 Bind a specific address to a socket.
int bind (const SocketAddress &address)
 Bind a specific address to a socket.
void set_blocking (bool blocking)
 Set blocking or non-blocking mode of the socket.
void set_timeout (int timeout)
 Set timeout on blocking socket operations.
void attach (FunctionPointer callback)
 Register a callback on state change of the socket.
template<typename T , typename M >
void attach (T *tptr, M mptr)
 Register a callback on state change of the socket.

Detailed Description

UDP socket.

Definition at line 25 of file UDPSocket.h.

Constructor & Destructor Documentation

UDPSocket (  )

Create an uninitialized socket.

Must call open to initialize the socket on a network stack.

Definition at line 20 of file UDPSocket.cpp.

UDPSocket ( NetworkStack *  iface )

Create a socket on a network stack.

Creates and opens a socket on the specified network stack.

Parameters:
ifaceNetwork stack as target for socket

Definition at line 24 of file UDPSocket.cpp.

Member Function Documentation

void attach ( FunctionPointer  callback ) [inherited]

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.

Parameters:
callbackFunction to call on state change

Definition at line 124 of file Socket.cpp.

void attach ( T *  tptr,
M  mptr 
) [inherited]

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.

Parameters:
tptrPointer to object to call method on
mptrMethod to call on state change

Definition at line 163 of file Socket.h.

int bind ( const char *  address,
uint16_t  port 
) [inherited]

Bind a specific address to a socket.

Binding a socket specifies the address and port on which to recieve 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.

Definition at line 68 of file Socket.cpp.

int bind ( const SocketAddress &  address ) [inherited]

Bind a specific address to a socket.

Binding a socket specifies the address and port on which to recieve 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.

Definition at line 74 of file Socket.cpp.

int bind ( uint16_t  port ) [inherited]

Bind a specific address to a socket.

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

Parameters:
portLocal port to bind
Returns:
0 on success, negative error code on failure.

Definition at line 62 of file Socket.cpp.

int close (  ) [inherited]

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

Definition at line 49 of file Socket.cpp.

int open ( NetworkStack *  iface ) [virtual]

Opens a socket.

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

Parameters:
ifaceNetwork stack as target for socket
Returns:
0 on success, negative error code on failure

Implements Socket.

Definition at line 29 of file UDPSocket.cpp.

int recvfrom ( SocketAddress *  address,
void *  data,
unsigned  size 
)

Receive a packet over a UDP socket.

Receives data and stores the source address in address if address is not NULL. Returns the number of bytes received into the buffer.

By default, recvfrom blocks until data is sent. If socket is set to non-blocking or times out, NSAPI_ERROR_WOULD_BLOCK is returned immediately.

Parameters:
addressDestination for the source address or NULL
dataDestination buffer for data received from the host
sizeSize of the buffer in bytes
Returns:
Number of received bytes on success, negative error code on failure

Definition at line 68 of file UDPSocket.cpp.

int sendto ( const char *  host,
uint16_t  port,
const void *  data,
unsigned  size 
)

Send a packet over a UDP socket.

Sends data to the specified address specified by either a domain name or an IP address and port. Returns the number of bytes sent from the buffer.

By default, sendto blocks until data is sent. If socket is set to non-blocking or times out, NSAPI_ERROR_WOULD_BLOCK is returned immediately.

Parameters:
hostHostname of the remote host
portPort of the remote host
dataBuffer of data to send to the host
sizeSize of the buffer in bytes
Returns:
Number of sent bytes on success, negative error code on failure

Definition at line 34 of file UDPSocket.cpp.

int sendto ( const SocketAddress &  address,
const void *  data,
unsigned  size 
)

Send a packet over a UDP socket.

Sends data to the specified address. Returns the number of bytes sent from the buffer.

By default, sendto blocks until data is sent. If socket is set to non-blocking or times out, NSAPI_ERROR_WOULD_BLOCK is returned immediately.

Parameters:
addressThe SocketAddress of the remote host
dataBuffer of data to send to the host
sizeSize of the buffer in bytes
Returns:
Number of sent bytes on success, negative error code on failure

Definition at line 44 of file UDPSocket.cpp.

void set_blocking ( bool  blocking ) [inherited]

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.

Definition at line 83 of file Socket.cpp.

void set_timeout ( int  timeout ) [inherited]

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 -1 removes the timeout from the socket.

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

Parameters:
timeoutTimeout in milliseconds

Definition at line 88 of file Socket.cpp.

Generated on Tue Jul 12 2022 14:52:52 by  doxygen 1.7.2