Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Fork of
WIZnet_Library
by 
WIZnet
UDPSocket Class Reference
#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=-1) |
| Bind a UDP Server Socket to a specific port. | |
| 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 | close () |
| Close the socket file descriptor. | |
Detailed Description
UDP Socket.
Definition at line 28 of file UDPSocket.h.
Constructor & Destructor Documentation
| UDPSocket | ( | ) |
Instantiate an UDP Socket.
Definition at line 23 of file UDPSocket.cpp.
Member Function Documentation
| int bind | ( | int | port = -1 ) |
Bind a UDP Server Socket to a specific port.
- Parameters:
-
port The port to listen for incoming connections on
- Returns:
- 0 on success, -1 on failure.
Definition at line 38 of file UDPSocket.cpp.
| int close | ( | ) | [inherited] |
Close the socket file descriptor.
Definition at line 33 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 28 of file UDPSocket.cpp.
| int receiveFrom | ( | Endpoint & | remote, |
| char * | buffer, | ||
| int | length | ||
| ) |
Receive a packet from a remote endpoint.
- Parameters:
-
remote The remote endpoint buffer The buffer for storing the incoming packet data. If a packet is too long to fit in the supplied buffer, excess bytes are discarded length The length of the buffer
- Returns:
- the number of received bytes on success (>=0) or -1 on failure
Definition at line 72 of file UDPSocket.cpp.
| int sendTo | ( | Endpoint & | remote, |
| char * | packet, | ||
| int | length | ||
| ) |
Send a packet to a remote endpoint.
- Parameters:
-
remote The remote endpoint packet The packet to be sent length The length of the packet to be sent
- Returns:
- the number of written bytes on success (>=0) or -1 on failure
Definition at line 60 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:
-
blocking true for blocking mode, false for non-blocking mode. timeout timeout in ms [Default: (1500)ms].
Definition at line 28 of file Socket.cpp.
Generated on Thu Jul 14 2022 08:03:44 by
1.7.2