The socket port is an internal class which is attached to and then serviced by a specific SocketService "object".
More...
#include <socketport.h>
Inheritance diagram for SocketPort:
Collaboration diagram for SocketPort:
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
Derived setTimer to notify the service thread pool of change in expected timeout.
More...
Derived incTimer to notify the service thread pool of a change in expected timeout.
More...
May be used to examine the origin of data waiting in the socket receive queue.
More...
Get the host address and port of the socket this socket is connected to.
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 the keep-alive status of this socket and if keep-alive messages will be sent.
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...
Adjust a timeout based on the current time reference value either from object creation or the last
setTimer().
More...
Sleep until the current timer expires.
More...
This is used to "disable" the service thread from expiring the timer object.
More...
This is used by service threads to determine how much time remains before the timer expires based on a timeout specified in
setTimer() or
incTimer().
More...
This is used to determine how much time has elapsed since a timer port setTimer benchmark time was initially set.
More...
Static Public Member Functions
See if a specific protocol family is available in the current runtime environment.
More...
Protected Types
Protected Member Functions
Construct an accepted TCP socket connection from a specific bound TCP server.
More...
Construct a bound UDP socket for use in deriving realtime UDP streaming protocols handled by thread pool objects.
More...
A non-blocking constructor for outbound tcp connections.
More...
Attach yourself to the service pool thread object.
More...
Disconnect the socket from the service thread pool and the remote connection.
More...
Used to indicate if the service thread should monitor pending data for us.
More...
Get the current state of the DetectPending flag.
More...
Used to indicate if output ready monitoring should be performed by the service thread.
More...
Get the current state of the DetectOutput flag.
More...
Called by the service thread pool when the objects timer has expired.
More...
Called by the service thread pool when input data is pending for this socket.
More...
Called by the service thread pool when output data is pending for this socket.
More...
Called by the service thread pool when a disconnect has occured.
More...
ssize_t
send (const void *buf, size_t len)
Transmit "send" data to a connected peer host.
More...
ssize_t
receive (void *buf, size_t len)
Receive a message from any host.
More...
ssize_t
peek (void *buf, size_t len)
Examine the content of the next packet.
More...
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
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 Attributes
Friends
Detailed Description
The socket port is an internal class which is attached to and then serviced by a specific SocketService "object".
Derived versions of this class offer specific functionality for specific protocols. Both Common C++ supporting frameworks and application objects may be derived from related protocol specific base classes.
A special set of classes, "SocketPort" and "SocketService", exist for building realtime streaming media servers on top of UDP and TCP protocols. The "SocketPort" is used to hold a connected or associated TCP or UDP socket which is being "streamed" and which offers callback methods that are invoked from a "SocketService" thread. SocketService's can be pooled into logical thread pools that can service a group of SocketPorts. A millisecond accurate "timer" is associated with each SocketPort and can be used to time synchronize SocketPort I/O operations.
- Author
- David Sugar dyfet.nosp@m.@ost.nosp@m.el.co.nosp@m.m base class for realtime and thread pool serviced protocols.
Definition at line 81 of file socketport.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
Construct an accepted TCP socket connection from a specific bound TCP server.
This is meant to derive advanced application specific TCP servers that can be thread pooled.
- Parameters
-
svc pool thread object.
tcp socket object to accept.
Construct a bound UDP socket for use in deriving realtime UDP streaming protocols handled by thread pool objects.
- Parameters
-
svc pool thread object.
ia address of interface to bind.
port number to bind to.
virtual SocketPort::~SocketPort
(
)
protectedvirtual |
Disconnect the socket from the service thread pool and the remote connection.
Member Function Documentation
Attach yourself to the service pool thread object.
The later version.
- Parameters
-
svc pool thread object
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.
Connect a Socket Port to a known peer host.
This is normally used with the UDP constructor. This is also performed as a non-blocking operation under Posix systems to prevent delays in a callback handler.
- Returns
- 0 if successful.
- Parameters
-
ia address of remote host or subnet.
port number of remote peer(s).
Error Socket::connectError
(
void
)
protectedinherited |
Used as a common handler for connection failure processing.
- Returns
- correct failure code to apply.
void TimerPort::decTimer
(
timeout_t
timeout )
inherited |
Adjust a timeout based on the current time reference value either from object creation or the last setTimer().
This reference can be used to time synchronize realtime data over specified intervals and force expiration when a new frame should be released in a synchronized manner.
- Parameters
-
timeout delay in milliseconds from reference.
virtual void SocketPort::disconnect
(
void
)
protectedvirtual |
Called by the service thread pool when a disconnect has occured.
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.
void TimerPort::endTimer
(
void
)
inherited |
This is used to "disable" the service thread from expiring the timer object.
It does not effect the reference time from either creation or a setTimer().
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.
virtual void SocketPort::expired
(
void
)
protectedvirtual |
Called by the service thread pool when the objects timer has expired.
Used for timed events.
bool SocketPort::getDetectOutput
(
void
)
const
inlineprotected |
Get the current state of the DetectOutput flag.
Definition at line 180 of file socketport.h.
bool SocketPort::getDetectPending
(
void
)
const
inlineprotected |
Get the current state of the DetectPending flag.
Definition at line 168 of file socketport.h.
timeout_t TimerPort::getElapsed
(
void
)
const
inherited |
This is used to determine how much time has elapsed since a timer port setTimer benchmark time was initially set.
This allows one to use setTimer() to set the timer to the current time and then measure elapsed time from that point forward.
return time elapsed in milliseconds, or TIMEOUT_INF if inactive.
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 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.
Get the host address and port of the socket this socket is connected to.
If the socket is currently not in a connected state, then a host address of 0.0.0.0 is returned.
- Parameters
-
port ptr to port number of remote socket.
- Returns
- host address of remote socket.
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 |
This is used by service threads to determine how much time remains before the timer expires based on a timeout specified in setTimer() or incTimer().
It can also be called after setting a timeout with incTimer() to see if the current timeout has already expired and hence that the application is already delayed and should skip frame(s).
return time remaining in milliseconds, or TIMEOUT_INF if inactive.
void SocketPort::incTimer
(
timeout_t
timeout )
Derived incTimer to notify the service thread pool of a change in expected timeout.
This allows SocketService to reschedule all timers. Otherwise same as TimerPort.
- Parameters
-
timeout in milliseconds.
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.
bool Socket::operator!
(
)
const
inherited |
Operator based testing to see if a socket is currently active.
virtual void SocketPort::output
(
void
)
protectedvirtual |
Called by the service thread pool when output data is pending for this socket.
ssize_t SocketPort::peek
(
void *
buf,
size_t
len
)
inlineprotected |
Examine the content of the next packet.
This can be used to build "smart" line buffering for derived TCP classes.
- Parameters
-
buf pointer to packet buffer to examine.
len of packet buffer to examine.
- Returns
- number of bytes actually available.
Definition at line 253 of file socketport.h.
virtual void SocketPort::pending
(
void
)
protectedvirtual |
Called by the service thread pool when input data is pending for this socket.
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 SocketPort::receive
(
void *
buf,
size_t
len
)
inlineprotected |
Receive a message from any host.
This is used in derived classes to build protocols.
- Parameters
-
buf pointer to packet buffer to receive.
len of packet buffer to receive.
- Returns
- number of bytes received.
Definition at line 242 of file socketport.h.
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 SocketPort::send
(
const void *
buf,
size_t
len
)
inlineprotected |
Transmit "send" data to a connected peer host.
This is not public by default since an overriding protocol is likely to be used in a derived class.
- Returns
- number of bytes sent.
- Parameters
-
buf address of buffer to send.
len of bytes to send.
Definition at line 231 of file socketport.h.
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 SocketPort::setDetectOutput
(
bool
)
protected |
Used to indicate if output ready monitoring should be performed by the service thread.
void SocketPort::setDetectPending
(
bool
)
protected |
Used to indicate if the service thread should monitor pending data for us.
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 Socket::setKeepAlive
(
bool
enable )
inherited |
Set the keep-alive status of this socket and if keep-alive messages will be sent.
- Returns
- 0 on success.
- Parameters
-
enable keep alive messages.
Error Socket::setLinger
(
bool
linger )
inherited |
Enable lingering sockets on close.
- Parameters
-
linger specify linger enable.
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 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.
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.
void SocketPort::setTimer
(
timeout_t
timeout =
0 )
Derived setTimer to notify the service thread pool of change in expected timeout.
This allows SocketService to reschedule all timers. Otherwise same as TimerPort.
- Parameters
-
timeout in milliseconds.
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.
void TimerPort::sleepTimer
(
void
)
inherited |
Sleep until the current timer expires.
This is useful in time syncing realtime periodic tasks.
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.
Friends And Related Function Documentation
Field Documentation
bool Socket::broadcast
inherited |
bool Socket::completion
inherited |
bool SocketPort::detect_disconnect
private |
bool SocketPort::detect_output
private |
bool SocketPort::detect_pending
private |
struct { ... } Socket::flags
bool Socket::keepalive
inherited |
bool Socket::linger
inherited |
bool Socket::loopback
inherited |
bool Socket::multicast
inherited |
struct timeval SocketPort::porttimer
private |
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