ucommon
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 <udp.h>

Inheritance diagram for ost::UDPTransmit:
Inheritance graph
[legend]
Collaboration diagram for ost::UDPTransmit:
Collaboration graph
[legend]

Public Member Functions

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

Protected Member Functions

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

Additional Inherited Members

- Protected Types inherited from ost::Socket
enum  Error {
  errSuccess = 0, errCreateFailed, errCopyFailed, errInput,
  errInputInterrupt, errResourceFailure, errOutput, errOutputInterrupt,
  errNotConnected, errConnectRefused, errConnectRejected, errConnectTimeout,
  errConnectFailed, errConnectInvalid, errConnectBusy, errConnectNoRoute,
  errBindingFailed, errBroadcastDenied, errRoutingDenied, errKeepaliveDenied,
  errServiceDenied, errServiceUnavailable, errMulticastDisabled, errTimeout,
  errNoDelay, errExtended, errLookupFail, errSearchErr,
  errInvalidValue
}
typedef enum Error Error
enum  Family { IPV6 = 1, IPV4 = 2 }
typedef enum Family Family
enum  Pending { pendingInput, pendingOutput, pendingError }
typedef enum Pending Pending
enum  State {
  INITIAL, AVAILABLE, BOUND, CONNECTED,
  CONNECTING, STREAM
}
typedef enum State State
enum  Tos {
  tosLowDelay = 0, tosThroughput, tosReliability, tosMinCost,
  tosInvalid
}
typedef enum Tos Tos
- Static Protected Member Functions inherited from ost::Socket
static bool check (Family fam)
 See if a specific protocol family is available in the current runtime environment.
Family family
union {
   struct sockaddr_in   ipv4
   struct sockaddr_in6   ipv6
peer

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.

Definition at line 300 of file udp.h.

Constructor & Destructor Documentation

ost::UDPTransmit::UDPTransmit ( 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.

Member Function Documentation

Error ost::UDPTransmit::connect ( 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 ( 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 ( 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
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.

Definition at line 420 of file udp.h.

ssize_t ost::UDPTransmit::send ( 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.

Definition at line 378 of file udp.h.

ssize_t ost::UDPTransmit::transmit ( 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.

Definition at line 411 of file udp.h.


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