UDP sockets implement the TCP SOCK_DGRAM UDP protocol.
More...
#include <socket.h>
Inheritance diagram for UDPSocket:
Collaboration diagram for UDPSocket:
Public Types
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
}
Public Member Functions
Create an unbound UDP socket, mostly for internal use.
More...
Create a UDP socket bound by a service name.
More...
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...
Destroy a UDP socket as a socket.
More...
set the peer address to send message packets to.
More...
get the interface index for a named network device
More...
join a multicast group on a particular interface
More...
ssize_t
send (const void *buf, size_t len)
Send a message packet to a peer host.
More...
ssize_t
receive (void *buf, size_t len, bool reply=false)
Receive a message from any host.
More...
Examine address of sender of next waiting packet.
More...
ssize_t
peek (void *buf, size_t len)
Examine contents of next waiting packet.
More...
Associate socket with a named connection.
More...
Disassociate this socket from any host connection.
More...
May be used to examine the origin of data waiting in the socket receive queue.
More...
Get the local address and port number this socket is currently bound to.
More...
Perform NAT table lookup for this socket.
More...
Used to specify blocking mode for the socket.
More...
Enable lingering sockets on close.
More...
Set packet scheduling on platforms which support ip quality of service conventions.
More...
Can test to see if this socket is "connected", and hence whether a "catch" can safely call
getPeer().
More...
Test to see if the socket is at least operating or if it is mearly initialized.
More...
Operator based testing to see if a socket is currently active.
More...
Return if broadcast has been enabled for the specified socket.
More...
Return if socket routing is enabled.
More...
Often used by a "catch" to fetch the last error of a thrown socket.
More...
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...
Get the status of pending operations.
More...
Static Public Member Functions
See if a specific protocol family is available in the current runtime environment.
More...
Protected Types
Protected Member Functions
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...
This service is used to turn the error handler on or off for "throwing" exceptions by manipulating the thrown flag.
More...
Used as the default destructor for ending a socket.
More...
Used as a common handler for connection failure processing.
More...
Set the send timeout for sending raw network data.
More...
Receive timeout for receiving raw network data.
More...
Set the protocol stack network kernel send buffer size associated with the socket.
More...
Set the protocol stack network kernel receive buffer size associated with the socket.
More...
Set the total protocol stack network kernel buffer size for both send and receive together.
More...
Set the subnet broadcast flag for the socket.
More...
Setting multicast binds the multicast interface used for the socket to the interface the socket itself has been implicitly bound to.
More...
Set the multicast loopback flag for the socket.
More...
Set the multicast time to live for a multicast socket.
More...
Drop membership from a multicast group.
More...
Set the socket routing to indicate if outgoing messages should bypass normal routing (set false).
More...
Enable/disable delaying packets (Nagle algorithm)
More...
Process a logical input line from a socket descriptor directly.
More...
Read in a block of len bytes with specific separator.
More...
Write a block of len bytes to socket.
More...
Protected Attributes
union {
struct {
the actual socket descriptor, in Windows, unlike posix it
cannot be used as an file descriptor that way madness lies – jfc
More...
Static Protected Attributes
Private Member Functions
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.
- Author
- David Sugar dyfet.nosp@m.@ost.nosp@m.el.co.nosp@m.m Unreliable Datagram Protocol sockets.
Definition at line 884 of file socket.h.
Member Typedef Documentation
Member Enumeration Documentation
| Enumerator |
|---|
| errSuccess |
| 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 |
Definition at line 131 of file socket.h.
| Enumerator |
|---|
| pendingInput |
| pendingOutput |
| pendingError |
Definition at line 174 of file socket.h.
| Enumerator |
|---|
| INITIAL |
| AVAILABLE |
| BOUND |
| CONNECTED |
| CONNECTING |
| STREAM |
Definition at line 182 of file socket.h.
| Enumerator |
|---|
| tosLowDelay |
| tosThroughput |
| tosReliability |
| tosMinCost |
| tosInvalid |
Definition at line 165 of file socket.h.
Constructor & Destructor Documentation
Create an unbound UDP socket, mostly for internal use.
UDPSocket::UDPSocket
(
const char *
name,
)
Create a UDP socket bound by a service name.
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
-
bind address to bind this socket to.
port number to bind this socket to.
virtual UDPSocket::~UDPSocket
(
)
virtual |
Destroy a UDP socket as a socket.
Member Function Documentation
Error Socket::bufferSize
(
unsigned
size )
protectedinherited |
Set the total protocol stack network kernel buffer size for both send and receive together.
- Returns
- errSuccess on success
- Parameters
-
size of buffer.
static bool Socket::check
(
Family
fam )
staticinherited |
See if a specific protocol family is available in the current runtime environment.
- Returns
- true if family available.
void UDPSocket::connect
(
const
IPV4Host &
host,
)
void UDPSocket::connect
(
const char *
service )
Error Socket::connectError
(
void
)
protectedinherited |
Used as a common handler for connection failure processing.
- Returns
- correct failure code to apply.
Error UDPSocket::disconnect
(
void
)
Disassociate this socket from any host connection.
No data should be read or written until a connection is established.
Drop membership from a multicast group.
- Returns
- 0 (errSuccess) on success, else error code.
- Parameters
-
ia address of multicast group to drop.
void Socket::endSocket
(
void
)
protectedinherited |
Used as the default destructor for ending a socket.
This will cleanly terminate the socket connection. It is provided for use in derived virtual destructors.
const char *
err = NULL,
long
systemError = 0
)
const
protectedinherited |
This service is used to throw all socket errors which usually occur during the socket constructor.
- Parameters
-
error defined socket error id.
err string or message to pass.
systemError the system error# that caused the error
void Socket::error
(
const char *
err )
const
inlineprotectedinherited |
This service is used to throw application defined socket errors where the application specific error code is a string.
- Parameters
-
err string or message to pass.
Definition at line 240 of file socket.h.
Error Socket::getErrorNumber
(
void
)
const
inlineinherited |
Often used by a "catch" to fetch the last error of a thrown socket.
- Returns
- error number of Error error.
Definition at line 668 of file socket.h.
const char* Socket::getErrorString
(
void
)
const
inlineinherited |
Often used by a "catch" to fetch the user set error string of a thrown socket, but only if EXTENDED error codes are used.
- Returns
- string for error message.
Definition at line 676 of file socket.h.
get the interface index for a named network device
- Parameters
-
ethX is device name, like "eth0" or "eth1"
InterfaceIndex is the index value returned by os
- Todo:
- Win32 and ipv6 specific implementation.
Get the local address and port number this socket is currently bound to.
- Parameters
-
port ptr to port number on local host.
- Returns
- host address of interface this socket is bound to.
Perform NAT table lookup for this socket.
Used to allow an application to know the original ip:port pair the the client "thinks" it is connecting to. Used mostly to transparently impersonate a remote server/service.
On error, 0.0.0.0:0 is returned and one of the following error codes is set: errServiceUnavailable - if nat is not supported on the current platform or if it was not compiled; errLookupFail - if the nat syscall failed for some reason (extended error code); errSearchErr - if the socket does not have nat information (i.e. is not nated).
NAT lookup is supported on NetFilter for ipv4 and ipv6 (Linux), IPFilter for ipv4 (Solaris, *BSD except OpenBSD, HP-UX, etc.) and Packet Filter for ipv4 and ipv6 (OpenBSD). When using IPFilter or Packet Filter, the first NAT lookup must be performed as root (the NAT device is read only for root and is opened once, unless an error occurs). Permissions on the nat device may be changed to solve this.
- Warning
- When using IPFilter and Packet Filter, application data model must be the same as the running kernel (32/64 bits).
- Parameters
-
port ptr to NATed port number on local host.
- Returns
- NATed host address that this socket is related to.
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
-
port pointer to hold port number.
May be used to examine the origin of data waiting in the socket receive queue.
This can tell a TCP server where pending "connect" requests are coming from, or a UDP socket where it's next packet arrived from.
- Parameters
-
port ptr to port number of sender.
- Returns
- host address, test with "isInetAddress()".
Reimplemented in DCCPSocket.
long Socket::getSystemError
(
void
)
const
inlineinherited |
const char* Socket::getSystemErrorString
(
void
)
const
inherited |
bool Socket::isActive
(
void
)
const
inherited |
Test to see if the socket is at least operating or if it is mearly initialized.
"initialized" sockets may be the result of failed constructors.
- Returns
- true if not in initial state.
bool Socket::isBroadcast
(
void
)
const
inlineinherited |
Return if broadcast has been enabled for the specified socket.
- Returns
- true if broadcast socket.
Definition at line 651 of file socket.h.
bool Socket::isConnected
(
void
)
const
inherited |
Can test to see if this socket is "connected", and hence whether a "catch" can safely call getPeer().
Of course, an unconnected socket will return a 0.0.0.0 address from getPeer() as well.
- Returns
- true when socket is connected to a peer.
virtual bool Socket::isPending
(
Pending
pend,
)
virtualinherited |
Get the status of pending operations.
This can be used to examine if input or output is waiting, or if an error has occured on the descriptor.
- Returns
- true if ready, false on timeout.
- Parameters
-
pend ready check to perform.
timeout in milliseconds, inf. if not specified.
Reimplemented in SimpleTCPStream, TCPStream, and UnixStream.
bool Socket::isRouted
(
void
)
const
inlineinherited |
Return if socket routing is enabled.
- Returns
- true if routing enabled.
Definition at line 659 of file socket.h.
Join a multicast group.
- Returns
- 0 (errSuccess) on success, else error code.
- Parameters
-
ia address of multicast group to join.
join a multicast group on a particular interface
- Parameters
-
ia is the multicast address to use
InterfaceIndex is the index value returned by getInterfaceIndex
- Todo:
- Win32 and ipv6 specific implementation.
bool Socket::operator!
(
)
const
inherited |
Operator based testing to see if a socket is currently active.
ssize_t UDPSocket::peek
(
void *
buf,
size_t
len
)
inline |
Examine contents of next waiting packet.
- Parameters
-
buf pointer to packet buffer for contents.
len of packet buffer.
- Returns
- number of bytes examined.
Definition at line 1028 of file socket.h.
virtual ssize_t Socket::readData
(
void *
buf,
size_t
len,
char
separator = 0,
)
protectedvirtualinherited |
Read in a block of len bytes with specific separator.
Can be zero, or any other char. If \n or \r, it's treated just like a readLine(). Otherwise it looks for the separator.
- Parameters
-
buf pointer to byte allocation.
len maximum length to read.
separator separator for a particular ASCII character
t timeout for pending data in milliseconds.
- Returns
- number of bytes actually read.
ssize_t Socket::readLine
(
char *
buf,
size_t
len,
)
protectedinherited |
Process a logical input line from a socket descriptor directly.
- Parameters
-
buf pointer to string.
len maximum length to read.
timeout for pending data in milliseconds.
- Returns
- number of bytes actually read.
ssize_t UDPSocket::receive
(
void *
buf,
size_t
len,
bool
reply = false
)
Receive a message from any host.
- Parameters
-
buf pointer to packet buffer to receive.
len of packet buffer to receive.
reply save sender address for reply if true.
- Returns
- number of bytes received.
Error Socket::receiveBuffer
(
unsigned
size )
protectedinherited |
Set the protocol stack network kernel receive buffer size associated with the socket.
- Returns
- errSuccess on success, or error.
- Parameters
-
size of buffer in bytes.
Error Socket::receiveLimit
(
int
limit =
1 )
protectedinherited |
Receive timeout for receiving raw network data.
- Returns
- errSuccess if set.
- Parameters
-
timer value in milliseconds.
ssize_t UDPSocket::send
(
const void *
buf,
size_t
len
)
Send a message packet to a peer host.
- Parameters
-
buf pointer to packet buffer to send.
len of packet buffer to send.
- Returns
- number of bytes sent.
Error Socket::sendBuffer
(
unsigned
size )
protectedinherited |
Set the protocol stack network kernel send buffer size associated with the socket.
- Returns
- errSuccess on success, or error.
- Parameters
-
size of buffer in bytes.
Error Socket::sendLimit
(
int
limit =
2048 )
protectedinherited |
Set the send timeout for sending raw network data.
- Returns
- errSuccess if set.
- Parameters
-
timer value in millisec.
Error Socket::setBroadcast
(
bool
enable )
protectedinherited |
Set the subnet broadcast flag for the socket.
This enables sending to a subnet and may require special image privileges depending on the operating system.
- Returns
- 0 (errSuccess) on success, else error code.
- Parameters
-
enable when set to true.
void Socket::setCompletion
(
bool
immediate )
inherited |
Used to specify blocking mode for the socket.
A socket can be made non-blocking by setting setCompletion(false) or set to block on all access with setCompletion(true). I do not believe this form of non-blocking socket I/O is supported in winsock, though it provides an alternate asynchronous set of socket services.
- Parameters
-
immediate mode specify socket I/O call blocking mode.
void Socket::setError
(
bool
enable )
inlineprotectedinherited |
This service is used to turn the error handler on or off for "throwing" exceptions by manipulating the thrown flag.
- Parameters
-
enable true to enable handler.
Definition at line 249 of file socket.h.
Error UDPSocket::setKeepAlive
(
bool
enable )
inlineprivate |
Error Socket::setLinger
(
bool
linger )
inherited |
Enable lingering sockets on close.
- Parameters
-
linger specify linger enable.
Error UDPSocket::setLoopback
(
bool
enable )
inline |
Set the loopback.
Definition at line 937 of file socket.h.
Error Socket::setLoopbackByFamily
(
bool
enable,
)
protectedinherited |
Set the multicast loopback flag for the socket.
Loopback enables a socket to hear what it is sending.
- Returns
- 0 (errSuccess) on success, else error code.
- Parameters
-
enable when set to true.
family of protocol.
Error UDPSocket::setMulticast
(
bool
enable )
inline |
Set the multicast.
Definition at line 943 of file socket.h.
Error Socket::setMulticastByFamily
(
bool
enable,
)
protectedinherited |
Setting multicast binds the multicast interface used for the socket to the interface the socket itself has been implicitly bound to.
It is also used as a check flag to make sure multicast is enabled before multicast operations are used.
- Returns
- 0 (errSuccess) on success, else error code.
- Parameters
-
enable when set to true.
family of protocol.
Error Socket::setNoDelay
(
bool
enable )
protectedinherited |
Enable/disable delaying packets (Nagle algorithm)
- Returns
- 0 on success.
- Parameters
-
enable disable Nagle algorithm when set to true.
void UDPSocket::setPeer
(
const
IPV4Host &
host,
)
set the peer address to send message packets to.
This can be set before every send() call if nessisary.
- Parameters
-
host address to send packets to.
port number to deliver packets to.
void UDPSocket::setPeer
(
const char *
service )
Associate socket with a named connection.
Error Socket::setRouting
(
bool
enable )
protectedinherited |
Set the socket routing to indicate if outgoing messages should bypass normal routing (set false).
- Returns
- 0 on success.
- Parameters
-
enable normal routing when set to true.
Error UDPSocket::setTimeToLive
(
char
ttl )
inline |
Set time to live.
Definition at line 949 of file socket.h.
Error Socket::setTimeToLiveByFamily
(
unsigned char
ttl,
)
protectedinherited |
Set the multicast time to live for a multicast socket.
- Returns
- 0 (errSuccess) on success, else error code.
- Parameters
-
ttl time to live.
fam family of protocol.
Error Socket::setTypeOfService
(
Tos
service )
inherited |
Set packet scheduling on platforms which support ip quality of service conventions.
This effects how packets in the queue are scheduled through the interface.
- Returns
- 0 on success, error code on failure.
- Parameters
-
service type of service enumerated type.
virtual ssize_t Socket::writeData
(
const void *
buf,
size_t
len,
)
protectedvirtualinherited |
Write a block of len bytes to socket.
- Parameters
-
buf pointer to byte allocation.
len maximum length to write.
t timeout for pending data in milliseconds.
- Returns
- number of bytes actually written.
Field Documentation
bool Socket::broadcast
inherited |
bool Socket::completion
inherited |
struct { ... } Socket::flags
struct sockaddr_in UDPSocket::ipv4
bool Socket::keepalive
inherited |
bool Socket::linger
inherited |
bool Socket::loopback
inherited |
bool Socket::multicast
inherited |
union { ... } UDPSocket::peer
bool Socket::route
inherited |
the actual socket descriptor, in Windows, unlike posix it cannot be used as an file descriptor that way madness lies – jfc
Definition at line 221 of file socket.h.
State volatile Socket::state
protectedinherited |
bool Socket::thrown
inherited |
unsigned Socket::ttl
inherited |
The documentation for this class was generated from the following file:
Generated on Dec 21, 2017 for
commoncpp2-1.8.1,
ccrtp-1.7.2,
libzrtpcpp-2.3.4,
ccscript3-1.1.7,
ccaudio2-1.0.0 and
bayonne2-2.3.2
(after installation in /usr/local/)
by
doxygen 1.8.6