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.
Dependents: Smart-WiFly-WebServer PUB_WiflyInterface_Demo
Fork of
WiflyInterface
by 
mbed official
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 | join_multicast_group (const char *address) |
| Join the multicast group at the given address param address The address of the multicast group return 0 on success, -1 on failure. | |
| int | set_broadcasting (bool broadcast=true) |
| 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 | close () |
| Close the socket file descriptor. | |
Detailed Description
UDP Socket.
Definition at line 37 of file UDPSocket.h.
Constructor & Destructor Documentation
| UDPSocket | ( | ) |
Instantiate an UDP Socket.
Definition at line 42 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 56 of file UDPSocket.cpp.
| int close | ( | ) | [inherited] |
Close the socket file descriptor.
Definition at line 36 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 48 of file UDPSocket.cpp.
| int join_multicast_group | ( | const char * | address ) |
Join the multicast group at the given address param address The address of the multicast group return 0 on success, -1 on failure.
Definition at line 90 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 121 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 99 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] when non-blocking.
- Note:
- if timeout is < 1 msec, it is set to 1 to avoid problems in other parts of the socket interface.
Definition at line 28 of file Socket.cpp.
| int set_broadcasting | ( | bool | broadcast = true ) |
Set the socket in broadcasting mode.
- Returns:
- 0 on success, -1 on failure.
Definition at line 94 of file UDPSocket.cpp.
Generated on Tue Jul 12 2022 16:14:59 by
1.7.2