vtkSMSession is the default ParaView session. More...

#include <vtkSMSession.h>

Inheritance diagram for vtkSMSession:

[legend]

Collaboration diagram for vtkSMSession:

[legend]

Public Types
enum	RenderingMode { RENDERING_NOT_AVAILABLE = 0x00, RENDERING_UNIFIED = 0x01, RENDERING_SPLIT = 0x02 }

typedef vtkPVSessionBase	Superclass

Public Types inherited from vtkPVSessionBase
enum	EventIds { RegisterRemoteObjectEvent = 1234, UnRegisterRemoteObjectEvent = 4321, ProcessingRemoteEnd = 2143, ConnectionLost = 6789 }

typedef vtkPVSession	Superclass

Public Types inherited from vtkPVSession
enum	ServerFlags { NONE = 0, DATA_SERVER = 0x01, DATA_SERVER_ROOT = 0x02, RENDER_SERVER = 0x04, RENDER_SERVER_ROOT = 0x08, SERVERS = DATA_SERVER \| RENDER_SERVER, CLIENT = 0x10, CLIENT_AND_SERVERS = DATA_SERVER \| CLIENT \| RENDER_SERVER }

typedef vtkSession	Superclass

Public Types inherited from vtkSession
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

virtual vtkSMCollaborationManager *	GetCollaborationManager ()
	Return the instance of vtkSMCollaborationManager that will be lazy created at the first call. More...

virtual const char *	GetURI ()
	Return the URL that define where the session is connected to. More...

virtual int	GetNumberOfProcesses (vtkTypeUInt32 servers)
	Returns the number of processes on the given server/s. More...

virtual bool	IsMPIInitialized (vtkTypeUInt32 servers)
	Returns whether or not MPI is initialized on the specified server/s. More...

virtual vtkSMProxyLocator *	GetProxyLocator ()

virtual unsigned int	GetRenderClientMode ()
	Convenient method to determine if the rendering is done in a pvrenderer or not. More...

bool	GetIsAlive () override
	Builtin session is always alive. More...

ServerFlags	GetProcessRoles () override
	Returns a ServerFlags indicate the nature of the current processes. More...

void	PushState (vtkSMMessage *msg) override
	Push the state message. More...

void	NotifyAllClients (const vtkSMMessage *msg) override
	Sends the message to all clients. More...

void	NotifyOtherClients (const vtkSMMessage *) override
	Sends the message to all but the active client-session. More...

virtual void	PreDisconnection ()


virtual vtkSMSessionProxyManager *	GetSessionProxyManager ()
	Returns the vtkSMSessionProxyManager associated with this session. More...


virtual vtkSMStateLocator *	GetStateLocator ()
	Provide an access to the session state locator that can provide the last state of a given remote object that have been pushed. More...

Public Member Functions inherited from vtkPVSessionBase
vtkPVServerInformation *	GetServerInformation () override
	vtkPVServerInformation is an information-object that provides information about the server processes. More...

vtkMPIMToNSocketConnection *	GetMPIMToNSocketConnection () override
	This is socket connection, if any to communicate between the data-server and render-server nodes. More...

virtual void	PullState (vtkSMMessage *msg)
	Pull the state message. More...

virtual void	ExecuteStream (vtkTypeUInt32 location, const vtkClientServerStream &stream, bool ignore_errors=false)
	Execute a command on the given processes. More...

virtual const vtkClientServerStream &	GetLastResult (vtkTypeUInt32 location)
	Returns the response of the ExecuteStream() call from the location. More...

virtual bool	GatherInformation (vtkTypeUInt32 location, vtkPVInformation *information, vtkTypeUInt32 globalid)
	Gather information about an object referred by the `globalid`. More...

vtkSIProxyDefinitionManager *	GetProxyDefinitionManager ()
	Get the ProxyDefinitionManager. More...

vtkSIObject *	GetSIObject (vtkTypeUInt32 globalid)
	Returns a vtkSIObject or subclass given its global id, if any. More...

virtual void	UnRegisterSIObject (vtkSMMessage *msg)
	Unregister server side object. More...

virtual void	RegisterSIObject (vtkSMMessage *msg)
	Register server side object. More...

vtkObject *	GetRemoteObject (vtkTypeUInt32 globalid)
	Return a vtkSMRemoteObject given its global id if any otherwise return nullptr;. More...

virtual void	GetAllRemoteObjects (vtkCollection *collection)
	Allow the user to fill its vtkCollection with all RemoteObject This could be useful when you want to hold a reference to them to prevent any deletion across several method call. More...

virtual vtkTypeUInt32	GetNextGlobalUniqueIdentifier ()
	Provides the next available identifier. More...

virtual vtkTypeUInt32	GetNextChunkGlobalUniqueIdentifier (vtkTypeUInt32 chunkSize)
	Return the first Id of the requested chunk. More...

virtual bool	IsProcessingRemoteNotification ()
	This property is used to discard ignore_synchronization proxy property when we load protobuf states. More...

virtual void	UseSessionCoreOf (vtkPVSessionBase *other)
	Update internal session core in order to use the one used in another session. More...

virtual vtkPVSessionCore *	GetSessionCore ()
	Provides access to the session core. More...

Public Member Functions inherited from vtkPVSession
bool	HasProcessRole (vtkTypeUInt32 flag)
	Convenience method that returns true if the current session is serving the indicated role on this process. More...

virtual vtkMultiProcessController *	GetController (ServerFlags processType)
	Returns the controller used to communicate with the process. More...

virtual bool	IsMultiClients ()
	Allow anyone to know easily if the current session is involved in collaboration or not. More...

bool	GetPendingProgress ()
	Returns true if the session is within a PrepareProgress() and CleanupPendingProgress() block. More...

virtual vtkPVProgressHandler *	GetProgressHandler ()
	Provides access to the progress handler. More...

void	PrepareProgress ()
	Should be called to begin/end receiving progresses on this session. More...

void	CleanupPendingProgress ()
	Should be called to begin/end receiving progresses on this session. 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 vtkSMSession *	New ()

static vtkSMSession *	New (vtkPVSessionBase *otherSession)

static vtkSMSession *	New (vtkPVSessionCore *otherSessionCore)

static int	IsTypeOf (const char *type)

static vtkSMSession *	SafeDownCast (vtkObject *o)

static vtkIdType	ConnectToCatalyst ()
	These are static helper methods that help create Catalyst ParaView sessions. More...


static vtkIdType	ConnectToSelf ()
	These are static helper methods that help create standard ParaView sessions. More...


static vtkIdType	ConnectToRemote (const char *hostname, int port, int timeout=60)
	These are static helper methods that help create standard ParaView sessions. More...

static vtkIdType	ConnectToRemote (const char hostname, int port, int timeout, bool(callback)(), vtkNetworkAccessManager::ConnectionResult &result)
	These are static helper methods that help create standard ParaView sessions. More...


static vtkIdType	ReverseConnectToRemote (int port)
	Same as ConnectToRemote() except that it waits for a reverse connection for timeout seconds. More...

static vtkIdType	ReverseConnectToRemoteWithTimeout (int port, int timeout)
	Same as ConnectToRemote() except that it waits for a reverse connection for timeout seconds. More...

static vtkIdType	ReverseConnectToRemote (int port, int timeout, bool(*callback)(), vtkNetworkAccessManager::ConnectionResult &result)
	Same as ConnectToRemote() except that it waits for a reverse connection for timeout seconds. More...


static vtkIdType	ConnectToRemote (const char dshost, int dsport, const char rshost, int rsport, int timeout=60)
	These are static helper methods that help create standard ParaView sessions. More...

static vtkIdType	ConnectToRemote (const char dshost, int dsport, const char rshost, int rsport, int timeout, bool(*callback)(), vtkNetworkAccessManager::ConnectionResult &result)
	These are static helper methods that help create standard ParaView sessions. More...


static vtkIdType	ReverseConnectToRemote (int dsport, int rsport)
	Same as ConnectToRemote() except that it waits for a reverse connection for timeout seconds. More...

static vtkIdType	ReverseConnectToRemoteWithTimeout (int dsport, int rsport, int timeout)
	Same as ConnectToRemote() except that it waits for a reverse connection for timeout seconds. More...

static vtkIdType	ReverseConnectToRemote (int dsport, int rsport, int timeout, bool(*callback)(), vtkNetworkAccessManager::ConnectionResult &result)
	Same as ConnectToRemote() except that it waits for a reverse connection for timeout seconds. More...


static void	Disconnect (vtkIdType sessionid)
	Use this method to disconnect from a session. More...

static void	Disconnect (vtkSMSession *session)
	Use this method to disconnect from a session. More...

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

static vtkPVSessionBase *	SafeDownCast (vtkObject *o)

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

static vtkPVSession *	SafeDownCast (vtkObject *o)

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

static vtkSession *	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
	vtkSMSession (bool initialize_during_constructor=true, vtkPVSessionCore *preExistingSessionCore=nullptr)

	~vtkSMSession () override

virtual void	ProcessNotification (const vtkSMMessage *)
	Process the Notifation message sent using API to communicate from server-to-client. More...

virtual void	Initialize ()
	Initialize various internal classes after the session has been setup correctly. More...

void	UpdateStateHistory (vtkSMMessage *msg)
	This method has been externalized so classes that heritate from vtkSMSession and override PushState could easily keep track of the StateHistory and maintain the UndoRedo mecanisme. More...

Protected Member Functions inherited from vtkPVSessionBase
	vtkPVSessionBase ()

	vtkPVSessionBase (vtkPVSessionCore *coreToUse)

	~vtkPVSessionBase () override

void	RegisterRemoteObject (vtkTypeUInt32 globalid, vtkTypeUInt32 location, vtkObject *obj)
	Register a remote object. More...

void	UnRegisterRemoteObject (vtkTypeUInt32 globalid, vtkTypeUInt32 location)
	Unregister a remote object. More...

vtkPVSessionCore *	GetSessionCore () const
	Method used to migrate from one Session type to another by keeping the same vtkPVSessionCore. More...

void	SetSessionCore (vtkPVSessionCore *)
	Method used to migrate from one Session type to another by keeping the same vtkPVSessionCore. More...

void	PrepareProgressInternal () override
	Should be called to begin/end receiving progresses on this session. More...

void	CleanupPendingProgressInternal () override
	Should be called to begin/end receiving progresses on this session. More...

virtual bool	StartProcessingRemoteNotification ()
	Methods used to monitor if we are currently processing a server notification Only vtkSMSessionClient use the flag to disable ignore_synchronization properties from being updated. More...

virtual void	StopProcessingRemoteNotification (bool previousValue)
	Methods used to monitor if we are currently processing a server notification Only vtkSMSessionClient use the flag to disable ignore_synchronization properties from being updated. More...

Protected Member Functions inherited from vtkPVSession
	vtkPVSession ()

	~vtkPVSession () override

virtual bool	OnWrongTagEvent (vtkObject caller, unsigned long eventid, void calldata)
	Callback when any vtkMultiProcessController subclass fires a WrongTagEvent. More...

Protected Member Functions inherited from vtkSession
	vtkSession ()

	~vtkSession () override

virtual void	Activate ()
	Subclasses must call this to mark the session active. More...

virtual void	DeActivate ()
	Subclasses must call this to mark the session inactive. More...

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 &)

Protected Attributes
vtkSMSessionProxyManager *	SessionProxyManager

vtkSMStateLocator *	StateLocator

vtkSMProxyLocator *	ProxyLocator

Protected Attributes inherited from vtkPVSessionBase
vtkPVSessionCore *	SessionCore

bool	ProcessingRemoteNotification
	Methods used to monitor if we are currently processing a server notification Only vtkSMSessionClient use the flag to disable ignore_synchronization properties from being updated. More...

Protected Attributes inherited from vtkPVSession
vtkPVProgressHandler *	ProgressHandler

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Protected Types inherited from vtkPVSession
enum	{ EXCEPTION_EVENT_TAG = 31416 }

Detailed Description

vtkSMSession is the default ParaView session.

This class can be used as the session for non-client-server configurations eg. builtin mode or batch.

Definition at line 22 of file vtkSMSession.h.

Member Typedef Documentation

◆ Superclass

typedef vtkPVSessionBase vtkSMSession::Superclass

Definition at line 28 of file vtkSMSession.h.

Member Enumeration Documentation

◆ RenderingMode

enum vtkSMSession::RenderingMode

Enumerator
RENDERING_NOT_AVAILABLE
RENDERING_UNIFIED
RENDERING_SPLIT

Definition at line 81 of file vtkSMSession.h.

Constructor & Destructor Documentation

◆ vtkSMSession()

vtkSMSession::vtkSMSession	(	bool	initialize_during_constructor = `true`,
		vtkPVSessionCore *	preExistingSessionCore = `nullptr`
	)

protected

◆ ~vtkSMSession()

vtkSMSession::~vtkSMSession ( )

overrideprotected

Member Function Documentation

◆ New() [1/3]

static vtkSMSession* vtkSMSession::New ( )

static

◆ New() [2/3]

static vtkSMSession* vtkSMSession::New ( vtkPVSessionBase * otherSession )

static

◆ New() [3/3]

static vtkSMSession* vtkSMSession::New ( vtkPVSessionCore * otherSessionCore )

static

◆ GetClassName()

virtual const char* vtkSMSession::GetClassName ( )

virtual

Reimplemented from vtkPVSessionBase.

Reimplemented in vtkSMSessionClient.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkPVSessionBase.

Reimplemented in vtkSMSessionClient.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkPVSessionBase.

Reimplemented in vtkSMSessionClient.

◆ GetCollaborationManager()

virtual vtkSMCollaborationManager* vtkSMSession::GetCollaborationManager ( )

inlinevirtual

Return the instance of vtkSMCollaborationManager that will be lazy created at the first call.

By default we return nullptr

Reimplemented in vtkSMSessionClient.

Definition at line 40 of file vtkSMSession.h.

◆ GetURI()

virtual const char* vtkSMSession::GetURI ( )

inlinevirtual

Return the URL that define where the session is connected to.

URI has enough information to know the type of connection, server hosts and ports.

Reimplemented in vtkSMSessionClient.

Definition at line 50 of file vtkSMSession.h.

◆ GetSessionProxyManager()

virtual vtkSMSessionProxyManager* vtkSMSession::GetSessionProxyManager ( )

virtual

Returns the vtkSMSessionProxyManager associated with this session.

◆ GetNumberOfProcesses()

virtual int vtkSMSession::GetNumberOfProcesses ( vtkTypeUInt32 servers )

virtual

Returns the number of processes on the given server/s.

If more than 1 server is identified, then it returns the maximum number of processes e.g. is servers = DATA_SERVER | RENDER_SERVER and there are 3 data-server nodes and 2 render-server nodes, then this method will return 3. Implementation provided simply returns the number of local processes.

Reimplemented in vtkSMSessionClient.

◆ IsMPIInitialized()

virtual bool vtkSMSession::IsMPIInitialized ( vtkTypeUInt32 servers )

virtual

Returns whether or not MPI is initialized on the specified server/s.

If more than 1 server is identified it will return true only if all of the servers have MPI initialized.

Reimplemented in vtkSMSessionClient.

◆ GetProxyLocator()

virtual vtkSMProxyLocator* vtkSMSession::GetProxyLocator ( )

virtual

◆ GetRenderClientMode()

virtual unsigned int vtkSMSession::GetRenderClientMode ( )

virtual

Convenient method to determine if the rendering is done in a pvrenderer or not.

For built-in or pvserver you will get RENDERING_UNIFIED and for a setting with a pvrenderer you will get RENDERING_SPLIT. If the session is something else it should reply RENDERING_NOT_AVAILABLE.

◆ GetStateLocator()

virtual vtkSMStateLocator* vtkSMSession::GetStateLocator ( )

virtual

Provide an access to the session state locator that can provide the last state of a given remote object that have been pushed.

That locator will be filled by RemoteObject state only if the UndoStackBuilder in vtkSMProxyManager is non-nullptr.

