|
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 Unix domain session is used to primarily to represent a client connection that can be managed on a seperate thread. More...
#include <unix.h>
Public Member Functions | |
| UnixSession (const char *pathname, int size=512, int pri=0, int stack=0) | |
| Create a Unix domain socket that will be connected to a local server server and that will execute under it's own thread. More... | |
| UnixSession (UnixSocket &server, int size=512, int pri=0, int stack=0) | |
| Create a Unix domain socket from a bound Unix domain server by accepting a pending connection from that server and execute a thread for the accepted connection. More... | |
| virtual | ~UnixSession () |
| Virtual destructor. More... | |
| int | start (Semaphore *start=0) |
| When a new thread is created, it does not begin immediate execution. More... | |
| int | detach (Semaphore *start=0) |
| Start a new thread as "detached". More... | |
| Thread * | getParent (void) |
| Gets the pointer to the Thread class which created the current thread object. More... | |
| void | suspend (void) |
| Suspends execution of the selected thread. More... | |
| void | resume (void) |
| Resumes execution of the selected thread. More... | |
| Cancel | getCancel (void) |
| Used to retrieve the cancellation mode in effect for the selected thread. More... | |
| bool | isRunning (void) const |
| Verifies if the thread is still running or has already been terminated but not yet deleted. More... | |
| bool | isDetached (void) const |
| Check if this thread is detached. More... | |
| void | join (void) |
| Blocking call which unlocks when thread terminates. More... | |
| bool | isThread (void) const |
| Tests to see if the current execution context is the same as the specified thread object. More... | |
| cctid_t | getId (void) const |
| Get system thread numeric identifier. More... | |
| const char * | getName (void) const |
| Get the name string for this thread, to use in debug messages. More... | |
| void | setTimeout (timeout_t to) |
| Set the I/O operation timeout for socket I/O operations. More... | |
| int | sync (void) |
| Flushes the stream input and output buffers, writes pending output. More... | |
| bool | isPending (Pending pend, timeout_t timeout=TIMEOUT_INF) |
| Get the status of pending stream data. More... | |
| int | getBufferSize (void) const |
| Return the size of the current stream buffering used. 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 |
Static Public Member Functions | |
| static Thread * | get (void) |
| static void | setStack (size_t size=0) |
| Set base stack limit before manual stack sizes have effect. More... | |
| static void | sleep (timeout_t msec) |
| A thread-safe sleep call. More... | |
| static void | yield (void) |
| Yields the current thread's CPU time slice to allow another thread to begin immediate execution. More... | |
| static Throw | getException (void) |
| Get exception mode of the current thread. More... | |
| static void | setException (Throw mode) |
| Set exception mode of the current thread. More... | |
| static Cancel | enterCancel (void) |
| This is used to help build wrapper functions in libraries around system calls that should behave as cancellation points but don't. More... | |
| static void | exitCancel (Cancel cancel) |
| This is used to restore a cancel block. More... | |
| 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 | |
| int | waitConnection (timeout_t timeout=TIMEOUT_INF) |
| Normally called during the thread Initial() method by default, this will wait for the socket connection to complete when connecting to a remote socket. More... | |
| void | initial (void) |
| The initial method is used to esablish a connection when delayed completion is used. More... | |
| void | setName (const char *text) |
| Set the name of the current thread. More... | |
| virtual void | run (void)=0 |
| All threads execute by deriving the Run method of Thread. More... | |
| virtual void | final (void) |
| A thread that is self terminating, either by invoking exit() or leaving it's run(), will have this method called. More... | |
| virtual void * | getExtended (void) |
| Since getParent() and getThread() only refer to an object of the Thread "base" type, this virtual method can be replaced in a derived class with something that returns data specific to the derived class that can still be accessed through the pointer returned by getParent() and getThread(). More... | |
| virtual void | notify (Thread *) |
| When a thread terminates, it now sends a notification message to the parent thread which created it. More... | |
| void | exit (void) |
| Used to properly exit from a Thread derived run() or initial() method. More... | |
| void | sync (void) |
| Used to wait for a join or cancel, in place of explicit exit. More... | |
| bool | testCancel (void) |
| test a cancellation point for deferred thread cancellation. More... | |
| void | setCancel (Cancel mode) |
| Sets thread cancellation mode. More... | |
| void | setSuspend (Suspend mode) |
| Sets the thread's ability to be suspended from execution. More... | |
| void | terminate (void) |
| Used by another thread to terminate the current thread. More... | |
| void | clrParent (void) |
| clear parent thread relationship. More... | |
| void | allocate (int size) |
| Used to allocate the buffer space needed for iostream operations. More... | |
| void | endStream (void) |
| Used to terminate the buffer space and cleanup the socket connection. More... | |
| virtual int | underflow (void) |
| This streambuf method is used to load the input buffer through the established unix domain socket connection. More... | |
| int | uflow (void) |
| This streambuf method is used for doing unbuffered reads through the established unix domain socket connection when in interactive mode. More... | |
| int | overflow (int ch) |
| This streambuf method is used to write the output buffer through the established unix domain connection. More... | |
| void | connect (const char *pathname, int size) |
| Create a Unix domain stream by connecting to a Unix domain socket. More... | |
| std::iostream * | unixstr (void) |
| Used in derived classes to refer to the current object via it's iostream. 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 | |
| timeout_t | timeout |
| int | bufsize |
| char * | gbuf |
| char * | pbuf |
| 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 |
The Unix domain session is used to primarily to represent a client connection that can be managed on a seperate thread.
The Unix domain session also supports a non-blocking connection scheme which prevents blocking during the constructor and moving the process of completing a connection into the thread that executes for the session.
|
inherited |
How work cancellation.
|
inherited |
|
inherited |
|
inherited |
|
protectedinherited |
|
inherited |
How work suspend.
|
inherited |
How to raise error.
|
inherited |
|
inherited |
How work cancellation.
| Enumerator | |
|---|---|
| cancelInitial |
used internally, do not use |
| cancelDeferred |
exit thread on cancellation pointsuch as yield |
| cancelImmediate |
exit befor cancellation |
| cancelDisabled |
ignore cancellation |
| cancelManual |
unimplemented (working in progress)
|
| cancelDefault |
default you should use this for compatibility instead of deferred |
|
inherited |
|
inherited |
|
inherited |
|
protectedinherited |
|
inherited |
|
inherited |
|
inherited |
| UnixSession::UnixSession | ( | const char * | pathname, |
| int | size = 512, |
||
| int | pri = 0, |
||
| int | stack = 0 |
||
| ) |
Create a Unix domain socket that will be connected to a local server server and that will execute under it's own thread.
| pathname | path to socket |
| size | of streaming buffer. |
| pri | execution priority relative to parent. |
| stack | allocation needed on some platforms. |
| UnixSession::UnixSession | ( | UnixSocket & | server, |
| int | size = 512, |
||
| int | pri = 0, |
||
| int | stack = 0 |
||
| ) |
Create a Unix domain socket from a bound Unix domain server by accepting a pending connection from that server and execute a thread for the accepted connection.
| server | unix domain socket to accept a connection from. |
| size | of streaming buffer. |
| pri | execution priority relative to parent. |
| stack | allocation needed on some platforms. |
|
virtual |
Virtual destructor.
|
protectedinherited |
Used to allocate the buffer space needed for iostream operations.
This function is called by the constructor.
| size | of stream buffers from constructor. |
|
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.
|
inlineprotectedinherited |
|
protectedinherited |
Create a Unix domain stream by connecting to a Unix domain socket.
| pathname | path to socket |
| size | of streaming input and output buffers. |
|
protectedinherited |
Used as a common handler for connection failure processing.
|
inherited |
Start a new thread as "detached".
This is an alternative start() method that resolves some issues with later glibc implimentations which incorrectly impliment self-detach.
| start | optional starting semaphore to alternately use. |
|
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.
|
protectedinherited |
Used to terminate the buffer space and cleanup the socket connection.
This fucntion is called by the destructor.
|
staticinherited |
This is used to help build wrapper functions in libraries around system calls that should behave as cancellation points but don't.
|
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 |
|
protectedinherited |
|
staticinherited |
This is used to restore a cancel block.
| cancel | type that was saved. |
|
protectedvirtualinherited |
A thread that is self terminating, either by invoking exit() or leaving it's run(), will have this method called.
It can be used to self delete the current object assuming the object was created with new on the heap rather than stack local, hence one may often see final defined as "delete this" in a derived thread class. A final method, while running, cannot be terminated or cancelled by another thread. Final is called for all cancellation type (even immediate).
You can safe delete thread ("delete this") class on final, but you should exit ASAP (or do not try to call CommonC++ methods...)
Reimplemented in ThreadQueue.
|
staticinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
staticinherited |
Get exception mode of the current thread.
|
protectedvirtualinherited |
Since getParent() and getThread() only refer to an object of the Thread "base" type, this virtual method can be replaced in a derived class with something that returns data specific to the derived class that can still be accessed through the pointer returned by getParent() and getThread().
|
inherited |
Get system thread numeric identifier.
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.
|
inlineinherited |
|
inlineinherited |
|
inherited |
|
protectedvirtual |
The initial method is used to esablish a connection when delayed completion is used.
This assures the constructor terminates without having to wait for a connection request to complete.
Reimplemented from Thread.
|
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 |
|
inherited |
Check if this thread is detached.
|
virtualinherited |
Get the status of pending stream data.
This can be used to examine if input or output is waiting, or if an error or disconnect has occured on the stream. If a read buffer contains data then input is ready and if write buffer contains data it is first flushed and then checked.
Reimplemented from Socket.
|
inlineinherited |
|
inherited |
Verifies if the thread is still running or has already been terminated but not yet deleted.
|
inherited |
Tests to see if the current execution context is the same as the specified thread object.
|
protectedinherited |
Join a multicast group.
| ia | address of multicast group to join. |
|
inherited |
Blocking call which unlocks when thread terminates.
|
protectedvirtualinherited |
When a thread terminates, it now sends a notification message to the parent thread which created it.
The actual use of this notification is left to be defined in a derived class.
| - | the thread that has terminated. |
|
inherited |
Operator based testing to see if a socket is currently active.
|
protectedinherited |
This streambuf method is used to write the output buffer through the established unix domain connection.
| ch | char to push through. |
|
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. |
|
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. |
|
inherited |
Resumes execution of the selected thread.
|
protectedpure virtualinherited |
All threads execute by deriving the Run method of Thread.
This method is called after Initial to begin normal operation of the thread. If the method terminates, then the thread will also terminate after notifying it's parent and calling it's Final() method.
Implemented in SerialService, SingleThreadRTPSession< RTPDataChannel, RTCPChannel, ServiceQueue >, SocketService, ThreadQueue, and SingleRTPSessionPool.
|
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. |
|
protectedinherited |
Sets thread cancellation mode.
Threads can either be set immune to termination (cancelDisabled), can be set to terminate when reaching specific "thread cancellation points" (cancelDeferred) or immediately when Terminate is requested (cancelImmediate).
| mode | for cancellation of the current thread. |
|
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. |
|
inlineprotectedinherited |
|
staticinherited |
Set exception mode of the current thread.
|
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 |
Set the name of the current thread.
If the name is passed as NULL, then the default name is set (usually object pointer).
| text | name to use. |
|
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. |
|
inlinestaticinherited |
|
protectedinherited |
Sets the thread's ability to be suspended from execution.
The thread may either have suspend enabled (suspendEnable) or disabled (suspendDisable).
| mode | for suspend. |
|
inlineinherited |
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. |
|
staticinherited |
A thread-safe sleep call.
On most Posix systems, "sleep()" is implimented with SIGALRM making it unusable from multipe threads. Pthread libraries often define an alternate "sleep" handler such as usleep(), nanosleep(), or nap(), that is thread safe, and also offers a higher timer resolution.
| msec | timeout in milliseconds. |
|
inherited |
When a new thread is created, it does not begin immediate execution.
This is because the derived class virtual tables are not properly loaded at the time the C++ object is created within the constructor itself, at least in some compiler/system combinations. The thread can either be told to wait for an external semaphore, or it can be started directly after the constructor completes by calling the start() method.
| start | optional starting semaphore to alternately use. |
|
inherited |
Suspends execution of the selected thread.
Pthreads do not normally support suspendable threads, so the behavior is simulated with signals. On systems such as Linux that define threads as processes, SIGSTOP and SIGCONT may be used.
|
inherited |
Flushes the stream input and output buffers, writes pending output.
|
protectedinherited |
Used to wait for a join or cancel, in place of explicit exit.
|
protectedinherited |
Used by another thread to terminate the current thread.
Termination actually occurs based on the current setCancel() mode. When the current thread does terminate, control is returned to the requesting thread. terminate() should always be called at the start of any destructor of a class derived from Thread to assure the remaining part of the destructor is called without the thread still executing.
|
protectedinherited |
test a cancellation point for deferred thread cancellation.
|
protectedinherited |
This streambuf method is used for doing unbuffered reads through the established unix domain socket connection when in interactive mode.
Also this method will handle proper use of buffers if not in interative mode.
|
protectedvirtualinherited |
This streambuf method is used to load the input buffer through the established unix domain socket connection.
|
inlineprotectedinherited |
|
protected |
Normally called during the thread Initial() method by default, this will wait for the socket connection to complete when connecting to a remote socket.
One might wish to use setCompletion() to change the socket back to blocking I/O calls after the connection completes. To implement the session one must create a derived class which implements Run().
| timeout | to wait for completion in milliseconds. |
|
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. |
|
staticinherited |
Yields the current thread's CPU time slice to allow another thread to begin immediate execution.
| struct { ... } Socket::flags |
|
protectedinherited |
1.8.6