ucommon
Public Member Functions | Protected Member Functions
ost::UDPReceive Class Reference

Representing half of a two-way UDP connection, the UDP receiver can receive data from another peer host or subnet. More...

#include <udp.h>

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

Public Member Functions

bool isInputReady (timeout_t timeout=ucommon::Timer::inf)
 See if input queue has data packets available.
 
ssize_t receive (void *buf, size_t len)
 Receive a data packet from the connected peer host.
 

Protected Member Functions

Error connect (const IPV4Host &host, tpport_t port)
 Associate this socket with a specified peer host.
 
Error connect (const IPV6Host &host, tpport_t port)
 
Error drop (const IPV4Multicast &ia)
 
Error drop (const IPV6Multicast &ia)
 
void endReceiver (void)
 End receiver.
 
SOCKET getReceiver (void) const
 
bool isPendingReceive (timeout_t timeout)
 Check for pending data.
 
Error join (const IPV4Multicast &ia)
 
Error join (const IPV6Multicast &ia)
 
Error setMulticast (bool enable)
 
Error setRouting (bool enable)
 
 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)
 
- Protected Member Functions inherited from ost::UDPSocket
void connect (const IPV4Host &host, tpport_t port)
 
void connect (const IPV6Host &host, tpport_t port)
 
void connect (const char *service)
 
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=((void *) 0)) const
 Examine address of sender of next waiting packet.
 
IPV6Host getIPV6Peer (tpport_t *port=((void *) 0)) const
 
IPV4Host getPeer (tpport_t *port=((void *) 0)) const
 
Socket::Error join (const 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.
 
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 IPV4Host &host, tpport_t port)
 set the peer address to send message packets to.
 
void setPeer (const IPV6Host &host, tpport_t port)
 
void setPeer (const 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 (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.
 
- Protected Member Functions inherited from ost::Socket
struct in_addr getaddress (const IPV4Address &ia)
 
struct in6_addr getaddress (const IPV6Address &ia)
 
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.
 
IPV4Host getIPV4Local (tpport_t *port=((void *) 0)) const
 Get the local address and port number this socket is currently bound to.
 
IPV4Host getIPV4Peer (tpport_t *port=((void *) 0)) const
 Get the host address and port of the socket this socket is connected to.
 
virtual IPV4Host getIPV4Sender (tpport_t *port=((void *) 0)) const
 May be used to examine the origin of data waiting in the socket receive queue.
 
IPV6Host getIPV6Local (tpport_t *port=((void *) 0)) const
 
IPV6Host getIPV6Peer (tpport_t *port=((void *) 0)) const
 
virtual IPV6Host getIPV6Sender (tpport_t *port=((void *) 0)) const
 
IPV4Host getLocal (tpport_t *port=((void *) 0)) const
 
IPV4Host getPeer (tpport_t *port=((void *) 0)) const
 
IPV4Host getSender (tpport_t *port=((void *) 0)) const
 
long getSystemError (void) const
 
const char * getSystemErrorString (void) const
 
bool isActive (void) const
 Test to see if the socket is at least operating or if it is mearly initialized.
 
bool isBroadcast (void) const
 Return if broadcast has been enabled for the specified socket.
 
bool isConnected (void) const
 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) const
 Return if socket routing is enabled.
 
 operator bool () const
 
bool operator! () const
 Operator based testing to see if a socket is currently active.
 
Socket & operator= (const 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 receiver can receive data from another peer host or subnet.

This class is used exclusivily to derive the UDPDuplex.

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

Definition at line 442 of file udp.h.

Constructor & Destructor Documentation

ost::UDPReceive::UDPReceive ( const IPV4Address bind,
tpport_t  port 
)
protected

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.

On failure to bind, an exception is thrown.

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

Member Function Documentation

Error ost::UDPReceive::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 received from the specified host.

Returns
0 on success, -1 on error.
Parameters
hosthost network address to connect socket to.
porthost transport port to connect socket to.
bool ost::UDPReceive::isInputReady ( timeout_t  timeout = ucommon::Timer::inf)
inline

See if input queue has data packets available.

Returns
true if data packets available.
Parameters
timeoutin milliseconds.

Definition at line 531 of file udp.h.

bool ost::UDPReceive::isPendingReceive ( timeout_t  timeout)
inlineprotected

Check for pending data.

Returns
true if data is waiting.
Parameters
timeoutin milliseconds.

Definition at line 480 of file udp.h.

ssize_t ost::UDPReceive::receive ( void *  buf,
size_t  len 
)
inline

Receive a data packet from the connected peer host.

Returns
num of bytes actually received.
Parameters
bufaddress of data receive buffer.
lensize of data receive buffer.

Definition at line 522 of file udp.h.


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