VTK
|
BSD socket encapsulation. More...
#include <vtkSocket.h>
Public Types | |
typedef vtkObject | Superclass |
Public Member Functions | |
virtual int | IsA (const char *type) |
vtkSocket * | NewInstance () 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 int | IsTypeOf (const char *type) |
static vtkSocket * | SafeDownCast (vtkObjectBase *o) |
Protected Member Functions | |
virtual vtkObjectBase * | NewInstanceInternal () const |
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) |
Protected Attributes | |
int | SocketDescriptor |
Friends | |
class | vtkSocketCollection |
static int | SelectSockets (const int *sockets_to_select, int size, unsigned long msec, int *selected_index) |
vtkSocket () | |
~vtkSocket () | |
BSD socket encapsulation.
This abstract class encapsulates a BSD socket. It provides an API for basic socket operations.
Definition at line 29 of file vtkSocket.h.
typedef vtkObject vtkSocket::Superclass |
Definition at line 32 of file vtkSocket.h.
|
protected |
Selects set of sockets. Returns 0 on timeout, -1 on error. 1 on success. Selected socket's index is returned thru selected_index
|
protected |
Selects set of sockets. Returns 0 on timeout, -1 on error. 1 on success. Selected socket's index is returned thru selected_index
|
static |
|
virtual |
Reimplemented in vtkServerSocket, and vtkClientSocket.
|
static |
|
protectedvirtual |
Reimplemented in vtkServerSocket, and vtkClientSocket.
vtkSocket* vtkSocket::NewInstance | ( | ) | const |
void vtkSocket::PrintSelf | ( | ostream & | os, |
vtkIndent | indent | ||
) |
|
inline |
Check is the socket is alive.
Definition at line 37 of file vtkSocket.h.
void vtkSocket::CloseSocket | ( | ) |
Close the socket.
int vtkSocket::Send | ( | const void * | data, |
int | length | ||
) |
These methods send data over the socket. Returns 1 on success, 0 on error and raises vtkCommand::ErrorEvent.
int vtkSocket::Receive | ( | void * | data, |
int | length, | ||
int | readFully = 1 |
||
) |
Receive data from the socket. This call blocks until some data is read from the socket. When readFully is set, this call will block until all the requested data is read from the socket. 0 on error, else number of bytes read is returned. On error, vtkCommand::ErrorEvent is raised.
|
virtual |
Provides access to the internal socket descriptor. This is valid only when GetConnected() returns true.
|
static |
Selects set of sockets. Returns 0 on timeout, -1 on error. 1 on success. Selected socket's index is returned thru selected_index
|
protected |
Creates an endpoint for communication and returns the descriptor. -1 indicates error.
|
protected |
Close the socket.
|
protected |
Binds socket to a particular port. Returns 0 on success other -1 is returned.
|
protected |
Selects a socket ie. waits for it to change status. Returns 1 on success; 0 on timeout; -1 on error. msec=0 implies no timeout.
|
protected |
Accept a connection on a socket. Returns -1 on error. Otherwise the descriptor of the accepted socket.
|
protected |
Listen for connections on a socket. Returns 0 on success. -1 on error.
|
protected |
Connect to a server socket. Returns 0 on success, -1 on error.
|
protected |
Returns the port to which the socket is connected. 0 on error.
|
friend |
Definition at line 73 of file vtkSocket.h.
|
protected |
Definition at line 70 of file vtkSocket.h.