ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkSocket Class Reference

vtkSocket - BSD socket encapsulation. More...

Inheritance diagram for Kitware.VTK.vtkSocket:
[legend]
Collaboration diagram for Kitware.VTK.vtkSocket:
[legend]

List of all members.

Public Member Functions

 vtkSocket (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
void CloseSocket ()
 Close the socket.
int GetConnected ()
virtual int GetSocketDescriptor ()
 Provides access to the internal socket descriptor. This is valid only when GetConnected() returns true.
override int IsA (string type)
 Undocumented Block.
new vtkSocket NewInstance ()
 Undocumented Block.
int Receive (IntPtr data, int length, int readFully)
 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.
int Send (IntPtr data, int length)

Static Public Member Functions

static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkSocket SafeDownCast (vtkObjectBase o)
 Undocumented Block.
static int SelectSockets (IntPtr sockets_to_select, int size, uint msec, IntPtr selected_index)
 Selects set of sockets. Returns 0 on timeout, -1 on error. 1 on success. Selected socket's index is returned thru selected_index.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkSocket"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "9vtkSocket"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Private Member Functions

static internal void vtkSocket_CloseSocket_01 (HandleRef pThis)
static internal int vtkSocket_GetConnected_02 (HandleRef pThis)
static internal int vtkSocket_GetSocketDescriptor_03 (HandleRef pThis)
static internal int vtkSocket_IsA_04 (HandleRef pThis, string type)
static internal int vtkSocket_IsTypeOf_05 (string type)
static internal IntPtr vtkSocket_NewInstance_06 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkSocket_Receive_07 (HandleRef pThis, IntPtr data, int length, int readFully)
static internal IntPtr vtkSocket_SafeDownCast_08 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkSocket_SelectSockets_09 (IntPtr sockets_to_select, int size, uint msec, IntPtr selected_index)
static internal int vtkSocket_Send_10 (HandleRef pThis, IntPtr data, int length)

Static Private Member Functions

static vtkSocket ()
 Automatically generated type registration mechanics.

Detailed Description

vtkSocket - BSD socket encapsulation.

Description This abstract class encapsulates a BSD socket. It provides an API for basic socket operations.


Constructor & Destructor Documentation

static Kitware.VTK.vtkSocket.vtkSocket ( ) [static, private]

Automatically generated type registration mechanics.

Kitware.VTK.vtkSocket.vtkSocket ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.


Member Function Documentation

Close the socket.

override void Kitware.VTK.vtkSocket.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkServerSocket, and Kitware.VTK.vtkClientSocket.

----- Status API ---- Check is the socket is alive.

virtual int Kitware.VTK.vtkSocket.GetSocketDescriptor ( ) [virtual]

Provides access to the internal socket descriptor. This is valid only when GetConnected() returns true.

override int Kitware.VTK.vtkSocket.IsA ( string  type) [virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkServerSocket, and Kitware.VTK.vtkClientSocket.

static new int Kitware.VTK.vtkSocket.IsTypeOf ( string  type) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkServerSocket, and Kitware.VTK.vtkClientSocket.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkServerSocket, and Kitware.VTK.vtkClientSocket.

int Kitware.VTK.vtkSocket.Receive ( IntPtr  data,
int  length,
int  readFully 
)

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.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkServerSocket, and Kitware.VTK.vtkClientSocket.

Here is the call graph for this function:

static int Kitware.VTK.vtkSocket.SelectSockets ( IntPtr  sockets_to_select,
int  size,
uint  msec,
IntPtr  selected_index 
) [static]

Selects set of sockets. Returns 0 on timeout, -1 on error. 1 on success. Selected socket's index is returned thru selected_index.

int Kitware.VTK.vtkSocket.Send ( IntPtr  data,
int  length 
)

------ Communication API --- These methods send data over the socket. Returns 1 on success, 0 on error and raises vtkCommand::ErrorEvent.

static internal void Kitware.VTK.vtkSocket.vtkSocket_CloseSocket_01 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkSocket.vtkSocket_GetConnected_02 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkSocket.vtkSocket_GetSocketDescriptor_03 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkSocket.vtkSocket_IsA_04 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkSocket.vtkSocket_IsTypeOf_05 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkSocket.vtkSocket_NewInstance_06 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkSocket.vtkSocket_Receive_07 ( HandleRef  pThis,
IntPtr  data,
int  length,
int  readFully 
) [private]
static internal IntPtr Kitware.VTK.vtkSocket.vtkSocket_SafeDownCast_08 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkSocket.vtkSocket_SelectSockets_09 ( IntPtr  sockets_to_select,
int  size,
uint  msec,
IntPtr  selected_index 
) [private]
static internal int Kitware.VTK.vtkSocket.vtkSocket_Send_10 ( HandleRef  pThis,
IntPtr  data,
int  length 
) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkSocket.MRClassNameKey = "9vtkSocket" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkServerSocket, and Kitware.VTK.vtkClientSocket.

new const string Kitware.VTK.vtkSocket.MRFullTypeName = "Kitware.VTK.vtkSocket"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkObject.

Reimplemented in Kitware.VTK.vtkServerSocket, and Kitware.VTK.vtkClientSocket.


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