VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
vtkClientSocket Class Reference

Encapsulates a client socket. More...

#include <vtkClientSocket.h>

Inheritance diagram for vtkClientSocket:
[legend]
Collaboration diagram for vtkClientSocket:
[legend]

Public Types

typedef vtkSocket Superclass
 
- Public Types inherited from vtkSocket
typedef vtkObject Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkClientSocketNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
int ConnectToServer (const char *hostname, int port)
 
virtual bool GetConnectingSide ()
 
- Public Member Functions inherited from vtkSocket
vtkSocketNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
int GetConnected ()
 
void CloseSocket ()
 
int Send (const void *data, int length)
 
int Receive (void *data, int length, int readFully=1)
 
virtual int GetSocketDescriptor ()
 

Static Public Member Functions

static vtkClientSocketNew ()
 
static int IsTypeOf (const char *type)
 
static vtkClientSocketSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkSocket
static int IsTypeOf (const char *type)
 
static vtkSocketSafeDownCast (vtkObjectBase *o)
 
static int SelectSockets (const int *sockets_to_select, int size, unsigned long msec, int *selected_index)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkClientSocket ()
 
 ~vtkClientSocket ()
 
virtual void SetConnectingSide (bool)
 
- Protected Member Functions inherited from vtkSocket
int CreateSocket ()
 
void CloseSocket (int socketdescriptor)
 
int BindSocket (int socketdescriptor, int port)
 
int SelectSocket (int socketdescriptor, unsigned long msec)
 
int Accept (int socketdescriptor)
 
int Listen (int socketdescriptor)
 
int Connect (int socketdescriptor, const char *hostname, int port)
 
int GetPort (int socketdescriptor)
 
 vtkSocket ()
 
 ~vtkSocket ()
 

Protected Attributes

bool ConnectingSide
 
- Protected Attributes inherited from vtkSocket
int SocketDescriptor
 

Friends

class vtkServerSocket
 

Detailed Description

Encapsulates a client socket.

Definition at line 26 of file vtkClientSocket.h.

Member Typedef Documentation

Definition at line 30 of file vtkClientSocket.h.

Constructor & Destructor Documentation

vtkClientSocket::vtkClientSocket ( )
protected
vtkClientSocket::~vtkClientSocket ( )
protected

Member Function Documentation

static vtkClientSocket* vtkClientSocket::New ( )
static
static int vtkClientSocket::IsTypeOf ( const char *  type)
static
virtual int vtkClientSocket::IsA ( const char *  type)
virtual

Reimplemented from vtkSocket.

static vtkClientSocket* vtkClientSocket::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkClientSocket::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkSocket.

vtkClientSocket* vtkClientSocket::NewInstance ( ) const
void vtkClientSocket::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
int vtkClientSocket::ConnectToServer ( const char *  hostname,
int  port 
)

Connects to host. Returns 0 on success, -1 on error.

virtual bool vtkClientSocket::GetConnectingSide ( )
virtual

Returns if the socket is on the connecting side (the side that requests a ConnectToServer() or on the connected side (the side that was waiting for the client to connect). This is used to disambiguate the two ends of a socket connection.

virtual void vtkClientSocket::SetConnectingSide ( bool  )
protectedvirtual

Friends And Related Function Documentation

friend class vtkServerSocket
friend

Definition at line 51 of file vtkClientSocket.h.

Member Data Documentation

bool vtkClientSocket::ConnectingSide
protected

Definition at line 49 of file vtkClientSocket.h.


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