|
Bayonne2 / Common C++ 2 Framework
|
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
|
Bayonne2 / Common C++ 2 Framework
|
The socket port is an internal class which is attached to and then serviced by a specific SocketService "object". More...
#include <socketport.h>
Public Types | |
| enum | Family { IPV4 = AF_INET } |
| typedef enum Family | Family |
| 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 | Tos { tosLowDelay = 0, tosThroughput, tosReliability, tosMinCost, tosInvalid } |
| typedef enum Tos | Tos |
| enum | Pending { pendingInput, pendingOutput, pendingError } |
| typedef enum Pending | Pending |
Public Member Functions | |
| void | setTimer (timeout_t timeout=0) |
| Derived setTimer to notify the service thread pool of change in expected timeout. More... | |
| void | incTimer (timeout_t timeout) |
| Derived incTimer to notify the service thread pool of a change in expected timeout. More... | |
| virtual IPV4Host | getIPV4Sender (tpport_t *port=NULL) const |
| May be used to examine the origin of data waiting in the socket receive queue. More... | |
| IPV4Host | getSender (tpport_t *port=NULL) const |
| IPV4Host | getIPV4Peer (tpport_t *port=NULL) const |
| Get the host address and port of the socket this socket is connected to. More... | |
| IPV4Host | getPeer (tpport_t *port=NULL) const |
| IPV4Host | getIPV4Local (tpport_t *port=NULL) const |
| Get the local address and port number this socket is currently bound to. More... | |
| IPV4Host | getLocal (tpport_t *port=NULL) const |
| IPV4Host | getIPV4NAT (tpport_t *port=NULL) const |
| Perform NAT table lookup for this socket. More... | |
| IPV4Host | getNAT (tpport_t *port) const |
| void | setCompletion (bool immediate) |
| Used to specify blocking mode for the socket. More... | |
| Error | setLinger (bool linger) |
| Enable lingering sockets on close. More... | |
| Error | setKeepAlive (bool enable) |
| Set the keep-alive status of this socket and if keep-alive messages will be sent. More... | |
| Error | setTypeOfService (Tos service) |
| Set packet scheduling on platforms which support ip quality of service conventions. More... | |
| bool | isConnected (void) const |
| Can test to see if this socket is "connected", and hence whether a "catch" can safely call getPeer(). More... | |
| bool | isActive (void) const |
| Test to see if the socket is at least operating or if it is mearly initialized. More... | |
| bool | operator! () const |
| Operator based testing to see if a socket is currently active. More... | |
| bool | isBroadcast (void) const |
| Return if broadcast has been enabled for the specified socket. More... | |
| bool | isRouted (void) const |
| Return if socket routing is enabled. More... | |
| 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... | |
| long | getSystemError (void) const |
| const char * | getSystemErrorString (void) const |
| virtual bool | isPending (Pending pend, timeout_t timeout=TIMEOUT_INF) |
| Get the status of pending operations. More... | |
| void | decTimer (timeout_t timeout) |
| Adjust a timeout based on the current time reference value either from object creation or the last setTimer(). More... | |
| void | sleepTimer (void) |
| Sleep until the current timer expires. More... | |
| void | endTimer (void) |
| This is used to "disable" the service thread from expiring the timer object. More... | |
| timeout_t | getTimer (void) const |
| 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... | |
| timeout_t | getElapsed (void) const |
| 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 | |
| static bool | check (Family fam) |
| See if a specific protocol family is available in the current runtime environment. More... | |
Protected Types | |
| enum | State { INITIAL, AVAILABLE, BOUND, CONNECTED, CONNECTING, STREAM } |
| typedef enum State | State |
Protected Member Functions | |
| SocketPort (SocketService *svc, TCPSocket &tcp) | |
| Construct an accepted TCP socket connection from a specific bound TCP server. More... | |
| SocketPort (SocketService *svc, const IPV4Address &ia, tpport_t port) | |
| Construct a bound UDP socket for use in deriving realtime UDP streaming protocols handled by thread pool objects. More... | |
| SocketPort (SocketService *svc, const IPV4Host &ih, tpport_t port) | |
| A non-blocking constructor for outbound tcp connections. More... | |
| void | attach (SocketService *svc) |
| Attach yourself to the service pool thread object. More... | |
| virtual | ~SocketPort () |
| Disconnect the socket from the service thread pool and the remote connection. More... | |
| void | setDetectPending (bool) |
| Used to indicate if the service thread should monitor pending data for us. More... | |
| bool | getDetectPending (void) const |
| Get the current state of the DetectPending flag. More... | |
| void | setDetectOutput (bool) |
| Used to indicate if output ready monitoring should be performed by the service thread. More... | |
| bool | getDetectOutput (void) const |
| Get the current state of the DetectOutput flag. More... | |
| virtual void | expired (void) |
| Called by the service thread pool when the objects timer has expired. More... | |
| virtual void | pending (void) |
| Called by the service thread pool when input data is pending for this socket. More... | |
| virtual void | output (void) |
| Called by the service thread pool when output data is pending for this socket. More... | |
| virtual void | disconnect (void) |
| Called by the service thread pool when a disconnect has occured. More... | |
| Error | connect (const IPV4Address &ia, tpport_t port) |
| Connect a Socket Port to a known peer host. 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... | |
| 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... | |
| 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... | |
| void | endSocket (void) |
| Used as the default destructor for ending a socket. More... | |
| Error | connectError (void) |
| Used as a common handler for connection failure processing. More... | |
| Error | sendLimit (int limit=2048) |
| Set the send limit. More... | |
| Error | receiveLimit (int limit=1) |
| Set thr receive limit. More... | |
| Error | sendTimeout (timeout_t timer) |
| Set the send timeout for sending raw network data. More... | |
| 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 | receiveBuffer (unsigned size) |
| Set the protocol stack network kernel receive buffer size associated with the socket. More... | |
| Error | bufferSize (unsigned size) |
| Set the total protocol stack network kernel buffer size for both send and receive together. More... | |
| Error | setBroadcast (bool enable) |
| Set the subnet broadcast 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 | setLoopbackByFamily (bool enable, Family family=IPV4) |
| Set the multicast loopback flag for the socket. More... | |
| Error | setTimeToLiveByFamily (unsigned char ttl, Family fam=IPV4) |
| Set the multicast time to live for a multicast socket. More... | |
| Error | join (const IPV4Multicast &ia) |
| Join a multicast group. More... | |
| Error | drop (const IPV4Multicast &ia) |
| Drop membership from a multicast group. More... | |
| Error | setRouting (bool enable) |
| Set the socket routing to indicate if outgoing messages should bypass normal routing (set false). More... | |
| Error | setNoDelay (bool enable) |
| Enable/disable delaying packets (Nagle algorithm) More... | |
| ssize_t | readLine (char *buf, size_t len, timeout_t timeout=0) |
| Process a logical input line from a socket descriptor directly. More... | |
| 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... | |
| virtual ssize_t | writeData (const void *buf, size_t len, timeout_t t=0) |
| Write a block of len bytes to socket. More... | |
Protected Attributes | |
| struct { | |
| bool thrown: 1 | |
| bool broadcast: 1 | |
| bool route: 1 | |
| bool keepalive: 1 | |
| bool loopback: 1 | |
| bool multicast: 1 | |
| bool completion: 1 | |
| bool linger: 1 | |
| unsigned ttl: 8 | |
| } | flags |
| SOCKET volatile | so |
| the actual socket descriptor, in Windows, unlike posix it cannot be used as an file descriptor that way madness lies – jfc More... | |
| State volatile | state |
Static Protected Attributes | |
| static Mutex | mutex |
Private Attributes | |
| SocketPort * | next |
| SocketPort * | prev |
| SocketService * | service |
| struct timeval | porttimer |
| bool | detect_pending |
| bool | detect_output |
| bool | detect_disconnect |
Friends | |
| class | SocketService |
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.
Definition at line 81 of file socketport.h.
|
inherited |
|
inherited |
|
inherited |
|
protectedinherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
protectedinherited |
|
inherited |
|
protected |
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.
| svc | pool thread object. |
| tcp | socket object to accept. |
|
protected |
Construct a bound UDP socket for use in deriving realtime UDP streaming protocols handled by thread pool objects.
| svc | pool thread object. |
| ia | address of interface to bind. |
| port | number to bind to. |
|
protected |
A non-blocking constructor for outbound tcp connections.
To detect when the connection is established, overload SocketPort::output(). SocketPort::output() get's called by the SocketService when the connection is ready, SocketPort::disconnect() when the connect failed. at the moment you should set the socket state to "CONNECTED" when SocketPort::output() get's called for the first time.
| svc | pool thread object. |
| ih | addess to connect to. |
| port | number to connect to. |
|
protectedvirtual |
Disconnect the socket from the service thread pool and the remote connection.
|
protected |
Attach yourself to the service pool thread object.
The later version.
| svc | pool thread object |
|
protectedinherited |
Set the total protocol stack network kernel buffer size for both send and receive together.
| size | of buffer. |
|
staticinherited |
See if a specific protocol family is available in the current runtime environment.
|
protected |
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.
| ia | address of remote host or subnet. |
| port | number of remote peer(s). |
|
protectedinherited |
Used as a common handler for connection failure processing.
|
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.
| timeout | delay in milliseconds from reference. |
|
protectedvirtual |
Called by the service thread pool when a disconnect has occured.
|
protectedinherited |
Drop membership from a multicast group.
| ia | address of multicast group to drop. |
|
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.
|
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().
|
protectedinherited |
This service is used to throw all socket errors which usually occur during the socket constructor.
| error | defined socket error id. |
| err | string or message to pass. |
| systemError | the system error# that caused the error |
|
inlineprotectedinherited |
|
protectedvirtual |
Called by the service thread pool when the objects timer has expired.
Used for timed events.
|
inlineprotected |
Get the current state of the DetectOutput flag.
Definition at line 180 of file socketport.h.
|
inlineprotected |
Get the current state of the DetectPending flag.
Definition at line 168 of file socketport.h.
|
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.
|
inlineinherited |
|
inlineinherited |
Get the local address and port number this socket is currently bound to.
| port | ptr to port number on local host. |
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.
| port | ptr to NATed port number on local host. |
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.
| port | ptr to port number 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.
| port | ptr to port number of sender. |
Reimplemented in DCCPSocket.
|
inherited |
|
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.
| timeout | in milliseconds. |
|
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.
|
inlineinherited |
|
inherited |
|
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.
| pend | ready check to perform. |
| timeout | in milliseconds, inf. if not specified. |
Reimplemented in SimpleTCPStream, TCPStream, and UnixStream.
|
inlineinherited |
|
protectedinherited |
Join a multicast group.
| ia | address of multicast group to join. |
|
inherited |
Operator based testing to see if a socket is currently active.
|
protectedvirtual |
Called by the service thread pool when output data is pending for this socket.
|
inlineprotected |
Examine the content of the next packet.
This can be used to build "smart" line buffering for derived TCP classes.
| buf | pointer to packet buffer to examine. |
| len | of packet buffer to examine. |
Definition at line 253 of file socketport.h.
|
protectedvirtual |
Called by the service thread pool when input data is pending for this socket.
|
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.
| buf | pointer to byte allocation. |
| len | maximum length to read. |
| separator | separator for a particular ASCII character |
| t | timeout for pending data in milliseconds. |
|
protectedinherited |
Process a logical input line from a socket descriptor directly.
| buf | pointer to string. |
| len | maximum length to read. |
| timeout | for pending data in milliseconds. |
|
inlineprotected |
Receive a message from any host.
This is used in derived classes to build protocols.
| buf | pointer to packet buffer to receive. |
| len | of packet buffer to receive. |
Definition at line 242 of file socketport.h.
|
protectedinherited |
Set the protocol stack network kernel receive buffer size associated with the socket.
| size | of buffer in bytes. |
|
protectedinherited |
Set thr receive limit.
Receive timeout for receiving raw network data.
| timer | value in milliseconds. |
|
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.
| buf | address of buffer to send. |
| len | of bytes to send. |
Definition at line 231 of file socketport.h.
|
protectedinherited |
Set the protocol stack network kernel send buffer size associated with the socket.
| size | of buffer in bytes. |
|
protectedinherited |
Set the send limit.
Set the send timeout for sending raw network data.
| timer | value in millisec. |
|
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.
| enable | when set to true. |
|
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.
| immediate | mode specify socket I/O call blocking mode. |
|
protected |
Used to indicate if output ready monitoring should be performed by the service thread.
|
protected |
Used to indicate if the service thread should monitor pending data for us.
|
inlineprotectedinherited |
|
inherited |
Set the keep-alive status of this socket and if keep-alive messages will be sent.
| enable | keep alive messages. |
|
inherited |
Enable lingering sockets on close.
| linger | specify linger enable. |
Set the multicast loopback flag for the socket.
Loopback enables a socket to hear what it is sending.
| enable | when set to true. |
| family | of protocol. |
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.
| enable | when set to true. |
| family | of protocol. |
|
protectedinherited |
Enable/disable delaying packets (Nagle algorithm)
| enable | disable Nagle algorithm when set to true. |
|
protectedinherited |
Set the socket routing to indicate if outgoing messages should bypass normal routing (set false).
| 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.
| timeout | in milliseconds. |
Set the multicast time to live for a multicast socket.
| ttl | time to live. |
| fam | family of protocol. |
Set packet scheduling on platforms which support ip quality of service conventions.
This effects how packets in the queue are scheduled through the interface.
| service | type of service enumerated type. |
|
inherited |
Sleep until the current timer expires.
This is useful in time syncing realtime periodic tasks.
|
protectedvirtualinherited |
Write a block of len bytes to socket.
| buf | pointer to byte allocation. |
| len | maximum length to write. |
| t | timeout for pending data in milliseconds. |
|
friend |
Definition at line 98 of file socketport.h.
|
private |
Definition at line 96 of file socketport.h.
|
private |
Definition at line 95 of file socketport.h.
|
private |
Definition at line 94 of file socketport.h.
| struct { ... } Socket::flags |
|
private |
Definition at line 84 of file socketport.h.
|
private |
Definition at line 87 of file socketport.h.
|
private |
Definition at line 84 of file socketport.h.
|
private |
Definition at line 85 of file socketport.h.
|
protectedinherited |
1.8.6