---

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. Unreliable Datagram Peer Associations. More...

#include <socket.h>

Inheritance diagram for ost::UDPTransmit:

List of all members.

Public Methods
int	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 Methods
	UDPTransmit ()
	Create a UDP transmitter.
	UDPTransmit (const InetAddress &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.
Error	connect (const InetHostAddress &host, tpport_t port)
	Associate this socket with a specified peer host.
Error	connect (const BroadcastAddress &subnet, tpport_t port)
	Associate this socket with a subnet of peer hosts for subnet broadcasting.
Error	connect (const InetMcastAddress &mgroup, tpport_t port)
	Associate this socket with a multicast group.
Error	disconnect (void)
	Disassociate this socket from any host connection.
int	send (const void *buf, int 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)

---

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. Unreliable Datagram Peer Associations.

Author:

David Sugar <dyfet@ostel.com>

---

Constructor & Destructor Documentation

ost::UDPTransmit::UDPTransmit (    )  [protected]

Create a UDP transmitter.

ost::UDPTransmit::UDPTransmit (  const InetAddress &    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: bind  address to bind this socket to. port  number to bind this socket to.

---

Member Function Documentation

Error ost::UDPTransmit::connect (  const InetMcastAddress &    mgroup, tpport_t    port )  [protected]

Associate this socket with a multicast group. Returns: 0 on success, -1 on error. Parameters: mgroup  address of the multicast group to send to. port  port number

Error ost::UDPTransmit::connect (  const BroadcastAddress &    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: subnet  subnet address to broadcast into. port  transport port to broadcast into.

Error ost::UDPTransmit::connect (  const InetHostAddress &    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: host  address to connect socket to. port  to connect socket to. Reimplemented in ost::UDPDuplex.

Error ost::UDPTransmit::disconnect (  void    )  [protected]

Disassociate this socket from any host connection. No data should be read or written until a connection is established. Reimplemented in ost::UDPDuplex.

void ost::UDPTransmit::endTransmitter (  void    )  [inline, protected]

Stop transmitter.

SOCKET ost::UDPTransmit::getTransmitter (  void    )  [inline, protected]

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: timeout  in milliseconds to wait.

int ost::UDPTransmit::send (  const void *    buf, int    len )  [inline, protected]

Transmit "send" to use "connected" send rather than sendto. Returns: number of bytes sent. Parameters: buf  address of buffer to send. len  of bytes to send.

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

Reimplemented from ost::Socket.

Error ost::UDPTransmit::setMulticast (  bool    enable )  [inline, protected]

Reimplemented from ost::Socket.

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

Reimplemented from ost::Socket.

Error ost::UDPTransmit::setTimeToLive (  unsigned char    ttl )  [inline, protected]

Reimplemented from ost::Socket.

Error ost::UDPTransmit::setTypeOfService (  Tos    tos )  [inline]

Reimplemented from ost::Socket.

int 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: buffer  address of buffer to send. len  of bytes to send.

---

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

• socket.h

---