Representing half of a two-way UDP connection, the UDP receiver can receive data from another peer host or subnet. More...
#include <udp.h>
Public Member Functions | |
| bool | isInputReady (timeout_t timeout=ucommon::Timer::inf) |
| See if input queue has data packets available. | |
| ssize_t | receive (void *buf, size_t len) |
| Receive a data packet from the connected peer host. | |
Protected Member Functions | |
| Error | connect (IPV4Host &host, tpport_t port) |
| Associate this socket with a specified peer host. | |
| Error | connect (IPV6Host &host, tpport_t port) |
| Error | drop (IPV4Multicast &ia) |
| Error | drop (IPV6Multicast &ia) |
| void | endReceiver (void) |
| End receiver. | |
| SOCKET | getReceiver (void) |
| bool | isPendingReceive (timeout_t timeout) |
| Check for pending data. | |
| Error | join (IPV4Multicast &ia) |
| Error | join (IPV6Multicast &ia) |
| Error | setMulticast (bool enable) |
| Set the multicast. | |
| Error | setRouting (bool enable) |
| UDPReceive (IPV4Address &bind, tpport_t port) | |
| Create a UDP receiver, bind it to a specific interface and port address so that other UDP sockets on remote machines (or the same host) may find and send UDP messages to it, and associate it with a given port on a peer host. | |
| UDPReceive (IPV6Address &bind, tpport_t port) | |
Detailed Description
Representing half of a two-way UDP connection, the UDP receiver can receive data from another peer host or subnet.
This class is used exclusivily to derive the UDPDuplex.
Constructor & Destructor Documentation
| ost::UDPReceive::UDPReceive | ( | IPV4Address & | bind, |
| tpport_t | port | ||
| ) | [protected] |
Create a UDP receiver, bind it to a specific interface and port address so that other UDP sockets on remote machines (or the same host) may find and send UDP messages to it, and associate it with a given port on a peer host.
On failure to bind, an exception is thrown.
- Parameters:
-
bind address to bind this socket to. port number to bind this socket to.
Member Function Documentation
| Error ost::UDPReceive::connect | ( | IPV4Host & | host, |
| tpport_t | port | ||
| ) | [protected] |
Associate this socket with a specified peer host.
The port number from the constructor will be used. All UDP packets will be sent received from the specified host.
- Returns:
- 0 on success, -1 on error.
- Parameters:
-
host host network address to connect socket to. port host transport port to connect socket to.
Reimplemented from ost::UDPSocket.
Reimplemented in ost::UDPDuplex.
| bool ost::UDPReceive::isInputReady | ( | timeout_t | timeout = ucommon::Timer::inf | ) | [inline] |
| bool ost::UDPReceive::isPendingReceive | ( | timeout_t | timeout | ) | [inline, protected] |
| ssize_t ost::UDPReceive::receive | ( | void * | buf, |
| size_t | len | ||
| ) | [inline] |
The documentation for this class was generated from the following file:
- commoncpp/udp.h
