vtkSocket Class Reference
#include <vtkSocket.h>
Detailed Description
BSD socket encapsulation.This abstract class encapsulates a BSD socket. It provides an API for basic socket operations.
Definition at line 28 of file vtkSocket.h.
Public Types | |
| typedef vtkObject | Superclass |
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| 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) |
Static Public Member Functions | |
| static int | IsTypeOf (const char *type) |
| static vtkSocket * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
| vtkSocket () | |
| ~vtkSocket () | |
| virtual int | GetSocketDescriptor () |
| 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) |
Static Protected Member Functions | |
| static int | SelectSockets (const int *sockets_to_select, int size, unsigned long msec, int *selected_index) |
Protected Attributes | |
| int | SocketDescriptor |
Friends | |
| class | vtkSocketCollection |
Member Typedef Documentation
| typedef vtkObject vtkSocket::Superclass |
Reimplemented from vtkObject.
Reimplemented in vtkClientSocket, and vtkServerSocket.
Definition at line 31 of file vtkSocket.h.
Constructor & Destructor Documentation
| vtkSocket::vtkSocket | ( | ) | [protected] |
| vtkSocket::~vtkSocket | ( | ) | [protected] |
Member Function Documentation
| virtual const char* vtkSocket::GetClassName | ( | ) | [virtual] |
| static int vtkSocket::IsTypeOf | ( | const char * | name | ) | [static] |
Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkObject.
Reimplemented in vtkClientSocket, and vtkServerSocket.
| virtual int vtkSocket::IsA | ( | const char * | name | ) | [virtual] |
Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkObject.
Reimplemented in vtkClientSocket, and vtkServerSocket.
| void vtkSocket::PrintSelf | ( | ostream & | os, | |
| vtkIndent | indent | |||
| ) | [virtual] |
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 vtkObject.
Reimplemented in vtkClientSocket, and vtkServerSocket.
| int vtkSocket::GetConnected | ( | ) | [inline] |
Check is the socket is alive.
Definition at line 36 of file vtkSocket.h.
| void vtkSocket::CloseSocket | ( | ) | [inline] |
Close the socket.
Definition at line 39 of file vtkSocket.h.
| 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 int vtkSocket::GetSocketDescriptor | ( | ) | [protected, virtual] |
| int vtkSocket::CreateSocket | ( | ) | [protected] |
Creates an endpoint for communication and returns the descriptor. -1 indicates error.
| void vtkSocket::CloseSocket | ( | int | socketdescriptor | ) | [protected] |
Close the socket.
| int vtkSocket::BindSocket | ( | int | socketdescriptor, | |
| int | port | |||
| ) | [protected] |
Binds socket to a particular port. Returns 0 on success other -1 is returned.
| int vtkSocket::SelectSocket | ( | int | socketdescriptor, | |
| unsigned long | msec | |||
| ) | [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.
| int vtkSocket::Accept | ( | int | socketdescriptor | ) | [protected] |
Accept a connection on a socket. Returns -1 on error. Otherwise the descriptor of the accepted socket.
| int vtkSocket::Listen | ( | int | socketdescriptor | ) | [protected] |
Listen for connections on a socket. Returns 0 on success. -1 on error.
| int vtkSocket::Connect | ( | int | socketdescriptor, | |
| const char * | hostname, | |||
| int | port | |||
| ) | [protected] |
Connect to a server socket. Returns 0 on success, -1 on error.
| int vtkSocket::GetPort | ( | int | socketdescriptor | ) | [protected] |
Returns the port to which the socket is connected. 0 on error.
| static int vtkSocket::SelectSockets | ( | const int * | sockets_to_select, | |
| int | size, | |||
| unsigned long | msec, | |||
| int * | selected_index | |||
| ) | [static, protected] |
Selects set of sockets. Returns 0 on timeout, -1 on error. 1 on success. Selected socket's index is returned thru selected_index
Friends And Related Function Documentation
friend class vtkSocketCollection [friend] |
Definition at line 58 of file vtkSocket.h.
Member Data Documentation
int vtkSocket::SocketDescriptor [protected] |
Definition at line 57 of file vtkSocket.h.
The documentation for this class was generated from the following file:
- dox/Common/vtkSocket.h
