GNU CommonC++
Public Member Functions | Protected Member Functions
ost::UDPTransmit Class Reference

Representing half of a two-way UDP connection, the UDP transmitter can broadcast data to another selected peer host or to an entire subnet. More...

#include <socket.h>

Inheritance diagram for ost::UDPTransmit:
ost::UDPSocket ost::Socket ost::UDPDuplex

List of all members.

Public Member Functions

ssize_t transmit (const char *buffer, size_t len)
 Transmit "send" to use "connected" send rather than sendto.
bool isOutputReady (unsigned long timeout=0l)
 See if output queue is empty for sending more packets.
Error setRouting (bool enable)
Error setTypeOfService (Tos tos)
Error setBroadcast (bool enable)

Protected Member Functions

 UDPTransmit (Family family=IPV4)
 Create a UDP transmitter.
 UDPTransmit (const IPV4Address &bind, tpport_t port=5005)
 Create a UDP transmitter, 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.
 UDPTransmit (const IPV6Address &bind, tpport_t port=5005)
Error connect (const IPV4Host &host, tpport_t port)
 Associate this socket with a specified peer host.
Error connect (const IPV6Address &host, tpport_t port)
Error connect (const IPV4Broadcast &subnet, tpport_t port)
 Associate this socket with a subnet of peer hosts for subnet broadcasting.
Error connect (const IPV4Multicast &mgroup, tpport_t port)
 Associate this socket with a multicast group.
Error connect (const IPV6Multicast &mgroup, tpport_t port)
ssize_t send (const void *buf, size_t len)
 Transmit "send" to use "connected" send rather than sendto.
void endTransmitter (void)
 Stop transmitter.
SOCKET getTransmitter (void)
Error setMulticast (bool enable)
Error setTimeToLive (unsigned char ttl)
- Protected Member Functions inherited from ost::UDPSocket
 UDPSocket (Family family=IPV4)
 Create an unbound UDP socket, mostly for internal use.
 UDPSocket (const char *name, Family family=IPV4)
 Create a UDP socket bound by a service name.
 UDPSocket (const IPV4Address &bind, tpport_t port)
 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 (const IPV6Address &bind, tpport_t port)
virtual ~UDPSocket ()
 Destroy a UDP socket as a socket.
Error setLoopback (bool enable)
 Set the loopback.
Error setTimeToLive (char ttl)
 Set time to live.
void setPeer (const IPV4Host &host, tpport_t port)
 set the peer address to send message packets to.
void setPeer (const IPV6Host &host, tpport_t port)
void connect (const IPV6Host &host, tpport_t port)
Socket::Error getInterfaceIndex (const char *ethX, int &InterfaceIndex)
 get the interface index for a named network device
Socket::Error join (const IPV4Multicast &ia, int InterfaceIndex)
 join a multicast group on a particular interface
ssize_t receive (void *buf, size_t len, bool reply=false)
 Receive a message from any host.
IPV4Host getIPV4Peer (tpport_t *port=NULL) const
 Examine address of sender of next waiting packet.
IPV4Host getPeer (tpport_t *port=NULL) const
IPV6Host getIPV6Peer (tpport_t *port=NULL) const
ssize_t peek (void *buf, size_t len)
 Examine contents of next waiting packet.
void setPeer (const char *service)
 Associate socket with a named connection.
void connect (const char *service)
Error disconnect (void)
 Disassociate this socket from any host connection.
- Protected Member Functions inherited from ost::Socket
virtual ~Socket ()
 The socket base class may be "thrown" as a result of an error, and the "catcher" may then choose to destroy the object.
Socketoperator= (const Socket &from)
 Sockets may also be duplicated by the assignment operator.
virtual IPV4Host getIPV4Sender (tpport_t *port=NULL) const
 May be used to examine the origin of data waiting in the socket receive queue.
IPV4Host getSender (tpport_t *port=NULL) const
virtual IPV6Host getIPV6Sender (tpport_t *port=NULL) const
IPV4Host getIPV4Local (tpport_t *port=NULL) const
 Get the local address and port number this socket is currently bound to.
IPV4Host getLocal (tpport_t *port=NULL) const
IPV6Host getIPV6Local (tpport_t *port=NULL) const
IPV4Host getIPV4NAT (tpport_t *port=NULL) const
 Perform NAT table lookup for this socket.
IPV4Host getNAT (tpport_t *port) const
IPV6Host getIPV6NAT (tpport_t *port=NULL) const
void setCompletion (bool immediate)
 Used to specify blocking mode for the socket.
Error setLinger (bool linger)
 Enable lingering sockets on close.
bool isConnected (void) const
 Can test to see if this socket is "connected", and hence whether a "catch" can safely call getPeer().
bool isActive (void) const
 Test to see if the socket is at least operating or if it is mearly initialized.
