Bayonne2 / Common C++ 2 Framework
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Static Protected Attributes | Private Member Functions
TCPSession Class Referenceabstract

The TCP session is used to primarily to represent a client connection that can be managed on a seperate thread. More...

#include <socket.h>

Inheritance diagram for TCPSession:
Inheritance graph
[legend]
Collaboration diagram for TCPSession:
Collaboration graph
[legend]

Public Types

enum  Throw { throwNothing, throwObject, throwException }
 How to raise error. More...
 
typedef enum Thread::Throw Throw
 How to raise error. More...
 
enum  Cancel {
  cancelInitial =0, cancelDeferred =1, cancelImmediate, cancelDisabled,
  cancelManual, cancelDefault =cancelDeferred
}
 How work cancellation. More...
 
typedef enum Thread::Cancel Cancel
 How work cancellation. More...
 
enum  Suspend { suspendEnable, suspendDisable }
 How work suspend. More...
 
typedef enum Thread::Suspend Suspend
 How work suspend. More...
 
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

 TCPSession (const IPV4Host &host, tpport_t port, size_t size=536, int pri=0, size_t stack=0)
 Create a TCP socket that will be connected to a remote TCP server and that will execute under it's own thread. More...
 
 TCPSession (TCPSocket &server, int pri=0, size_t stack=0)
 Create a TCP socket from a bound TCP server by accepting a pending connection from that server and execute a thread for the accepted connection. More...
 
virtual ~TCPSession ()
 Make sure destruction happens through a virtual... 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...
 
ThreadgetParent (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 disconnect (void)
 Disconnect the current session and prepare for a new one. More...
 
int getSegmentSize (void)
 Get protocol segment size. More...
 
void connect (TCPSocket &server)
 Accept a connection from a TCP Server. More...
 
void setTimeout (timeout_t timer)
 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...
 
ssize_t peek (void *buf, size_t len)
 Examine contents of next waiting packet. More...
 
size_t 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 Threadget (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 (size_t 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...
 
int underflow ()
 This streambuf method is used to load the input buffer through the established tcp socket connection. More...
 
int uflow ()
 This streambuf method is used for doing unbuffered reads through the establish tcp socket connection when in interactive mode. More...
 
int overflow (int ch)
 This streambuf method is used to write the output buffer through the established tcp connection. More...
 
void connect (const IPV4Host &host, tpport_t port, unsigned mss=536)
 Create a TCP stream by connecting to a TCP socket (on a remote machine). More...
 
void connect (const char *name, unsigned mss=536)
 Connect a TCP stream to a named destination host and port number, using getaddrinfo interface if available. More...
 
std::iostream * tcp (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
 
size_t bufsize
 
Family family
 
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
 

Private Member Functions

 TCPSession (const TCPSession &rhs)
 

Detailed Description

The TCP session is used to primarily to represent a client connection that can be managed on a seperate thread.

The TCP 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.

Author
David Sugar dyfet.nosp@m.@ost.nosp@m.el.co.nosp@m.m Threaded streamable socket with non-blocking constructor.

Definition at line 1867 of file socket.h.

Member Typedef Documentation

typedef enum Thread::Cancel Thread::Cancel
inherited

How work cancellation.

typedef enum Error Socket::Error
inherited

Definition at line 163 of file socket.h.

typedef enum Family Socket::Family
inherited

Definition at line 129 of file socket.h.

typedef enum Pending Socket::Pending
inherited

Definition at line 179 of file socket.h.

typedef enum State Socket::State
protectedinherited

Definition at line 190 of file socket.h.

typedef enum Thread::Suspend Thread::Suspend
inherited

How work suspend.

typedef enum Thread::Throw Thread::Throw
inherited

How to raise error.

typedef enum Tos Socket::Tos
inherited

Definition at line 172 of file socket.h.

Member Enumeration Documentation

enum Thread::Cancel
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)

Todo:
implement
cancelDefault 

default you should use this for compatibility instead of deferred

Definition at line 1108 of file thread.h.

enum Socket::Error
inherited
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.

enum Socket::Family
inherited
Enumerator
IPV4 

Definition at line 122 of file socket.h.

enum Socket::Pending
inherited
Enumerator
pendingInput 
pendingOutput 
pendingError 

Definition at line 174 of file socket.h.

enum Socket::State
protectedinherited
Enumerator
INITIAL 
AVAILABLE 
BOUND 
CONNECTED 
CONNECTING 
STREAM 

Definition at line 182 of file socket.h.

enum Thread::Suspend
inherited

How work suspend.

Enumerator
suspendEnable 

suspend enabled

suspendDisable 

suspend disabled, Suspend do nothing

Definition at line 1122 of file thread.h.

enum Thread::Throw
inherited

How to raise error.

Enumerator
throwNothing 

continue without throwing error

throwObject 

throw object that cause error (throw this)

throwException 

throw an object relative to error

Definition at line 1099 of file thread.h.

enum Socket::Tos
inherited
Enumerator
tosLowDelay 
tosThroughput 
tosReliability 
tosMinCost 
tosInvalid 

Definition at line 165 of file socket.h.

Constructor & Destructor Documentation

TCPSession::TCPSession ( const TCPSession rhs)
private
TCPSession::TCPSession ( const IPV4Host host,
tpport_t  port,
size_t  size = 536,
int  pri = 0,
size_t  stack = 0 
)

Create a TCP socket that will be connected to a remote TCP server and that will execute under it's own thread.

Parameters
hostinternet address of remote TCP server.
portnumber of remote server.
sizeof streaming buffer.
priexecution priority relative to parent.
stackallocation needed on some platforms.
TCPSession::TCPSession ( TCPSocket server,
int  pri = 0,
size_t  stack = 0 
)

Create a TCP socket from a bound TCP server by accepting a pending connection from that server and execute a thread for the accepted connection.

Parameters
servertcp socket to accept a connection from.
priexecution priority relative to parent.
stackallocation needed on some platforms.
virtual TCPSession::~TCPSession ( )
virtual

Make sure destruction happens through a virtual...

Member Function Documentation

void TCPStream::allocate ( size_t  size)
protectedinherited

Used to allocate the buffer space needed for iostream operations.

This function is called by the constructor.

Parameters
sizeof stream buffers from constructor.
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
sizeof 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 Thread::clrParent ( void  )
inlineprotectedinherited

clear parent thread relationship.

Definition at line 1295 of file thread.h.

void TCPStream::connect ( const IPV4Host host,
tpport_t  port,
unsigned  mss = 536 
)
protectedinherited

Create a TCP stream by connecting to a TCP socket (on a remote machine).

Parameters
hostaddress of remote TCP server.
portnumber to connect.
mssmaximum segment size of streaming buffers.
void TCPStream::connect ( const char *  name,
unsigned  mss = 536 
)
protectedinherited

Connect a TCP stream to a named destination host and port number, using getaddrinfo interface if available.

Parameters
nameof host and service to connect
mssmaximum segment size of stream buffer
void TCPStream::connect ( TCPSocket server)
inherited

Accept a connection from a TCP Server.

Parameters
serversocket listening
Error Socket::connectError ( void  )
protectedinherited

Used as a common handler for connection failure processing.

Returns
correct failure code to apply.
int Thread::detach ( Semaphore start = 0)
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.

Returns
error code if execution fails.
Parameters
startoptional starting semaphore to alternately use.
void TCPStream::disconnect ( void  )
inherited

Disconnect the current session and prepare for a new one.

Error Socket::drop ( const IPV4Multicast ia)
protectedinherited

Drop membership from a multicast group.

Returns
0 (errSuccess) on success, else error code.
Parameters
iaaddress 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 TCPStream::endStream ( void  )
protectedinherited

Used to terminate the buffer space and cleanup the socket connection.

This fucntion is called by the destructor.

static Cancel Thread::enterCancel ( void  )
staticinherited

This is used to help build wrapper functions in libraries around system calls that should behave as cancellation points but don't.

Returns
saved cancel type.
Error Socket::error ( Error  error,
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
errordefined socket error id.
errstring or message to pass.
systemErrorthe 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
errstring or message to pass.

Definition at line 240 of file socket.h.

void Thread::exit ( void  )
protectedinherited

Used to properly exit from a Thread derived run() or initial() method.

Terminates execution of the current thread and calls the derived classes final() method.

static void Thread::exitCancel ( Cancel  cancel)
staticinherited

This is used to restore a cancel block.

Parameters
canceltype that was saved.
virtual void Thread::final ( void  )
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...)

Note
A thread cannot delete its own context or join itself. To make a thread that is a self running object that self-deletes, one has to detach the thread by using detach() instead of start().
See Also
exit
run

Reimplemented in ThreadQueue.

static Thread* Thread::get ( void  )
staticinherited
size_t TCPStream::getBufferSize ( void  ) const
inlineinherited

Return the size of the current stream buffering used.

Returns
size of stream buffers.

Definition at line 1853 of file socket.h.

Cancel Thread::getCancel ( void  )
inlineinherited

Used to retrieve the cancellation mode in effect for the selected thread.

Returns
cancellation mode constant.

Definition at line 1419 of file thread.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.

static Throw Thread::getException ( void  )
staticinherited

Get exception mode of the current thread.

Returns
exception mode.
virtual void* Thread::getExtended ( void  )
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().

Returns
pointer to derived class specific data.
cctid_t Thread::getId ( void  ) const
inherited

Get system thread numeric identifier.

Returns
numeric identifier of this thread.
IPV4Host Socket::getIPV4Local ( tpport_t port = NULL) const
inherited

Get the local address and port number this socket is currently bound to.

Parameters
portptr to port number on local host.
Returns
host address of interface this socket is bound to.
IPV4Host Socket::getIPV4NAT ( tpport_t port = NULL) const
inherited

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
portptr to NATed port number on local host.
Returns
NATed host address that this socket is related to.
IPV4Host Socket::getIPV4Peer ( tpport_t port = NULL) const
inherited

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
portptr to port number of remote socket.
Returns
host address of remote socket.
virtual IPV4Host Socket::getIPV4Sender ( tpport_t port = NULL) const
virtualinherited

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
portptr to port number of sender.
Returns
host address, test with "isInetAddress()".

Reimplemented in DCCPSocket.

IPV4Host Socket::getLocal ( tpport_t port = NULL) const
inlineinherited

Definition at line 539 of file socket.h.

const char* Thread::getName ( void  ) const
inlineinherited

Get the name string for this thread, to use in debug messages.

Returns
debug name.

Definition at line 1463 of file thread.h.

IPV4Host Socket::getNAT ( tpport_t port) const
inlineinherited

Definition at line 575 of file socket.h.

Thread* Thread::getParent ( void  )
inlineinherited

Gets the pointer to the Thread class which created the current thread object.

Returns
a Thread *, or "(Thread *)this" if no parent.

Definition at line 1397 of file thread.h.

IPV4Host Socket::getPeer ( tpport_t port = NULL) const
inlineinherited

Definition at line 523 of file socket.h.

int TCPStream::getSegmentSize ( void  )
inherited

Get protocol segment size.

IPV4Host Socket::getSender ( tpport_t port = NULL) const
inlineinherited

Definition at line 505 of file socket.h.

long Socket::getSystemError ( void  ) const
inlineinherited

Definition at line 678 of file socket.h.

const char* Socket::getSystemErrorString ( void  ) const
inherited
void TCPSession::initial ( void  )
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.

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.
bool Thread::isDetached ( void  ) const
inherited

Check if this thread is detached.

Returns
true if the thread is detached.
bool TCPStream::isPending ( Pending  pend,
timeout_t  timeout = TIMEOUT_INF 
)
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.

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.

bool Thread::isRunning ( void  ) const
inherited

Verifies if the thread is still running or has already been terminated but not yet deleted.

Returns
true if the thread is still executing.
bool Thread::isThread ( void  ) const
inherited

Tests to see if the current execution context is the same as the specified thread object.

Returns
true if the current context is this object.
Error Socket::join ( const IPV4Multicast ia)
protectedinherited

Join a multicast group.

Returns
0 (errSuccess) on success, else error code.
Parameters
iaaddress of multicast group to join.
void Thread::join ( void  )
inherited

Blocking call which unlocks when thread terminates.

virtual void Thread::notify ( Thread )
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.

Parameters
-the thread that has terminated.
bool Socket::operator! ( ) const
inherited

Operator based testing to see if a socket is currently active.

int TCPStream::overflow ( int  ch)
protectedinherited

This streambuf method is used to write the output buffer through the established tcp connection.

Parameters
chchar to push through.
Returns
char pushed through.
ssize_t TCPStream::peek ( void *  buf,
size_t  len 
)
inlineinherited

Examine contents of next waiting packet.

Parameters
bufpointer to packet buffer for contents.
lenof packet buffer.
Returns
number of bytes examined.

Definition at line 1845 of file socket.h.

virtual ssize_t Socket::readData ( void *  buf,
size_t  len,
char  separator = 0,
timeout_t  t = 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
bufpointer to byte allocation.
lenmaximum length to read.
separatorseparator for a particular ASCII character
ttimeout for pending data in milliseconds.
Returns
number of bytes actually read.
ssize_t Socket::readLine ( char *  buf,
size_t  len,
timeout_t  timeout = 0 
)
protectedinherited

Process a logical input line from a socket descriptor directly.

Parameters
bufpointer to string.
lenmaximum length to read.
timeoutfor pending data in milliseconds.
Returns
number of bytes actually read.
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
sizeof buffer in bytes.
Error Socket::receiveLimit ( int  limit = 1)
protectedinherited

Set thr receive limit.

Error Socket::receiveTimeout ( timeout_t  timer)
protectedinherited

Receive timeout for receiving raw network data.

Returns
errSuccess if set.
Parameters
timervalue in milliseconds.
void Thread::resume ( void  )
inherited

Resumes execution of the selected thread.

virtual void Thread::run ( void  )
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.

See Also
Initial

Implemented in SerialService, SingleThreadRTPSession< RTPDataChannel, RTCPChannel, ServiceQueue >, SocketService, ThreadQueue, and SingleRTPSessionPool.

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
sizeof buffer in bytes.
Error Socket::sendLimit ( int  limit = 2048)
protectedinherited

Set the send limit.

Error Socket::sendTimeout ( timeout_t  timer)
protectedinherited

Set the send timeout for sending raw network data.

Returns
errSuccess if set.
Parameters
timervalue 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
enablewhen set to true.
void Thread::setCancel ( Cancel  mode)
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).

Parameters
modefor cancellation of the current thread.
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
immediatemode 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
enabletrue to enable handler.

Definition at line 249 of file socket.h.

static void Thread::setException ( Throw  mode)
staticinherited

Set exception mode of the current thread.

Returns
exception mode.
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
enablekeep alive messages.
Error Socket::setLinger ( bool  linger)
inherited

Enable lingering sockets on close.

Parameters
lingerspecify linger enable.
Error Socket::setLoopbackByFamily ( bool  enable,
Family  family = IPV4 
)
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
enablewhen set to true.
familyof protocol.
Error Socket::setMulticastByFamily ( bool  enable,
Family  family = IPV4 
)
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
enablewhen set to true.
familyof protocol.
void Thread::setName ( const char *  text)
protectedinherited

Set the name of the current thread.

If the name is passed as NULL, then the default name is set (usually object pointer).

Parameters
textname to use.
Error Socket::setNoDelay ( bool  enable)
protectedinherited

Enable/disable delaying packets (Nagle algorithm)

Returns
0 on success.
Parameters
enabledisable 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
enablenormal routing when set to true.
static void Thread::setStack ( size_t  size = 0)
inlinestaticinherited

Set base stack limit before manual stack sizes have effect.

Parameters
sizestack size to set, or use 0 to clear autostack.

Definition at line 1347 of file thread.h.

void Thread::setSuspend ( Suspend  mode)
protectedinherited

Sets the thread's ability to be suspended from execution.

The thread may either have suspend enabled (suspendEnable) or disabled (suspendDisable).

Parameters
modefor suspend.
void TCPStream::setTimeout ( timeout_t  timer)
inlineinherited

Set the I/O operation timeout for socket I/O operations.

Parameters
timerto change timeout.

Definition at line 1794 of file socket.h.

Error Socket::setTimeToLiveByFamily ( unsigned char  ttl,
Family  fam = IPV4 
)
protectedinherited

Set the multicast time to live for a multicast socket.

Returns
0 (errSuccess) on success, else error code.
Parameters
ttltime to live.
famfamily 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
servicetype of service enumerated type.
static void Thread::sleep ( timeout_t  msec)
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.

Parameters
msectimeout in milliseconds.
int Thread::start ( Semaphore start = 0)
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.

Returns
error code if execution fails.
Parameters
startoptional starting semaphore to alternately use.
void Thread::suspend ( void  )
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.

void Thread::sync ( void  )
protectedinherited

Used to wait for a join or cancel, in place of explicit exit.

int TCPStream::sync ( void  )
inherited

Flushes the stream input and output buffers, writes pending output.

Returns
0 on success.
std::iostream* TCPStream::tcp ( void  )
inlineprotectedinherited

Used in derived classes to refer to the current object via it's iostream.

For example, to send a set of characters in a derived method, one might use *tcp() << "test".

Returns
stream pointer of this object.

Definition at line 1735 of file socket.h.

void Thread::terminate ( void  )
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.

bool Thread::testCancel ( void  )
protectedinherited

test a cancellation point for deferred thread cancellation.

int TCPStream::uflow ( )
protectedinherited

This streambuf method is used for doing unbuffered reads through the establish tcp socket connection when in interactive mode.

Also this method will handle proper use of buffers if not in interative mode.

Returns
char from tcp socket connection, EOF if not connected.
int TCPStream::underflow ( )
protectedinherited

This streambuf method is used to load the input buffer through the established tcp socket connection.

Returns
char from get buffer, EOF if not connected.
int TCPSession::waitConnection ( timeout_t  timeout = TIMEOUT_INF)
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().

Returns
0 if successful, -1 if timed out.
Parameters
timeoutto wait for completion in milliseconds.
virtual ssize_t Socket::writeData ( const void *  buf,
size_t  len,
timeout_t  t = 0 
)
protectedvirtualinherited

Write a block of len bytes to socket.

Parameters
bufpointer to byte allocation.
lenmaximum length to write.
ttimeout for pending data in milliseconds.
Returns
number of bytes actually written.
static void Thread::yield ( void  )
staticinherited

Yields the current thread's CPU time slice to allow another thread to begin immediate execution.

Field Documentation

bool Socket::broadcast
inherited

Definition at line 206 of file socket.h.

size_t TCPStream::bufsize
protectedinherited

Definition at line 1643 of file socket.h.

bool Socket::completion
inherited

Definition at line 211 of file socket.h.

Family TCPStream::family
protectedinherited

Definition at line 1644 of file socket.h.

struct { ... } Socket::flags
char* TCPStream::gbuf
protectedinherited

Definition at line 1645 of file socket.h.

bool Socket::keepalive
inherited

Definition at line 208 of file socket.h.

bool Socket::linger
inherited

Definition at line 212 of file socket.h.

bool Socket::loopback
inherited

Definition at line 209 of file socket.h.

bool Socket::multicast
inherited

Definition at line 210 of file socket.h.

Mutex Socket::mutex
staticprotectedinherited

Definition at line 202 of file socket.h.

char * TCPStream::pbuf
protectedinherited

Definition at line 1645 of file socket.h.

bool Socket::route
inherited

Definition at line 207 of file socket.h.

SOCKET volatile Socket::so
protectedinherited

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

Definition at line 222 of file socket.h.

bool Socket::thrown
inherited

Definition at line 205 of file socket.h.

timeout_t TCPStream::timeout
protectedinherited

Definition at line 1642 of file socket.h.

unsigned Socket::ttl
inherited

Definition at line 213 of file socket.h.


The documentation for this class was generated from the following file: