ucommon
|
UDP sockets implement the TCP SOCK_DGRAM UDP protocol. More...
#include <udp.h>
Public Member Functions | |
void | connect (IPV4Host &host, tpport_t port) |
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. | |
ssize_t | send (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 (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. | |
![]() | |
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. |
Protected Attributes | |
Family | family |
union { | |
struct sockaddr_in ipv4 | |
struct sockaddr_in6 ipv6 | |
} | peer |
![]() | |
struct { | |
bool broadcast: 1 | |
bool completion: 1 | |
bool keepalive: 1 | |
bool linger: 1 | |
bool loopback: 1 | |
bool multicast: 1 | |
bool route: 1 | |
bool thrown: 1 | |
unsigned ttl: 8 | |
} | flags |
State volatile | state |
Additional Inherited Members | |
![]() | |
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 bool | check (Family fam) |
See if a specific protocol family is available in the current runtime environment. | |
![]() | |
typedef void * | set_t |
External definition of fd_set type. | |
![]() | |
Error | bufferSize (unsigned size) |
Set the total protocol stack network kernel buffer size for both send and receive together. | |
Error | connectError (void) |
Used as a common handler for connection failure processing. | |
Error | drop (IPV4Multicast &ia) |
Drop membership from a multicast group. | |
Error | drop (IPV6Multicast &ia) |
void | endSocket (void) |
Used as the default destructor for ending a socket. | |
Error | error (Error error, char *err=((void *) 0), long systemError=0) |
This service is used to throw all socket errors which usually occur during the socket constructor. | |
void | error (char *err) |
This service is used to throw application defined socket errors where the application specific error code is a string. | |
Error | join (IPV4Multicast &ia) |
Join a multicast group. | |
Error | join (IPV6Multicast &ia) |
virtual ssize_t | readData (void *buf, size_t len, char separator=0, timeout_t t=0) |
Read in a block of len bytes with specific separator. | |
ssize_t | readLine (char *buf, size_t len, timeout_t timeout=0) |
Process a logical input line from a socket descriptor directly. | |
Error | receiveBuffer (unsigned size) |
Set the protocol stack network kernel receive buffer size associated with the socket. | |
Error | receiveLimit (int limit=1) |
Set thr receive limit. | |
Error | receiveTimeout (timeout_t timer) |
Receive timeout for receiving raw network data. | |
Error | sendBuffer (unsigned size) |
Set the protocol stack network kernel send buffer size associated with the socket. | |
Error | sendLimit (int limit=2048) |
Set the send limit. | |
Error | sendTimeout (timeout_t timer) |
Set the send timeout for sending raw network data. | |
Error | setBroadcast (bool enable) |
Set the subnet broadcast flag for the socket. | |
void | setError (bool enable) |
This service is used to turn the error handler on or off for "throwing" exceptions by manipulating the thrown flag. | |
Error | setLoopbackByFamily (bool enable, Family family=IPV4) |
Set the multicast loopback flag for the socket. | |
Error | setMulticastByFamily (bool enable, Family family=IPV4) |
Setting multicast binds the multicast interface used for the socket to the interface the socket itself has been implicitly bound to. | |
Error | setNoDelay (bool enable) |
Enable/disable delaying packets (Nagle algorithm) | |
Error | setRouting (bool enable) |
Set the socket routing to indicate if outgoing messages should bypass normal routing (set false). | |
Error | setTimeToLiveByFamily (unsigned char ttl, Family fam=IPV4) |
Set the multicast time to live for a multicast socket. | |
Socket (int domain, int type, int protocol=0) | |
An unconnected socket may be created directly on the local machine. | |
Socket (socket_t fd) | |
A socket object may be created from a file descriptor when that descriptor was created either through a socket() or accept() call. | |
Socket () | |
Create an inactive socket object for base constructors. | |
Socket (Socket &source) | |
A socket can also be constructed from an already existing Socket object. | |
virtual ssize_t | writeData (void *buf, size_t len, timeout_t t=0) |
Write a block of len bytes to socket. | |
![]() | |
static socket_t | dupSocket (socket_t s, Socket::State state) |
![]() | |
static Mutex | mutex |
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.
ost::UDPSocket::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.
On failure to bind, an exception is thrown.
bind | address to bind this socket to. |
port | number to bind this socket to. |
Error ost::UDPSocket::disconnect | ( | void | ) |
Disassociate this socket from any host connection.
No data should be read or written until a connection is established.
Reimplemented from ucommon::Socket.
Reimplemented in ost::UDPDuplex.
Socket::Error ost::UDPSocket::getInterfaceIndex | ( | char * | ethX, |
int & | InterfaceIndex | ||
) |
get the interface index for a named network device
ethX | is device name, like "eth0" or "eth1" |
InterfaceIndex | is the index value returned by os |
IPV4Host ost::UDPSocket::getIPV4Peer | ( | tpport_t * | port = ((void *) 0) | ) |
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.
port | pointer to hold port number. |
Socket::Error ost::UDPSocket::join | ( | IPV4Multicast & | ia, |
int | InterfaceIndex | ||
) |
join a multicast group on a particular interface
ia | is the multicast address to use |
InterfaceIndex | is the index value returned by getInterfaceIndex |
|
inline |
Examine contents of next waiting packet.
buf | pointer to packet buffer for contents. |
len | of packet buffer. |
Reimplemented from ucommon::Socket.
ssize_t ost::UDPSocket::receive | ( | void * | buf, |
size_t | len, | ||
bool | reply = false |
||
) |
Receive a message from any host.
buf | pointer to packet buffer to receive. |
len | of packet buffer to receive. |
reply | save sender address for reply if true. |
ssize_t ost::UDPSocket::send | ( | void * | buf, |
size_t | len | ||
) |
Send a message packet to a peer host.
buf | pointer to packet buffer to send. |
len | of packet buffer to send. |
Reimplemented in ost::UDPTransmit.
void ost::UDPSocket::setPeer | ( | IPV4Host & | host, |
tpport_t | port | ||
) |
set the peer address to send message packets to.
This can be set before every send() call if nessisary.
host | address to send packets to. |
port | number to deliver packets to. |