ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkNetworkAccessManager Class Referenceabstract

vtkNetworkAccessManager is used to create new connections and monitor activity of those connections. More...

#include <vtkNetworkAccessManager.h>

Inheritance diagram for vtkNetworkAccessManager:
Inheritance graph
[legend]

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual vtkMultiProcessController * NewConnection (const char *url)=0
 Creates a new connection given the url. More...
 
virtual void AbortPendingConnection ()=0
 Used to abort pending connection creation, if any. More...
 
virtual int ProcessEvents (unsigned long timeout_msecs)=0
 Process any network activity. More...
 
virtual bool GetNetworkEventsAvailable ()=0
 Peeks to check if any activity is available. More...
 
virtual bool GetPendingConnectionsPresent ()=0
 Returns true is the manager is currently waiting for any connections. More...
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkNetworkAccessManagerSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkNetworkAccessManager ()
 
 ~vtkNetworkAccessManager ()
 

Detailed Description

vtkNetworkAccessManager is used to create new connections and monitor activity of those connections.

This is an abstract class that defines the interface. Concrete implementations of this class can be written to support tcp/ip socket or ssl or ssh based network connections among processes.

Definition at line 32 of file vtkNetworkAccessManager.h.

Member Typedef Documentation

§ Superclass

Definition at line 35 of file vtkNetworkAccessManager.h.

Constructor & Destructor Documentation

§ vtkNetworkAccessManager()

vtkNetworkAccessManager::vtkNetworkAccessManager ( )
protected

§ ~vtkNetworkAccessManager()

vtkNetworkAccessManager::~vtkNetworkAccessManager ( )
protected

Member Function Documentation

§ GetClassName()

virtual const char* vtkNetworkAccessManager::GetClassName ( )
virtual

Reimplemented in vtkTCPNetworkAccessManager.

§ IsTypeOf()

static int vtkNetworkAccessManager::IsTypeOf ( const char *  type)
static

§ IsA()

virtual int vtkNetworkAccessManager::IsA ( const char *  type)
virtual

Reimplemented in vtkTCPNetworkAccessManager.

§ SafeDownCast()

static vtkNetworkAccessManager* vtkNetworkAccessManager::SafeDownCast ( vtkObject *  o)
static

§ PrintSelf()

void vtkNetworkAccessManager::PrintSelf ( ostream &  os,
vtkIndent  indent 
)

§ NewConnection()

virtual vtkMultiProcessController* vtkNetworkAccessManager::NewConnection ( const char *  url)
pure virtual

Creates a new connection given the url.

This call may block until the connection can be established. To keep user-interfaces responsive, one can listen to the vtkCommand::ProgressEvent fired periodically by this class while waiting.

vtkNetworkAccessManager can be waiting for atmost one connection at a time. Calling NewConnection() while another connection is pending will raise an error.

To abort the connection and cancel the waiting, simply call AbortPendingConnection() in the vtkCommand::ProgressEvent callback.

Returns the new connection instance on success, otherwise NULL.

URLs are of the following form: <transport>://<address>

  • tcp://<hostname>:<port>
  • tcp://localhost:<port>/listen – listen for connection on port.
  • tcp://localhost:<port>/listenmultiple – listen for multiple Examples:
  • tcp://medea:12345
  • tcp://localhost:12345/listen
  • ssh://utkarsh
  • http://kitware-server/session?id=12322&authorization=12

Implemented in vtkTCPNetworkAccessManager.

§ AbortPendingConnection()

virtual void vtkNetworkAccessManager::AbortPendingConnection ( )
pure virtual

Used to abort pending connection creation, if any.

Refer to NewConnection() for details.

Implemented in vtkTCPNetworkAccessManager.

§ ProcessEvents()

virtual int vtkNetworkAccessManager::ProcessEvents ( unsigned long  timeout_msecs)
pure virtual

Process any network activity.

Implemented in vtkTCPNetworkAccessManager.

§ GetNetworkEventsAvailable()

virtual bool vtkNetworkAccessManager::GetNetworkEventsAvailable ( )
pure virtual

Peeks to check if any activity is available.

When this call returns true, ProcessEvents() will always result in some activity processing if called afterword.

Implemented in vtkTCPNetworkAccessManager.

§ GetPendingConnectionsPresent()

virtual bool vtkNetworkAccessManager::GetPendingConnectionsPresent ( )
pure virtual

Returns true is the manager is currently waiting for any connections.

Implemented in vtkTCPNetworkAccessManager.


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