UCommon
ost::UDPSocket Class Reference

UDP sockets implement the TCP SOCK_DGRAM UDP protocol. More...

#include <udp.h>

Inheritance diagram for ost::UDPSocket:

Public Member Functions

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.
 

Protected Attributes

Family family
 
Socket::address peer
 

Detailed Description

UDP sockets implement the TCP SOCK_DGRAM UDP protocol.

They can be used to pass unverified messages between hosts, or to broadcast a specific message to an entire subnet. Please note that Streaming of realtime data commonly use UDPDuplex related classes rather than UDPSocket.

In addition to connected TCP sessions, Common C++ supports UDP sockets and these also cover a range of functionality. Like a TCPSocket, A UDPSocket can be created bound to a specific network interface and/or port address, though this is not required. UDP sockets also are usually either connected or otherwise "associated" with a specific "peer" UDP socket. Since UDP sockets operate through discreet packets, there are no streaming operators used with UDP sockets.

In addition to the UDP "socket" class, there is a "UDPBroadcast" class. The UDPBroadcast is a socket that is set to send messages to a subnet as a whole rather than to an individual peer socket that it may be associated with.

UDP sockets are often used for building "realtime" media streaming protocols and full duplex messaging services. When used in this manner, typically a pair of UDP sockets are used together; one socket is used to send and the other to receive data with an associated pair of UDP sockets on a "peer" host. This concept is represented through the Common C++ UDPDuplex object, which is a pair of sockets that communicate with another UDPDuplex pair.

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

Unreliable Datagram Protocol sockets.

Definition at line 99 of file udp.h.

Constructor & Destructor Documentation

◆ UDPSocket()

ost::UDPSocket::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.

On failure to bind, an exception is thrown.

Parameters
bindaddress to bind this socket to.
portnumber to bind this socket to.

Member Function Documentation

◆ disconnect()

Error ost::UDPSocket::disconnect ( void )

Disassociate this socket from any host connection.

No data should be read or written until a connection is established.

◆ getInterfaceIndex()

Socket::Error ost::UDPSocket::getInterfaceIndex ( const char * ethX,
int & InterfaceIndex )

get the interface index for a named network device

Parameters
ethXis device name, like "eth0" or "eth1"
InterfaceIndexis the index value returned by os
Todo
Win32 and ipv6 specific implementation.

◆ getPeer() [1/2]

ucommon::Socket::address ost::UDPSocket::getPeer ( )

Examine address of sender of next waiting packet.

This also sets "peer" address to the sender so that the next "send" message acts as a "reply". This additional behavior overides the standard socket getSender behavior.

Parameters
portpointer to hold port number.

◆ getPeer() [2/2]

IPV4Host ost::UDPSocket::getPeer ( tpport_t * port)
inline

Definition at line 228 of file udp.h.

◆ join()

Socket::Error ost::UDPSocket::join ( const ucommon::Socket::address & ia,
int InterfaceIndex = 0 )

join a multicast group on a particular interface

Parameters
iais the multicast address to use
InterfaceIndexis the index value returned by getInterfaceIndex
Todo
Win32 and ipv6 specific implementation.

◆ peek()

ssize_t ost::UDPSocket::peek ( void * buf,
size_t len )
inline

Examine contents of next waiting packet.

Parameters
bufpointer to packet buffer for contents.
lenof packet buffer.
Returns
number of bytes examined.

Definition at line 242 of file udp.h.

◆ receive()

ssize_t ost::UDPSocket::receive ( void * buf,
size_t len,
bool reply = false )

Receive a message from any host.

Parameters
bufpointer to packet buffer to receive.
lenof packet buffer to receive.
replysave sender address for reply if true.
Returns
number of bytes received.

◆ send()

ssize_t ost::UDPSocket::send ( const void * buf,
size_t len )

Send a message packet to a peer host.

Parameters
bufpointer to packet buffer to send.
lenof packet buffer to send.
Returns
number of bytes sent.

◆ setLoopback()

Error ost::UDPSocket::setLoopback ( bool enable)
inline

Set the loopback.

Definition at line 146 of file udp.h.

◆ setMulticast()

Error ost::UDPSocket::setMulticast ( bool enable)
inline

Set the multicast.

Definition at line 152 of file udp.h.

◆ setPeer()

void ost::UDPSocket::setPeer ( const ucommon::Socket::address & host)

set the peer address to send message packets to.

This can be set before every send() call if nessisary.

Parameters
hostaddress to send packets to.
portnumber to deliver packets to.

◆ setTimeToLive()

Error ost::UDPSocket::setTimeToLive ( char ttl)
inline

Set time to live.

Definition at line 158 of file udp.h.

Field Documentation

◆ family

Family ost::UDPSocket::family
protected

Definition at line 110 of file udp.h.

◆ peer

Socket::address ost::UDPSocket::peer
protected

Definition at line 108 of file udp.h.


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