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.
UDPSocket Class Reference
Interface class for UDP socket of using SNIC UART. 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 (short port) |
| 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 | 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 (bool shutdown=true) |
| Close the socket. | |
Detailed Description
Interface class for UDP socket of using SNIC UART.
Definition at line 30 of file UDPSocket.h.
Constructor & Destructor Documentation
| UDPSocket | ( | ) |
Instantiate an UDP Socket.
Definition at line 24 of file UDPSocket.cpp.
Member Function Documentation
| int bind | ( | short | port ) |
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 37 of file UDPSocket.cpp.
| int close | ( | bool | shutdown = true ) |
[inherited] |
Close the socket.
- Parameters:
-
shutdown free the left-over data in message queues
Definition at line 48 of file Socket.cpp.
| int get_option | ( | int | level, |
| int | optname, | ||
| void * | optval, | ||
| socklen_t * | optlen | ||
| ) | [inherited] |
Get socket options.
- Parameters:
-
level stack level (see: lwip/sockets.h) optname option ID optval buffer pointer where to write the option value socklen_t length of the option value
- Returns:
- 0 on success, -1 on failure
Definition at line 44 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 31 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 275 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 176 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 31 of file Socket.cpp.
| int set_option | ( | int | level, |
| int | optname, | ||
| const void * | optval, | ||
| socklen_t | optlen | ||
| ) | [inherited] |
Set socket options.
- Parameters:
-
level stack level (see: lwip/sockets.h) optname option ID optval option value socklen_t length of the option value
- Returns:
- 0 on success, -1 on failure
Definition at line 40 of file Socket.cpp.
Generated on Thu Jul 14 2022 20:28:29 by
1.7.2