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

#include <vtkNetworkAccessManager.h>

Inheritance diagram for vtkNetworkAccessManager:

Collaboration diagram for vtkNetworkAccessManager:

[legend]

Public Types
enum	ConnectionResult { ConnectionResult::CONNECTION_SUCCESS, ConnectionResult::CONNECTION_TIMEOUT, ConnectionResult::CONNECTION_ABORT, ConnectionResult::CONNECTION_HANDSHAKE_ERROR, ConnectionResult::CONNECTION_FAILURE }
	Possible result of connection when creating a new connection CONNECTION_SUCCESS: Connection was sucessfull CONNECTION_TIMEOUT: After spending a specified amount of time, no connection was initiated CONNECTION_ABORT: User aborted the connection before it was successful or timed out CONNECTION_HANDSHAKE_ERROR: Connection was iniated but the handshake failed CONNECTION_FAILURE: Unspecified connection error. More...

typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

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...

virtual void	DisableFurtherConnections (int port, bool disable)=0
	Enable/disable further connections for given port. More...

virtual bool	GetWrongConnectID ()=0
	Returns true if the last check of connect ids was wrong. More...


virtual vtkMultiProcessController *	NewConnection (const char *url)
	Creates a new connection given the url. More...

virtual vtkMultiProcessController *	NewConnection (const char *url, ConnectionResult &result)=0
	Creates a new connection given the url. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual vtkMTimeType	GetMTime ()

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkNetworkAccessManager *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Member Functions
	vtkNetworkAccessManager ()

	~vtkNetworkAccessManager () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Additional Inherited Members
Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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 20 of file vtkNetworkAccessManager.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkNetworkAccessManager::Superclass

Definition at line 23 of file vtkNetworkAccessManager.h.

Member Enumeration Documentation

◆ ConnectionResult

enum vtkNetworkAccessManager::ConnectionResult

strong

Possible result of connection when creating a new connection CONNECTION_SUCCESS: Connection was sucessfull CONNECTION_TIMEOUT: After spending a specified amount of time, no connection was initiated CONNECTION_ABORT: User aborted the connection before it was successful or timed out CONNECTION_HANDSHAKE_ERROR: Connection was iniated but the handshake failed CONNECTION_FAILURE: Unspecified connection error.

Enumerator
CONNECTION_SUCCESS
CONNECTION_TIMEOUT
CONNECTION_ABORT
CONNECTION_HANDSHAKE_ERROR
CONNECTION_FAILURE

Definition at line 34 of file vtkNetworkAccessManager.h.

Constructor & Destructor Documentation

◆ vtkNetworkAccessManager()

vtkNetworkAccessManager::vtkNetworkAccessManager ( )

protected

◆ ~vtkNetworkAccessManager()

vtkNetworkAccessManager::~vtkNetworkAccessManager ( )

overrideprotected

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 from vtkObjectBase.

Reimplemented in vtkTCPNetworkAccessManager.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

Reimplemented in vtkTCPNetworkAccessManager.

◆ NewConnection() [1/2]

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

inlinevirtual

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. The result arg provide information about the failure or sucess of the connection, see vtkNetworkAccessManager::ConnectionResult for possible values.

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 nullptr.

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@medea
http://kitware-server/session?id=12322&authorization=12

Definition at line 72 of file vtkNetworkAccessManager.h.

◆ NewConnection() [2/2]

virtual vtkMultiProcessController* vtkNetworkAccessManager::NewConnection	(	const char *	url,
		ConnectionResult &	result
	)

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. The result arg provide information about the failure or sucess of the connection, see vtkNetworkAccessManager::ConnectionResult for possible values.

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 nullptr.

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@medea
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.

◆ DisableFurtherConnections()

virtual void vtkNetworkAccessManager::DisableFurtherConnections	(	int	port,
		bool	disable
	)

pure virtual

Enable/disable further connections for given port.

Implemented in vtkTCPNetworkAccessManager.

◆ GetWrongConnectID()

virtual bool vtkNetworkAccessManager::GetWrongConnectID ( )

pure virtual

Returns true if the last check of connect ids was wrong.

Implemented in vtkTCPNetworkAccessManager.

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

/builds/gitlab-kitware-sciviz-ci/Remoting/Core/vtkNetworkAccessManager.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ ConnectionResult

Constructor & Destructor Documentation

◆ vtkNetworkAccessManager()

◆ ~vtkNetworkAccessManager()

Member Function Documentation

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ NewConnection() [1/2]

◆ NewConnection() [2/2]

◆ AbortPendingConnection()

◆ ProcessEvents()

◆ GetNetworkEventsAvailable()

◆ GetPendingConnectionsPresent()

◆ DisableFurtherConnections()

◆ GetWrongConnectID()