UCommon
ost::UDPBroadcast Class Reference

Representing a UDP socket used for subnet broadcasts, this class provides an alternate binding and setPeer() capability for UDP sockets. More...

#include <udp.h>

Inheritance diagram for ost::UDPBroadcast:
Collaboration diagram for ost::UDPBroadcast:

Public Member Functions

void setPeer (const IPV4Broadcast &subnet, tpport_t port)
 Set peer by subnet rather than specific host.
 
 UDPBroadcast (const IPV4Address &ia, tpport_t port)
 Create and bind a subnet broadcast socket.
 
- Public Member Functions inherited from ost::UDPSocket
void connect (const char *service)
 
void connect (const IPV4Host &host, tpport_t port)
 
void connect (const IPV6Host &host, tpport_t port)
 
void connect (const ucommon::Socket::address &host)
 
Error disconnect (void)
 Disassociate this socket from any host connection.
 
Socket::Error getInterfaceIndex (const char *ethX, int &InterfaceIndex)
 get the interface index for a named network device
 
IPV4Host getIPV4Peer (tpport_t *port=NULL)
 
IPV6Host getIPV6Peer (tpport_t *port=NULL)
 
ucommon::Socket::address getPeer ()
 Examine address of sender of next waiting packet.
 
IPV4Host getPeer (tpport_t *port)
 
Socket::Error join (const IPV4Multicast &ia, int InterfaceIndex)
 
Socket::Error join (const ucommon::Socket::address &ia, int InterfaceIndex=0)
 join a multicast group on a particular interface
 
ssize_t peek (void *buf, size_t len)
 Examine contents of next waiting packet.
 
ssize_t receive (void *buf, size_t len, bool reply=false)
 Receive a message from any host.
 
ssize_t send (const void *buf, size_t len)
 Send a message packet to a peer host.
 
Error setLoopback (bool enable)
 Set the loopback.
 
Error setMulticast (bool enable)
 Set the multicast.
 
void setPeer (const char *service)
 Associate socket with a named connection.
 
void setPeer (const IPV4Host &host, tpport_t port)
 
void setPeer (const IPV6Host &host, tpport_t port)
 
void setPeer (const ucommon::Socket::address &host)
 set the peer address to send message packets to.
 
Error setTimeToLive (char ttl)
 Set time to live.
 
 UDPSocket (const char *name, Family family=IPV4)
 Create a UDP socket bound by a service name.
 
 UDPSocket (const IPV4Address &bind, tpport_t port)
 
 UDPSocket (const IPV6Address &bind, tpport_t port)
 
 UDPSocket (const ucommon::Socket::address &bind)
 Create a UDP socket and 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.
 
 UDPSocket (Family family=IPV4)
 Create an unbound UDP socket, mostly for internal use.
 
virtual ~UDPSocket ()
 Destroy a UDP socket as a socket.
 

Additional Inherited Members

- Protected Attributes inherited from ost::UDPSocket
Family family
 
Socket::address peer
 

Detailed Description

Representing a UDP socket used for subnet broadcasts, this class provides an alternate binding and setPeer() capability for UDP sockets.

Author
David Sugar dyfet.nosp@m.@ost.nosp@m.el.co.nosp@m.m

Unreliable Datagram for subnet broadcasts.

Definition at line 266 of file udp.h.

Constructor & Destructor Documentation

◆ UDPBroadcast()

ost::UDPBroadcast::UDPBroadcast ( const IPV4Address & ia,
tpport_t port )

Create and bind a subnet broadcast socket.

Parameters
iaaddress to bind socket under locally.
portto bind socket under locally.

Member Function Documentation

◆ setPeer()

void ost::UDPBroadcast::setPeer ( const IPV4Broadcast & subnet,
tpport_t port )

Set peer by subnet rather than specific host.

Parameters
subnetof peer hosts to send to.
portnumber to use.

The documentation for this class was generated from the following file: