Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members  
igtl::Socket Class Reference

#include <igtlSocket.h>

Inheritance diagram for igtl::Socket:
igtl::Object igtl::LightObject igtl::ClientSocket igtl::ServerSocket

Public Types

typedef SmartPointer< const SelfConstPointer
typedef SmartPointer< SelfPointer
typedef Socket Self
typedef Object Superclass

Public Member Functions

void CloseSocket ()
virtual LightObject::Pointer CreateAnother () const
virtual void DebugOff () const
virtual void DebugOn () const
virtual void Delete ()
int GetConnected ()
bool GetDebug () const
virtual const char * GetNameOfClass () const
virtual int GetReferenceCount () const
 igtlTypeMacro (Object, LightObject)
void Print (std::ostream &os) const
int Receive (void *data, int length, int readFully=1)
virtual void Register () const
int Send (const void *data, int length)
void SetDebug (bool debugFlag) const
virtual void SetReferenceCount (int)
int Skip (int length, int skipFully=1)
virtual void UnRegister () const

Static Public Member Functions

static void BreakOnError ()
static Pointer New ()
static void SetGlobalWarningDisplay (bool flag)
static bool GetGlobalWarningDisplay ()
static void GlobalWarningDisplayOn ()
static void GlobalWarningDisplayOff ()

Protected Member Functions

int Accept (int socketdescriptor)
int BindSocket (int socketdescriptor, int port)
void CloseSocket (int socketdescriptor)
int Connect (int socketdescriptor, const char *hostname, int port)
int CreateSocket ()
int GetPort (int socketdescriptor)
 igtlGetMacro (SocketDescriptor, int)
int Listen (int socketdescriptor)
void PrintSelf (std::ostream &os) const
int SelectSocket (int socketdescriptor, unsigned long msec)
 Socket ()
 ~Socket ()
virtual void PrintHeader (std::ostream &os) const
virtual void PrintTrailer (std::ostream &os) const

Static Protected Member Functions

static int SelectSockets (const int *sockets_to_select, int size, unsigned long msec, int *selected_index)

Protected Attributes

volatile int m_ReferenceCount
SimpleFastMutexLock m_ReferenceCountLock
int m_SocketDescriptor

Friends

class vtkSocketCollection

Detailed Description

Definition at line 56 of file igtlSocket.h.

Member Typedef Documentation

Definition at line 62 of file igtlSocket.h.

Definition at line 61 of file igtlSocket.h.

Definition at line 59 of file igtlSocket.h.

Definition at line 60 of file igtlSocket.h.

Constructor & Destructor Documentation

igtl::Socket::Socket ( )
protected
igtl::Socket::~Socket ( )
protected

Member Function Documentation

int igtl::Socket::Accept ( int  socketdescriptor)
protected
int igtl::Socket::BindSocket ( int  socketdescriptor,
int  port 
)
protected
static void igtl::LightObject::BreakOnError ( )
staticinherited

This method is called when igtlExceptionMacro executes. It allows the debugger to break on error.

void igtl::Socket::CloseSocket ( )
inline

Definition at line 76 of file igtlSocket.h.

References CloseSocket().

Referenced by CloseSocket().

void igtl::Socket::CloseSocket ( int  socketdescriptor)
protected
int igtl::Socket::Connect ( int  socketdescriptor,
const char *  hostname,
int  port 
)
protected
virtual LightObject::Pointer igtl::Object::CreateAnother ( ) const
virtualinherited

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from igtl::LightObject.

int igtl::Socket::CreateSocket ( )
protected
virtual void igtl::Object::DebugOff ( ) const
virtualinherited

Turn debugging output off.

virtual void igtl::Object::DebugOn ( ) const
virtualinherited

Turn debugging output on.

virtual void igtl::LightObject::Delete ( )
virtualinherited

Delete an igtl object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

int igtl::Socket::GetConnected ( )
inline

Definition at line 72 of file igtlSocket.h.

bool igtl::Object::GetDebug ( ) const
inherited

Get the value of the debug flag.

static bool igtl::Object::GetGlobalWarningDisplay ( )
staticinherited

This is a global flag that controls whether any debug, warning or error messages are displayed.

virtual const char* igtl::LightObject::GetNameOfClass ( ) const
inlinevirtualinherited

Return the name of this class as a string. Used by the object factory (implemented in New()) to instantiate objects of a named type. Also used for debugging and other output information.

Definition at line 86 of file igtlLightObject.h.

int igtl::Socket::GetPort ( int  socketdescriptor)
protected
virtual int igtl::LightObject::GetReferenceCount ( ) const
inlinevirtualinherited

Gets the reference count on this object.

Definition at line 112 of file igtlLightObject.h.

static void igtl::Object::GlobalWarningDisplayOff ( )
inlinestaticinherited

This is a global flag that controls whether any debug, warning or error messages are displayed.

Definition at line 118 of file igtlObject.h.

References igtl::Object::SetGlobalWarningDisplay().

static void igtl::Object::GlobalWarningDisplayOn ( )
inlinestaticinherited

This is a global flag that controls whether any debug, warning or error messages are displayed.

Definition at line 116 of file igtlObject.h.

References igtl::Object::SetGlobalWarningDisplay().

igtl::Socket::igtlGetMacro ( SocketDescriptor  ,
int   
)
protected
igtl::Object::igtlTypeMacro ( Object  ,
LightObject   
)
inherited

Standard part of all igtl objects.

int igtl::Socket::Listen ( int  socketdescriptor)
protected
static Pointer igtl::Object::New ( )
staticinherited

Method for creation through the object factory.

Reimplemented from igtl::LightObject.

Referenced by igtl::CreateObjectFunction< T >::CreateObject().

void igtl::LightObject::Print ( std::ostream &  os) const
inherited

Cause the object to print itself out.

virtual void igtl::LightObject::PrintHeader ( std::ostream &  os) const
protectedvirtualinherited

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

void igtl::Socket::PrintSelf ( std::ostream &  os) const
protectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from igtl::Object.

Reimplemented in igtl::ServerSocket, and igtl::ClientSocket.

virtual void igtl::LightObject::PrintTrailer ( std::ostream &  os) const
protectedvirtualinherited

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

int igtl::Socket::Receive ( void *  data,
int  length,
int  readFully = 1 
)
virtual void igtl::Object::Register ( ) const
virtualinherited

Return this objects modified time. Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. Increase the reference count (mark as used by another object).

Reimplemented from igtl::LightObject.

int igtl::Socket::SelectSocket ( int  socketdescriptor,
unsigned long  msec 
)
protected
static int igtl::Socket::SelectSockets ( const int *  sockets_to_select,
int  size,
unsigned long  msec,
int *  selected_index 
)
staticprotected
int igtl::Socket::Send ( const void *  data,
int  length 
)
void igtl::Object::SetDebug ( bool  debugFlag) const
inherited

Set the value of the debug flag. A non-zero value turns debugging on.

static void igtl::Object::SetGlobalWarningDisplay ( bool  flag)
staticinherited

This is a global flag that controls whether any debug, warning or error messages are displayed.

Referenced by igtl::Object::GlobalWarningDisplayOff(), and igtl::Object::GlobalWarningDisplayOn().

virtual void igtl::Object::SetReferenceCount ( int  )
virtualinherited

Sets the reference count (use with care)

Reimplemented from igtl::LightObject.

int igtl::Socket::Skip ( int  length,
int  skipFully = 1 
)
virtual void igtl::Object::UnRegister ( ) const
virtualinherited

Decrease the reference count (release by another object).

Reimplemented from igtl::LightObject.

Friends And Related Function Documentation

friend class vtkSocketCollection
friend

Definition at line 110 of file igtlSocket.h.

Member Data Documentation

volatile int igtl::LightObject::m_ReferenceCount
mutableprotectedinherited

Number of uses of this object by other objects.

Definition at line 133 of file igtlLightObject.h.

SimpleFastMutexLock igtl::LightObject::m_ReferenceCountLock
mutableprotectedinherited

Mutex lock to protect modification to the reference count

Definition at line 136 of file igtlLightObject.h.

int igtl::Socket::m_SocketDescriptor
protected

Definition at line 106 of file igtlSocket.h.


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

Generated at Thu Mar 20 2014 16:32:07 for OpenIGTLink by doxygen 1.8.1.2 written by Dimitri van Heesch, © 1997-2000