◆ GetIsAlive()

bool vtkSMSession::GetIsAlive ( )

inlineoverridevirtual

Builtin session is always alive.

Implements vtkSession.

Reimplemented in vtkSMSessionClient.

Definition at line 118 of file vtkSMSession.h.

◆ GetProcessRoles()

ServerFlags vtkSMSession::GetProcessRoles ( )

overridevirtual

Returns a ServerFlags indicate the nature of the current processes.

e.g. if the current processes acts as a data-server and a render-server, it returns DATA_SERVER | RENDER_SERVER. The implementation provided by this class returns vtkPVSession::CLIENT_AND_SERVERS suitable for builtin-mode.

Reimplemented from vtkPVSessionBase.

Reimplemented in vtkSMSessionClient.

◆ PushState()

void vtkSMSession::PushState ( vtkSMMessage * msg )

overridevirtual

Push the state message.

Overridden to ensure that the information in the undo-redo state manager is updated.

Reimplemented from vtkPVSessionBase.

Reimplemented in vtkSMSessionClient.

◆ NotifyAllClients()

void vtkSMSession::NotifyAllClients ( const vtkSMMessage * msg )

inlineoverridevirtual

Sends the message to all clients.

Implements vtkPVSessionBase.

Definition at line 138 of file vtkSMSession.h.

◆ NotifyOtherClients()

void vtkSMSession::NotifyOtherClients ( const vtkSMMessage * )

inlineoverridevirtual

Sends the message to all but the active client-session.

Implements vtkPVSessionBase.

Definition at line 143 of file vtkSMSession.h.

◆ PreDisconnection()

virtual void vtkSMSession::PreDisconnection ( )

inlinevirtual

Reimplemented in vtkSMSessionClient.

Definition at line 152 of file vtkSMSession.h.

◆ ConnectToCatalyst()

static vtkIdType vtkSMSession::ConnectToCatalyst ( )

static

These are static helper methods that help create Catalyst ParaView sessions.

They register the session with the process module and return the session id. Returns 0 on failure. This version is used to create a catalyst built-in session.

◆ ConnectToSelf()

static vtkIdType vtkSMSession::ConnectToSelf ( )

static

These are static helper methods that help create standard ParaView sessions.

They register the session with the process module and return the session id. This version is used to create a built-in session.

◆ ConnectToRemote() [1/4]

static vtkIdType vtkSMSession::ConnectToRemote	(	const char *	hostname,
		int	port,
		int	timeout = `60`
	)

inlinestatic

These are static helper methods that help create standard ParaView sessions.

They register the session with the process module and return the session id. It will try to connect for timeout seconds, -1 meaning infinite retries. and 0 means no retry. Returns 0 on failure. Returns 0 on failure. This version is used to create a client-server session on client. The callback should return true, if the connection should continue trying to connect, else return false to abort. The result arg provide information about the failure or sucess of the connection, see vtkNetworkAccessManager::ConnectionResult for possible values.

Definition at line 188 of file vtkSMSession.h.

◆ ConnectToRemote() [2/4]

static vtkIdType vtkSMSession::ConnectToRemote	(	const char *	hostname,
		int	port,
		int	timeout,
		bool(*)()	callback,
		vtkNetworkAccessManager::ConnectionResult &	result
	)

static

These are static helper methods that help create standard ParaView sessions.

They register the session with the process module and return the session id. It will try to connect for timeout seconds, -1 meaning infinite retries. and 0 means no retry. Returns 0 on failure. Returns 0 on failure. This version is used to create a client-server session on client. The callback should return true, if the connection should continue trying to connect, else return false to abort. The result arg provide information about the failure or sucess of the connection, see vtkNetworkAccessManager::ConnectionResult for possible values.

◆ ReverseConnectToRemote() [1/4]

static vtkIdType vtkSMSession::ReverseConnectToRemote ( int port )

inlinestatic

Same as ConnectToRemote() except that it waits for a reverse connection for timeout seconds.

One can optionally provide a callback that can be called periodically while this call is blocked. The callback should return true, if the connection should continue waiting, else return false to abort the wait. The result arg provide information about the failure or sucess of the connection, see vtkNetworkAccessManager::ConnectionResult for possible values.

Definition at line 207 of file vtkSMSession.h.

◆ ReverseConnectToRemoteWithTimeout() [1/2]

static vtkIdType vtkSMSession::ReverseConnectToRemoteWithTimeout	(	int	port,
		int	timeout
	)

inlinestatic

Same as ConnectToRemote() except that it waits for a reverse connection for timeout seconds.

One can optionally provide a callback that can be called periodically while this call is blocked. The callback should return true, if the connection should continue waiting, else return false to abort the wait. The result arg provide information about the failure or sucess of the connection, see vtkNetworkAccessManager::ConnectionResult for possible values.

Definition at line 211 of file vtkSMSession.h.

◆ ReverseConnectToRemote() [2/4]

static vtkIdType vtkSMSession::ReverseConnectToRemote	(	int	port,
		int	timeout,
		bool(*)()	callback,
		vtkNetworkAccessManager::ConnectionResult &	result
	)

static

Same as ConnectToRemote() except that it waits for a reverse connection for timeout seconds.

One can optionally provide a callback that can be called periodically while this call is blocked. The callback should return true, if the connection should continue waiting, else return false to abort the wait. The result arg provide information about the failure or sucess of the connection, see vtkNetworkAccessManager::ConnectionResult for possible values.

◆ ConnectToRemote() [3/4]

static vtkIdType vtkSMSession::ConnectToRemote	(	const char *	dshost,
		int	dsport,
		const char *	rshost,
		int	rsport,
		int	timeout = `60`
	)

inlinestatic

These are static helper methods that help create standard ParaView sessions.

They register the session with the process module and return the session id. It will try to connect for timeout seconds, -1 meaning infinite retries. and 0 means no retry. Returns 0 on failure. This version is used to create a client-dataserver-renderserver session on client. The callback should return true, if the connection should continue trying to connect, else return false to abort. The result arg provide information about the failure or sucess of the connection, see vtkNetworkAccessManager::ConnectionResult for possible values.

Definition at line 232 of file vtkSMSession.h.

◆ ConnectToRemote() [4/4]

static vtkIdType vtkSMSession::ConnectToRemote	(	const char *	dshost,
		int	dsport,
		const char *	rshost,
		int	rsport,
		int	timeout,
		bool(*)()	callback,
		vtkNetworkAccessManager::ConnectionResult &	result
	)

static

These are static helper methods that help create standard ParaView sessions.

They register the session with the process module and return the session id. It will try to connect for timeout seconds, -1 meaning infinite retries. and 0 means no retry. Returns 0 on failure. This version is used to create a client-dataserver-renderserver session on client. The callback should return true, if the connection should continue trying to connect, else return false to abort. The result arg provide information about the failure or sucess of the connection, see vtkNetworkAccessManager::ConnectionResult for possible values.

◆ ReverseConnectToRemote() [3/4]

static vtkIdType vtkSMSession::ReverseConnectToRemote	(	int	dsport,
		int	rsport
	)

inlinestatic

Same as ConnectToRemote() except that it waits for a reverse connection for timeout seconds.

One can optionally provide a callback that can be called periodically while this call is blocked. The callback should return true, if the connection should continue waiting, else return false to abort the wait. The result arg provide information about the failure or sucess of the connection, see vtkNetworkAccessManager::ConnectionResult for possible values.

Definition at line 252 of file vtkSMSession.h.

◆ ReverseConnectToRemoteWithTimeout() [2/2]

static vtkIdType vtkSMSession::ReverseConnectToRemoteWithTimeout	(	int	dsport,
		int	rsport,
		int	timeout
	)

inlinestatic

Same as ConnectToRemote() except that it waits for a reverse connection for timeout seconds.

One can optionally provide a callback that can be called periodically while this call is blocked. The callback should return true, if the connection should continue waiting, else return false to abort the wait. The result arg provide information about the failure or sucess of the connection, see vtkNetworkAccessManager::ConnectionResult for possible values.

Definition at line 256 of file vtkSMSession.h.

