Daniele Lacamera / PicoTCP Featured

Free (GPLv2) TCP/IP stack developed by TASS Belgium

Dependents:   lpc1768-picotcp-demo ZeroMQ_PicoTCP_Publisher_demo TCPSocket_HelloWorld_PicoTCP Pico_TCP_UDP_Test ... 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 ()
 Instantiate an UDP Socket.
int init (void)
 Init the UDP Client Socket without binding it to any specific port.
int bind (int port)
 Bind a UDP Server Socket to a specific port.
int join_multicast_group (EthernetInterface &eth, const char *address)
 Join the multicast group at the given address.
int set_broadcasting (void)
 Set the socket in broadcasting mode.
int sendTo (Endpoint &remote, char *packet, int length)
 Send a packet to a remote endpoint.
int receiveFrom (Endpoint &remote, char *buffer, int length)
 Receive a packet from a remote endpoint.
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 ()
 Close the socket file descriptor.

Detailed Description

UDP Socket.

Definition at line 41 of file UDPSocket.h.

Constructor & Destructor Documentation

UDPSocket (  )

Instantiate an UDP Socket.

Definition at line 38 of file UDPSocket.cpp.

Member Function Documentation

int bind ( int  port )

Bind a UDP Server Socket to a specific port.

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

Definition at line 46 of file UDPSocket.cpp.

int close (  ) [inherited]

Close the socket file descriptor.

Definition at line 92 of file Socket.cpp.

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

Get socket options.

Parameters:
levelstack level - parameter is ignored (kept for compatibility)
optnameoption ID - please check pico_socket.h or lower in the page
optvalbuffer pointer where to write the option value
socklen_tlength of the option value
Returns:
0 on success, -1 on failure

Definition at line 67 of file Socket.cpp.

int init ( void   )

Init the UDP Client Socket without binding it to any specific port.

Returns:
0 on success, -1 on failure.

Definition at line 41 of file UDPSocket.cpp.

int join_multicast_group ( EthernetInterface &  eth,
const char *  address 
)

Join the multicast group at the given address.

Parameters:
addressThe address of the multicast group
Returns:
0 on success, -1 on failure.

Definition at line 66 of file UDPSocket.cpp.

int receiveFrom ( Endpoint &  remote,
char *  buffer,
int  length 
)

Receive a packet from a remote endpoint.

Parameters:
remoteThe remote endpoint
bufferThe buffer for storing the incoming packet data. If a packet is too long to fit in the supplied buffer, excess bytes are discarded
lengthThe length of the buffer
Returns:
the number of received bytes on success (>=0) or -1 on failure

Definition at line 88 of file UDPSocket.cpp.

int sendTo ( Endpoint &  remote,
char *  packet,
int  length 
)

Send a packet to a remote endpoint.

Parameters:
remoteThe remote endpoint
packetThe packet to be sent
lengthThe length of the packet to be sent
Returns:
the number of written bytes on success (>=0) or -1 on failure

Definition at line 77 of file UDPSocket.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 41 of file Socket.cpp.

int set_broadcasting ( void   )

Set the socket in broadcasting mode.

Returns:
0 on success, -1 on failure.

Definition at line 71 of file UDPSocket.cpp.

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

Set socket options.

Parameters:
levelstack level - parameter is ignored (kept for compatibility)
optnameoption ID - please check pico_socket.h
optvaloption value
socklen_tlength of the option value
Returns:
0 on success, -1 on failure

Definition at line 62 of file Socket.cpp.

Generated on Tue Jul 12 2022 15:59:23 by  doxygen 1.7.2