ost::UDPDuplex Class Reference

UDP duplex connections impliment a bi-directional point-to-point UDP session between two peer hosts. More...

#include <socket.h>

Inheritance diagram for ost::UDPDuplex:

List of all members.

Public Member Functions
	UDPDuplex (const IPV4Address &bind, tpport_t port)
	Create a UDP duplex as a pair of UDP simplex objects bound to alternating and interconnected port addresses.
	UDPDuplex (const IPV6Address &bind, tpport_t port)
Error	connect (const IPV4Host &host, tpport_t port)
	Associate the duplex with a specified peer host.
Error	connect (const IPV6Host &host, tpport_t port)
Error	disconnect (void)
	Disassociate this duplex from any host connection.
Public Member Functions inherited from ost::UDPTransmit
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)
Public Member Functions inherited from ost::UDPReceive
ssize_t	receive (void *buf, size_t len)
	Receive a data packet from the connected peer host.
bool	isInputReady (timeout_t timeout=TIMEOUT_INF)
	See if input queue has data packets available.

Additional Inherited Members
Protected Member Functions inherited from ost::UDPTransmit
	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 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)
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)
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.
Socket &	operator= (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.
Protected Member Functions inherited from ost::UDPReceive
	UDPReceive (const 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 (const IPV6Address &bind, tpport_t port)
bool	isPendingReceive (timeout_t timeout)
	Check for pending data.
void	endReceiver (void)
	End receiver.
SOCKET	getReceiver (void) const
Error	setRouting (bool enable)
Error	setMulticast (bool enable)
Error	join (const IPV4Multicast &ia)
Error	join (const IPV6Multicast &ia)
Error	drop (const IPV4Multicast &ia)
Error	drop (const IPV6Multicast &ia)

---

Detailed Description

UDP duplex connections impliment a bi-directional point-to-point UDP session between two peer hosts.

Two UDP sockets are typically used on alternating port addresses to assure that sender and receiver data does not collide or echo back. A UDP Duplex is commonly used for full duplex real-time streaming of UDP data between hosts.

Author:

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

---

Constructor & Destructor Documentation

ost::UDPDuplex::UDPDuplex	(	const IPV4Address &	bind,
		tpport_t	port
	)

Create a UDP duplex as a pair of UDP simplex objects bound to alternating and interconnected port addresses.

Parameters:

bind	address to bind this socket to.
port	number to bind sender.

ost::UDPDuplex::UDPDuplex	(	const IPV6Address &	bind,
		tpport_t	port
	)

---

Member Function Documentation

Error ost::UDPDuplex::connect	(	const IPV4Host &	host,
		tpport_t	port
	)

Associate the duplex with a specified peer host.

Both the sender and receiver will be interconnected with the remote host.

Returns:

0 on success, error code on error.

Parameters:

host	address to connect socket to.
port	number to connect socket to.

Reimplemented from ost::UDPTransmit.

Error ost::UDPDuplex::connect	(	const IPV6Host &	host,
		tpport_t	port
	)

Reimplemented from ost::UDPReceive.

Error ost::UDPDuplex::disconnect

(

void

)

Disassociate this duplex from any host connection.

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

Returns:

0 on success, error code on error.

Reimplemented from ost::UDPSocket.

---

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

• socket.h