◆ ReverseConnectToRemote() [4/4]

static vtkIdType vtkSMSession::ReverseConnectToRemote	(	int	dsport,
		int	rsport,
		int	timeout,
		bool(*)()	callback,
		vtkNetworkAccessManager::ConnectionResult &	result
	)

static

Same as ConnectToRemote() except that it waits for a reverse connection for timeout seconds.

One can optionally provide a callback that can be called periodically while this call is blocked. The callback should return true, if the connection should continue waiting, else return false to abort the wait. The result arg provide information about the failure or sucess of the connection, see vtkNetworkAccessManager::ConnectionResult for possible values.

◆ Disconnect() [1/2]

static void vtkSMSession::Disconnect ( vtkIdType sessionid )

static

Use this method to disconnect from a session.

This ensures that appropriate cleanup happens before the disconnect such as unregistering proxies. It also ensures that if in collaboration mode, the proxy unregistering doesn't affect other connected clients.

◆ Disconnect() [2/2]

static void vtkSMSession::Disconnect ( vtkSMSession * session )

static

Use this method to disconnect from a session.

This ensures that appropriate cleanup happens before the disconnect such as unregistering proxies. It also ensures that if in collaboration mode, the proxy unregistering doesn't affect other connected clients.

◆ ProcessNotification()

virtual void vtkSMSession::ProcessNotification ( const vtkSMMessage * )

protectedvirtual

Process the Notifation message sent using API to communicate from server-to-client.

◆ Initialize()

virtual void vtkSMSession::Initialize ( )

protectedvirtual

Initialize various internal classes after the session has been setup correctly.

Reimplemented in vtkSMSessionClient.

◆ UpdateStateHistory()

void vtkSMSession::UpdateStateHistory ( vtkSMMessage * msg )

protected

This method has been externalized so classes that heritate from vtkSMSession and override PushState could easily keep track of the StateHistory and maintain the UndoRedo mecanisme.

Member Data Documentation

◆ SessionProxyManager

vtkSMSessionProxyManager* vtkSMSession::SessionProxyManager

protected

Definition at line 303 of file vtkSMSession.h.

◆ StateLocator

vtkSMStateLocator* vtkSMSession::StateLocator

protected

Definition at line 304 of file vtkSMSession.h.

◆ ProxyLocator

vtkSMProxyLocator* vtkSMSession::ProxyLocator

protected

Definition at line 305 of file vtkSMSession.h.

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

/builds/gitlab-kitware-sciviz-ci/Remoting/ServerManager/vtkSMSession.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ RenderingMode

Constructor & Destructor Documentation

◆ vtkSMSession()

◆ ~vtkSMSession()

Member Function Documentation

◆ New() [1/3]

◆ New() [2/3]

◆ New() [3/3]

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ GetCollaborationManager()

◆ GetURI()

◆ GetSessionProxyManager()

◆ GetNumberOfProcesses()

◆ IsMPIInitialized()

◆ GetProxyLocator()

◆ GetRenderClientMode()

◆ GetStateLocator()

◆ GetIsAlive()

◆ GetProcessRoles()

◆ PushState()

◆ NotifyAllClients()

◆ NotifyOtherClients()

◆ PreDisconnection()

◆ ConnectToCatalyst()

◆ ConnectToSelf()

◆ ConnectToRemote() [1/4]

◆ ConnectToRemote() [2/4]

◆ ReverseConnectToRemote() [1/4]

◆ ReverseConnectToRemoteWithTimeout() [1/2]

◆ ReverseConnectToRemote() [2/4]

◆ ConnectToRemote() [3/4]

◆ ConnectToRemote() [4/4]

◆ ReverseConnectToRemote() [3/4]

◆ ReverseConnectToRemoteWithTimeout() [2/2]

◆ ReverseConnectToRemote() [4/4]

◆ Disconnect() [1/2]

◆ Disconnect() [2/2]

◆ ProcessNotification()

◆ Initialize()

◆ UpdateStateHistory()

Member Data Documentation

◆ SessionProxyManager

◆ StateLocator

◆ ProxyLocator