class UDPSocket

Unreliable Datagram Protocol sockets. More...

Definition#include <socket.h>
InheritsSocket
Inherited byUDPBroadcast, UDPTransmit, UDPDuplex, UDPReceive, UDPDuplex
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Members

Protected Members


Detailed Description

UDP sockets implement the TCP SOCK_DGRAM UDP protocol. They can be used to pass unverified messages between hosts, or to broadcast a specific message to an entire subnet. Please note that Streaming of realtime data commonly use UDPDuplex related classes rather than UDPSocket.

UDPSocket (void)

Create an unbound UDP socket, mostly for internal use.

UDPSocket (const InetAddress &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. On failure to bind, an exception is thrown.

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

~UDPSocket ()

Destroy a UDP socket as a socket.

void setPeer (const InetHostAddress &host, tpport_t port)

set the peer address to send message packets to. This can be set before every Send() call if nessisary.

Parameters:
hostaddress to send packets to.
portnumber to deliver packets to.

inline int Send (void *buf, size_t len)

Send a message packet to a peer host.

Parameters:
pointerto packet buffer to send.
lenof packet buffer to send.

Returns: number of bytes sent.

inline int Recv (void *buf, size_t len)

Receive a message from any host.

Parameters:
pointerto packet buffer to receive.
lenof packet buffer to receive.

Returns: number of bytes received.

InetHostAddress getPeer (tpport_t *port = NULL)

Examine address of sender of next waiting packet. This also sets "peer" address to the sender so that the next "send" message acts as a "reply". This additional behavior overides the standard socket getSender behavior.

Parameters:
pointerto hold port number.

Reimplemented from Socket

inline int Peek (void *buf, size_t len)

Examine contents of next waiting packet.

Parameters:
pointerto packet buffer for contents.
lenof packet buffer.

Returns: number of bytes examined.