class UDPReceive

Unreliable Datagram Peer Associations. More...

Full nameost::UDPReceive
Definition#include <socket.h>
Inheritsost::UDPSocket [private ]
Inherited byUDPDuplex
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Protected Methods


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.

 UDPReceive (const InetAddress &bind, tpport_t port)

UDPReceive

[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.
portnumber on peer host to associate with.

sockerror_t  Connect (const InetHostAddress &host, tpport_t port)

Connect

[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.

Parameters:
hostaddress to connect socket to.

Returns: 0 on success, -1 on error.

sockerror_t  Disconnect (void)

Disconnect

[protected]

Disassociate this socket from any host connection. No data should be read or written until a connection is established.

bool  isPendingReceive (timeout_t timeout)

isPendingReceive

[protected]

Check for pending data.

Parameters:
timeoutin milliseconds.

Returns: true if data is waiting.

inline void  endReceiver (void)

endReceiver

[protected]

End receiver.

inline SOCKET  getReceiver (void)

getReceiver

[protected]

inline sockerror_t  setRouting (bool enable)

setRouting

[protected]

Reimplemented from Socket.

inline sockerror_t  setMulticast (bool enable)

setMulticast

[protected]

Reimplemented from Socket.

inline sockerror_t  Join (const InetMcastAddress &ia)

Join

[protected]

Reimplemented from Socket.

inline sockerror_t  Drop (const InetMcastAddress &ia)

Drop

[protected]

Reimplemented from Socket.

inline int  Receive (void *buf, size_t len)

Receive

Receive a data packet from the connected peer host.

Parameters:
addrof data receive buffer.
sizeof data receive buffer.

Returns: num of bytes actually received.

inline bool  isInputReady (timeout_t timeout = TIMEOUT_INF)

isInputReady

See if input queue has data packets available.

Parameters:
timeoutin milliseconds.

Returns: true if data packets available.