bool operator! () const
 Operator based testing to see if a socket is currently active.
bool isBroadcast (void) const
 Return if broadcast has been enabled for the specified socket.
bool isRouted (void) const
 Return if socket routing is enabled.
Error getErrorNumber (void) const
 Often used by a "catch" to fetch the last error of a thrown socket.
const char * getErrorString (void) const
 Often used by a "catch" to fetch the user set error string of a thrown socket, but only if EXTENDED error codes are used.
long getSystemError (void) const
const char * getSystemErrorString (void) const
virtual bool isPending (Pending pend, timeout_t timeout=TIMEOUT_INF)
 Get the status of pending operations.

Additional Inherited Members

union {
   struct sockaddr_in6   ipv6
   struct sockaddr_in   ipv4
peer
Family family

Detailed Description

Representing half of a two-way UDP connection, the UDP transmitter can broadcast data to another selected peer host or to an entire subnet.

Author:
David Sugar dyfet.nosp@m.@ost.nosp@m.el.co.nosp@m.m Unreliable Datagram Peer Associations.

Constructor & Destructor Documentation

ost::UDPTransmit::UDPTransmit ( Family  family = IPV4)
protected

Create a UDP transmitter.

ost::UDPTransmit::UDPTransmit ( const IPV4Address bind,
tpport_t  port = 5005 
)
protected

Create a UDP transmitter, 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. This class is only used to build the UDP Duplex.

Parameters:
bindaddress to bind this socket to.
portnumber to bind this socket to.
ost::UDPTransmit::UDPTransmit ( const IPV6Address bind,
tpport_t  port = 5005 
)
protected

Member Function Documentation

Error ost::UDPTransmit::connect ( const 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 to and received from the specified host.

Returns:
0 on success, -1 on error.
Parameters:
hostaddress to connect socket to.
portto connect socket to.

Reimplemented from ost::UDPSocket.

Reimplemented in ost::UDPDuplex.

Error ost::UDPTransmit::connect ( const IPV6Address host,
tpport_t  port 
)
protected
Error ost::UDPTransmit::connect ( const IPV4Broadcast subnet,
tpport_t  port 
)
protected

Associate this socket with a subnet of peer hosts for subnet broadcasting.

The server must be able to assert broadcast permission for the socket.

Returns:
0 on success, -1 on error.
Parameters:
subnetsubnet address to broadcast into.
porttransport port to broadcast into.
Error ost::UDPTransmit::connect ( const IPV4Multicast mgroup,
tpport_t  port 
)
protected

Associate this socket with a multicast group.

Returns:
0 on success, -1 on error.
Parameters:
mgroupaddress of the multicast group to send to.
portport number
Error ost::UDPTransmit::connect ( const IPV6Multicast mgroup,
tpport_t  port 
)
protected
void ost::UDPTransmit::endTransmitter ( void  )
inlineprotected

Stop transmitter.

References ost::Socket::endSocket().

SOCKET ost::UDPTransmit::getTransmitter ( void  )
inlineprotected
bool ost::UDPTransmit::isOutputReady ( unsigned long  timeout = 0l)
inline

See if output queue is empty for sending more packets.

Returns:
true if output available.
Parameters:
timeoutin milliseconds to wait.

References ost::Socket::isPending(), and ost::Socket::pendingOutput.

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

Transmit "send" to use "connected" send rather than sendto.

Returns:
number of bytes sent.
Parameters:
bufaddress of buffer to send.
lenof bytes to send.

Reimplemented from ost::UDPSocket.

References _IOLEN64, and MSG_NOSIGNAL.

Error ost::UDPTransmit::setBroadcast ( bool  enable)
inline

Reimplemented from ost::Socket.

References ost::Socket::setBroadcast().

Error ost::UDPTransmit::setMulticast ( bool  enable)
inlineprotected

Reimplemented from ost::UDPSocket.

References ost::Socket::setMulticastByFamily().

Error ost::UDPTransmit::setRouting ( bool  enable)
inline

Reimplemented from ost::Socket.

References ost::Socket::setRouting().

Error ost::UDPTransmit::setTimeToLive ( unsigned char  ttl)
inlineprotected
Error ost::UDPTransmit::setTypeOfService ( Tos  tos)
inline

Reimplemented from ost::Socket.

References ost::Socket::setTypeOfService().

ssize_t ost::UDPTransmit::transmit ( const char *  buffer,
size_t  len 
)
inline

Transmit "send" to use "connected" send rather than sendto.

Note:
Windows does not support MSG_DONTWAIT, so it is defined as 0 on that platform.
Returns:
number of bytes sent.
Parameters:
bufferaddress of buffer to send.
lenof bytes to send.

References _IOLEN64, MSG_DONTWAIT, and MSG_NOSIGNAL.


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