UCommon
|
UDP sockets implement the TCP SOCK_DGRAM UDP protocol. More...
#include <udp.h>
Public Member Functions | |
void | connect (const ucommon::Socket::address &host) |
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. More... | |
Socket::Error | getInterfaceIndex (const char *ethX, int &InterfaceIndex) |
get the interface index for a named network device More... | |
IPV4Host | getIPV4Peer (tpport_t *port=NULL) |
IPV6Host | getIPV6Peer (tpport_t *port=NULL) |
ucommon::Socket::address | getPeer () |
Examine address of sender of next waiting packet. More... | |
IPV4Host | getPeer (tpport_t *port) |
Socket::Error | join (const ucommon::Socket::address &ia, int InterfaceIndex=0) |
join a multicast group on a particular interface More... | |
Socket::Error | join (const IPV4Multicast &ia, int InterfaceIndex) |
ssize_t | peek (void *buf, size_t len) |
Examine contents of next waiting packet. More... | |
ssize_t | receive (void *buf, size_t len, bool reply=false) |
Receive a message from any host. More... | |
ssize_t | send (const void *buf, size_t len) |
Send a message packet to a peer host. More... | |
Error | setLoopback (bool enable) |
Set the loopback. | |
Error | setMulticast (bool enable) |
Set the multicast. | |
void | setPeer (const ucommon::Socket::address &host) |
set the peer address to send message packets to. More... | |
void | setPeer (const IPV4Host &host, tpport_t port) |
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 ucommon::Socket::address &bind) | |
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. More... | |
UDPSocket (const IPV4Address &bind, tpport_t port) | |
UDPSocket (const IPV6Address &bind, tpport_t port) | |
virtual | ~UDPSocket () |
Destroy a UDP socket as a socket. | |
![]() | |
struct in_addr | getaddress (const IPV4Address &ia) const |
struct in6_addr | getaddress (const IPV6Address &ia) const |
Error | getErrorNumber (void) const |
Often used by a "catch" to fetch the last error of a thrown socket. More... | |
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. More... | |
IPV4Host | getIPV4Local (in_port_t *port=NULL) const |
Get the local address and port number this socket is currently bound to. More... | |
IPV4Host | getIPV4Peer (in_port_t *port=NULL) const |
virtual IPV4Host | getIPV4Sender (in_port_t *port=NULL) const |
IPV6Host | getIPV6Local (in_port_t *port=NULL) const |
IPV6Host | getIPV6Peer (in_port_t *port=NULL) const |
virtual IPV6Host | getIPV6Sender (in_port_t *port=NULL) const |
IPV4Host | getLocal (in_port_t *port) const |
ucommon::Socket::address | getLocal () const |
ucommon::Socket::address | getPeer () const |
Get the host address and port of the socket this socket is connected to. More... | |
IPV4Host | getPeer (in_port_t *port) const |
ucommon::Socket::address | getSender () const |
May be used to examine the origin of data waiting in the socket receive queue. More... | |
IPV4Host | getSender (in_port_t *port) 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. More... | |
bool | isBroadcast (void) const |
Return if broadcast has been enabled for the specified socket. More... | |
bool | isConnected (void) const |
Can test to see if this socket is "connected", and hence whether a "catch" can safely call getPeer(). More... | |
virtual bool | isPending (Pending pend, timeout_t timeout=ucommon::Timer::inf) |
Get the status of pending operations. More... | |
bool | isRouted (void) const |
Return if socket routing is enabled. More... | |
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. More... | |
Error | setKeepAlive (bool enable) |
Set the keep-alive status of this socket and if keep-alive messages will be sent. More... | |
Error | setLinger (bool linger) |
Enable lingering sockets on close. More... | |
Error | setTypeOfService (Tos service) |
Set packet scheduling on platforms which support ip quality of service conventions. More... | |
Protected Attributes | |
Family | family |
Socket::address | 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. More... | |
![]() | |
typedef cidr | cidr_t |
typedef struct hostaddr_internet | host_t |
![]() | |
Error | bufferSize (unsigned size) |
Set the total protocol stack network kernel buffer size for both send and receive together. More... | |
Error | connectError (void) const |
Used as a common handler for connection failure processing. More... | |
Error | drop (const ucommon::Socket::address &ia, int iface=0) |
Drop membership from a multicast group. More... | |
Error | drop (const IPV4Multicast &ia) |
Error | drop (const IPV6Multicast &ia, int iface=0) |
void | endSocket (void) |
Used as the default destructor for ending a socket. More... | |
Error | error (Error error, const char *err=NULL, long systemError=0) const |
This service is used to throw all socket errors which usually occur during the socket constructor. More... | |
void | error (const char *err) const |
This service is used to throw application defined socket errors where the application specific error code is a string. More... | |
Error | join (const ucommon::Socket::address &ia, int iface=0) |
Join a multicast group. More... | |
Error | join (const IPV4Multicast &ia) |
Error | join (const IPV6Multicast &ia, int iface=0) |
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. More... | |
ssize_t | readLine (char *buf, size_t len, timeout_t timeout=0) |
Process a logical input line from a socket descriptor directly. More... | |
Error | receiveBuffer (unsigned size) |
Set the protocol stack network kernel receive buffer size associated with the socket. More... | |
Error | receiveLimit (int limit=1) |
Set thr receive limit. | |
Error | receiveTimeout (timeout_t timer) |
Receive timeout for receiving raw network data. More... | |
Error | sendBuffer (unsigned size) |
Set the protocol stack network kernel send buffer size associated with the socket. More... | |
Error | sendLimit (int limit=2048) |
Set the send limit. | |
Error | sendTimeout (timeout_t timer) |
Set the send timeout for sending raw network data. More... | |
Error | setBroadcast (bool enable) |
Set the subnet broadcast flag for the socket. More... | |
void | setError (bool enable) |
This service is used to turn the error handler on or off for "throwing" exceptions by manipulating the thrown flag. More... | |
Error | setLoopbackByFamily (bool enable, Family family=IPV4) |
Set the multicast loopback flag for the socket. More... | |
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. More... | |
Error | setNoDelay (bool enable) |
Enable/disable delaying packets (Nagle algorithm) More... | |
Error | setRouting (bool enable) |
Set the socket routing to indicate if outgoing messages should bypass normal routing (set false). More... | |
Error | setTimeToLiveByFamily (uint8_t ttl, Family fam=IPV4) |
Set the multicast time to live for a multicast socket. More... | |
Socket (int domain, int type, int protocol=0) | |
An unconnected socket may be created directly on the local machine. More... | |
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. More... | |
Socket () | |
Create an inactive socket object for base constructors. | |
Socket (const Socket &source) | |
A socket can also be constructed from an already existing Socket object. More... | |
virtual ssize_t | writeData (const void *buf, size_t len, timeout_t t=0) |
Write a block of len bytes to socket. More... | |
![]() | |
static socket_t | dupSocket (socket_t s, Socket::State state) |
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 | ( | const ucommon::Socket::address & | bind | ) |
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.
Socket::Error ost::UDPSocket::getInterfaceIndex | ( | const 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 |
ucommon::Socket::address ost::UDPSocket::getPeer | ( | ) |
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 | ( | const ucommon::Socket::address & | ia, |
int | InterfaceIndex = 0 |
||
) |
join a multicast group on a particular interface
ia | is the multicast address to use |
InterfaceIndex | is the index value returned by getInterfaceIndex |
|
inline |
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 | ( | const 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. |
void ost::UDPSocket::setPeer | ( | const ucommon::Socket::address & | host | ) |
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. |