|
Async
1.5.0
|
A class for working with UDP sockets. More...
#include <AsyncUdpSocket.h>
Public Member Functions | |
| UdpSocket (uint16_t local_port=0, const IpAddress &bind_ip=IpAddress()) | |
| Constructor. More... | |
| ~UdpSocket (void) | |
| Destructor. More... | |
| bool | initOk (void) const |
| Check if the initialization was ok. More... | |
| bool | write (const IpAddress &remote_ip, int remote_port, const void *buf, int count) |
| Write data to the remote host. More... | |
| int | fd (void) const |
| Get the file descriptor for the UDP socket. More... | |
Public Attributes | |
| sigc::signal< void, const IpAddress &, uint16_t, void *, int > | dataReceived |
| A signal that is emitted when data has been received. More... | |
| sigc::signal< void, bool > | sendBufferFull |
| A signal that is emitted when the send buffer is full. More... | |
A class for working with UDP sockets.
This class is used to work with UDP sockets. An example usage is shown below.
Definition at line 124 of file AsyncUdpSocket.h.
Constructor.
| local_port | The local port to use. If not specified, a random local port will be used. |
| bind_ip | Bind to the interface with the given IP address. If left empty, bind to all interfaces. |
| Async::UdpSocket::~UdpSocket | ( | void | ) |
Destructor.
|
inline |
Get the file descriptor for the UDP socket.
Definition at line 167 of file AsyncUdpSocket.h.
|
inline |
Check if the initialization was ok.
This function should always be called after constructing the object to see if everything went fine.
Definition at line 149 of file AsyncUdpSocket.h.
| bool Async::UdpSocket::write | ( | const IpAddress & | remote_ip, |
| int | remote_port, | ||
| const void * | buf, | ||
| int | count | ||
| ) |
Write data to the remote host.
| remote_ip | The IP-address of the remote host |
| remote_port | The remote port to use |
| buf | A buffer containing the data to send |
| count | The number of bytes to write |
| sigc::signal<void, const IpAddress&, uint16_t, void*, int> Async::UdpSocket::dataReceived |
A signal that is emitted when data has been received.
| ip | The IP-address the data was received from |
| port | The remote port number |
| buf | The buffer containing the read data |
| count | The number of bytes read |
Definition at line 176 of file AsyncUdpSocket.h.
| sigc::signal<void, bool> Async::UdpSocket::sendBufferFull |
A signal that is emitted when the send buffer is full.
| is_full | Set to true if the buffer is full or false if the buffer full condition has been cleared |
Definition at line 183 of file AsyncUdpSocket.h.