class UDPSocket

Unreliable Datagram Protocol sockets. More...

Full nameost::UDPSocket
Definition#include <socket.h>
Inheritsost::Socket [public ]
Inherited byUDPBroadcast, UDPDuplex, UDPDuplex, UDPReceive, UDPTransmit
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

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.

In addition to connected TCP sessions, Common C++ supports UDP sockets and these also cover a range of functionality. Like a TCPSocket, A UDPSocket can be created bound to a specific network interface and/or port address, though this is not required. UDP sockets also are usually either connected or otherwise "associated" with a specific "peer" UDP socket. Since UDP sockets operate through discreet packets, there are no streaming operators used with UDP sockets.

In addition to the UDP "socket" class, there is a "UDPBroadcast" class. The UDPBroadcast is a socket that is set to send messages to a subnet as a whole rather than to an individual peer socket that it may be associated with.

UDP sockets are often used for building "realtime" media streaming protocols and full duplex messaging services. When used in this manner, typically a pair of UDP sockets are used together; one socket is used to send and the other to receive data with an associated pair of UDP sockets on a "peer" host. This concept is represented through the Common C++ UDPDuplex object, which is a pair of sockets that communicate with another UDPDuplex pair.

 UDPSocket (void)

UDPSocket

Create an unbound UDP socket, mostly for internal use.

 UDPSocket (const InetAddress &bind, tpport_t port)

UDPSocket

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 ()

~UDPSocket

[virtual]

Destroy a UDP socket as a socket.

void  setPeer (const InetHostAddress &host, tpport_t port)

setPeer

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 (const void *buf, size_t len)

Send

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)

Recv

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)

getPeer

[const]

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)

Peek

Examine contents of next waiting packet.

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

Returns: number of bytes examined.