Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkSMSessionClient Class Reference

vtkSMSessionClient is a remote-session that connects to a remote server. More...

#include <vtkSMSessionClient.h>

Inheritance diagram for vtkSMSessionClient:
Inheritance graph
[legend]
Collaboration diagram for vtkSMSessionClient:
Collaboration graph
[legend]

Public Types

typedef vtkSMSession Superclass
 
- Public Types inherited from vtkSMSession
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
 
const char * GetURI () override
 Return the url used to connect the current session to a server. More...
 
bool GetIsAlive () override
 Returns true is this session is active/alive/valid. More...
 
ServerFlags GetProcessRoles () override
 Returns a ServerFlags indicate the nature of the current processes. More...
 
vtkMultiProcessControllerGetController (ServerFlags processType) override
 Returns the controller used to communicate with the process. More...
 
vtkPVServerInformationGetServerInformation () override
 vtkPVServerInformation is an information-object that provides information about the server processes. More...
 
void Initialize () override
 Called to do any initializations after a successful session has been established. More...
 
void CloseSession ()
 Gracefully exits the session. More...
 
bool GatherInformation (vtkTypeUInt32 location, vtkPVInformation *information, vtkTypeUInt32 globalid) override
 Gather information about an object referred by the globalid. More...
 
int GetNumberOfProcesses (vtkTypeUInt32 servers) override
 Returns the number of processes on the given server/s. More...
 
bool IsMPIInitialized (vtkTypeUInt32 servers) override
 Returns whether or not MPI is initialized on the specified server/s. More...
 
void PreDisconnection () override
 
virtual bool IsNotBusy ()
 Flag used to know if it is a good time to handle server notification. More...
 
virtual void StartBusyWork ()
 BusyWork should be declared inside method that will request several network call that we don't want to interrupt such as GatherInformation and Pull. More...
 
virtual void EndBusyWork ()
 BusyWork should be declared inside method that will request several network call that we don't want to interrupt such as GatherInformation and Pull. More...
 
vtkSMCollaborationManagerGetCollaborationManager () override
 Return the instance of vtkSMCollaborationManager that will be lazy created at the first call. More...
 
int GetConnectID ()
 Return the connect id of this client. More...
 
vtkTypeUInt32 GetNextGlobalUniqueIdentifier () override
 Provides the next available identifier. More...
 
vtkTypeUInt32 GetNextChunkGlobalUniqueIdentifier (vtkTypeUInt32 chunkSize) override
 Return the first Id of the requested chunk. More...
 
void OnServerNotificationMessageRMI (void *message, int message_length)
 
virtual bool Connect (const char *url, int timeout=60)
 Connects a remote server. More...
 
virtual bool Connect (const char *url, int timeout, bool(*callback)(), vtkNetworkAccessManager::ConnectionResult &connectionResult)
 Connects a remote server. More...
 
void PushState (vtkSMMessage *msg) override
 Push the state. More...
 
void PullState (vtkSMMessage *message) override
 Push the state. More...
 
void ExecuteStream (vtkTypeUInt32 location, const vtkClientServerStream &stream, bool ignore_errors=false) override
 Push the state. More...
 
const vtkClientServerStreamGetLastResult (vtkTypeUInt32 location) override
 Push the state. More...
 
virtual void SetAbortConnect (bool)
 When Connect() is waiting for a server to connect back to the client (in reverse connect mode), then it periodically fires ProgressEvent. 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...
 
- Public Member Functions inherited from vtkSMSession
virtual vtkSMProxyLocatorGetProxyLocator ()
 
virtual unsigned int GetRenderClientMode ()
 Convenient method to determine if the rendering is done in a pvrenderer or not. 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 vtkSMSessionProxyManagerGetSessionProxyManager ()
 Returns the vtkSMSessionProxyManager associated with this session. More...
 
virtual vtkSMStateLocatorGetStateLocator ()
 Provide an access to the session state locator that can provide the last state of a given remote object that have been pushed. More...
 
bool GetIsAutoMPI () const
 Deprecated. More...
 
- Public Member Functions inherited from vtkPVSessionBase
vtkMPIMToNSocketConnectionGetMPIMToNSocketConnection () override
 This is socket connection, if any to communicate between the data-server and render-server nodes. More...
 
vtkSIProxyDefinitionManagerGetProxyDefinitionManager ()
 Get the ProxyDefinitionManager. More...
 
vtkSIObjectGetSIObject (vtkTypeUInt32 globalid)
 Returns a vtkSIObject or subclass given its global id, if any. More...
 
vtkObjectGetRemoteObject (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 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 vtkPVSessionCoreGetSessionCore ()
 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 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 vtkPVProgressHandlerGetProgressHandler ()
 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)
 
vtkCommandGetCommand (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)
 
vtkCommandGetCommand (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 vtkSMSessionClientNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMSessionClientSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMSession
static vtkSMSessionNew ()
 
static vtkSMSessionNew (vtkPVSessionBase *otherSession)
 
static vtkSMSessionNew (vtkPVSessionCore *otherSessionCore)
 
static int IsTypeOf (const char *type)
 
static vtkSMSessionSafeDownCast (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 vtkPVSessionBaseSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkPVSession
static int IsTypeOf (const char *type)
 
static vtkPVSessionSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSession
static int IsTypeOf (const char *type)
 
static vtkSessionSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 
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 vtkObjectBaseNew ()
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkSMSessionClient ()
 
 ~vtkSMSessionClient () override
 
void SetRenderServerController (vtkMultiProcessController *)
 
void SetDataServerController (vtkMultiProcessController *)
 
void SetupDataServerRenderServerConnection ()
 
void UnRegisterSIObject (vtkSMMessage *msg) override
 Delete server side object. More...
 
void RegisterSIObject (vtkSMMessage *msg) override
 Notify server side object that it is used by one more client. More...
 
vtkTypeUInt32 GetRealLocation (vtkTypeUInt32)
 Translates the location to a real location based on whether a separate render-server exists. More...
 
virtual void SetURI (const char *)
 
bool OnWrongTagEvent (vtkObject *caller, unsigned long eventid, void *calldata) override
 Callback when any vtkMultiProcessController subclass fires a WrongTagEvent. More...
 
virtual void OnConnectionLost (vtkObject *caller, unsigned long eventid, void *calldata)
 Callback when any vtkMultiProcessController subclass fires a ErrorEvent. More...
 
- Protected Member Functions inherited from vtkSMSession
 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...
 
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...
 
vtkPVSessionCoreGetSessionCore () 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...
 
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
 
- 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

vtkMultiProcessControllerRenderServerController
 
vtkMultiProcessControllerDataServerController
 
vtkPVServerInformationDataServerInformation
 
vtkPVServerInformationRenderServerInformation
 
vtkPVServerInformationServerInformation
 
vtkClientServerStreamServerLastInvokeResult
 
bool AbortConnect
 
char * URI
 
bool NoMoreDelete
 
vtkSMCollaborationManagerCollaborationCommunicator
 
- Protected Attributes inherited from vtkSMSession
vtkSMSessionProxyManagerSessionProxyManager
 
vtkSMStateLocatorStateLocator
 
vtkSMProxyLocatorProxyLocator
 
- Protected Attributes inherited from vtkPVSessionBase
vtkPVSessionCoreSessionCore
 
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
vtkPVProgressHandlerProgressHandler
 
- 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

vtkSMSessionClient is a remote-session that connects to a remote server.

vtkSMSessionClient supports both connecting a pvserver as well as connecting a pvdataserver/pvrenderserver.

Definition at line 35 of file vtkSMSessionClient.h.

Member Typedef Documentation

◆ Superclass

Definition at line 39 of file vtkSMSessionClient.h.

Constructor & Destructor Documentation

◆ vtkSMSessionClient()

vtkSMSessionClient::vtkSMSessionClient ( )
protected

◆ ~vtkSMSessionClient()

vtkSMSessionClient::~vtkSMSessionClient ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkSMSessionClient* vtkSMSessionClient::New ( )
static

◆ GetClassName()

virtual const char* vtkSMSessionClient::GetClassName ( )
virtual

Reimplemented from vtkSMSession.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkSMSession.

◆ SafeDownCast()

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

◆ PrintSelf()

void vtkSMSessionClient::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Reimplemented from vtkSMSession.

◆ GetURI()

const char* vtkSMSessionClient::GetURI ( )
inlineoverridevirtual

Return the url used to connect the current session to a server.

Reimplemented from vtkSMSession.

Definition at line 45 of file vtkSMSessionClient.h.

◆ Connect() [1/2]

virtual bool vtkSMSessionClient::Connect ( const char *  url,
int  timeout = 60 
)
inlinevirtual

Connects a remote server.

URL can be of the following format: cs://<pvserver-host>:<pvserver-port> cdsrs://<pvdataserver-host>:<pvdataserver-port>/<pvrenderserver-host>:<pvrenderserver-port> In both cases the port is optional. When not provided default pvserver/pvdataserver port // is 11111, while default pvrenderserver port is 22221. For reverse connect i.e. the client waits for the server to connect back, simply add "rc" to the protocol e.g. csrc://<pvserver-host>:<pvserver-port> cdsrsrc://<pvdataserver-host>:<pvdataserver-port>/<pvrenderserver-host>:<pvrenderserver-port> In this case, the hostname is irrelevant and is ignored. Wait for timeout seconds for the connection. Default is 60, 0 means no retry. -1 means infinite retries. 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 67 of file vtkSMSessionClient.h.

◆ Connect() [2/2]

virtual bool vtkSMSessionClient::Connect ( const char *  url,
int  timeout,
bool(*)()  callback,
vtkNetworkAccessManager::ConnectionResult connectionResult 
)
virtual

Connects a remote server.

URL can be of the following format: cs://<pvserver-host>:<pvserver-port> cdsrs://<pvdataserver-host>:<pvdataserver-port>/<pvrenderserver-host>:<pvrenderserver-port> In both cases the port is optional. When not provided default pvserver/pvdataserver port // is 11111, while default pvrenderserver port is 22221. For reverse connect i.e. the client waits for the server to connect back, simply add "rc" to the protocol e.g. csrc://<pvserver-host>:<pvserver-port> cdsrsrc://<pvdataserver-host>:<pvdataserver-port>/<pvrenderserver-host>:<pvrenderserver-port> In this case, the hostname is irrelevant and is ignored. Wait for timeout seconds for the connection. Default is 60, 0 means no retry. -1 means infinite retries. 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.

◆ GetIsAlive()

bool vtkSMSessionClient::GetIsAlive ( )
overridevirtual

Returns true is this session is active/alive/valid.

Reimplemented from vtkSMSession.

◆ GetProcessRoles()

ServerFlags vtkSMSessionClient::GetProcessRoles ( )
inlineoverridevirtual

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. Overridden to return CLIENT since this process only acts as the client.

Reimplemented from vtkSMSession.

Definition at line 87 of file vtkSMSessionClient.h.

◆ GetController()

vtkMultiProcessController* vtkSMSessionClient::GetController ( ServerFlags  processType)
overridevirtual

Returns the controller used to communicate with the process.

Value must be DATA_SERVER_ROOT or RENDER_SERVER_ROOT or CLIENT.

Reimplemented from vtkPVSession.

◆ GetServerInformation()

vtkPVServerInformation* vtkSMSessionClient::GetServerInformation ( )
inlineoverridevirtual

vtkPVServerInformation is an information-object that provides information about the server processes.

These include server-side capabilities as well as server-side command line arguments e.g. tile-display parameters. Use this method to obtain the server-side information. Overridden to provide return the information gathered from data-server and render-server.

Reimplemented from vtkPVSessionBase.

Definition at line 103 of file vtkSMSessionClient.h.

◆ Initialize()

void vtkSMSessionClient::Initialize ( )
overridevirtual

Called to do any initializations after a successful session has been established.

Initialize the data-server-render-server connection, if applicable.

Reimplemented from vtkSMSession.

◆ PushState()

void vtkSMSessionClient::PushState ( vtkSMMessage msg)
overridevirtual

Push the state.

Reimplemented from vtkSMSession.

◆ PullState()

void vtkSMSessionClient::PullState ( vtkSMMessage message)
overridevirtual

Push the state.

Reimplemented from vtkPVSessionBase.

◆ ExecuteStream()

void vtkSMSessionClient::ExecuteStream ( vtkTypeUInt32  location,
const vtkClientServerStream stream,
bool  ignore_errors = false 
)
overridevirtual

Push the state.

Reimplemented from vtkPVSessionBase.

◆ GetLastResult()

const vtkClientServerStream& vtkSMSessionClient::GetLastResult ( vtkTypeUInt32  location)
overridevirtual

Push the state.

Reimplemented from vtkPVSessionBase.

◆ SetAbortConnect()

virtual void vtkSMSessionClient::SetAbortConnect ( bool  )
virtual

When Connect() is waiting for a server to connect back to the client (in reverse connect mode), then it periodically fires ProgressEvent.

Application can add observer to this signal and set this flag to true, if it wants to abort the wait for the server.

◆ CloseSession()

void vtkSMSessionClient::CloseSession ( )

Gracefully exits the session.

◆ GatherInformation()

bool vtkSMSessionClient::GatherInformation ( vtkTypeUInt32  location,
vtkPVInformation information,
vtkTypeUInt32  globalid 
)
overridevirtual

Gather information about an object referred by the globalid.

location identifies the processes to gather the information from. Overridden to fetch the information from server if needed, otherwise it's handled locally.

Reimplemented from vtkPVSessionBase.

◆ GetNumberOfProcesses()

int vtkSMSessionClient::GetNumberOfProcesses ( vtkTypeUInt32  servers)
overridevirtual

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

If more than 1 server is identified, than 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.

Reimplemented from vtkSMSession.

◆ IsMPIInitialized()

bool vtkSMSessionClient::IsMPIInitialized ( vtkTypeUInt32  servers)
overridevirtual

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

◆ PreDisconnection()

void vtkSMSessionClient::PreDisconnection ( )
overridevirtual

Reimplemented from vtkSMSession.

◆ IsNotBusy()

virtual bool vtkSMSessionClient::IsNotBusy ( )
virtual

Flag used to know if it is a good time to handle server notification.

◆ StartBusyWork()

virtual void vtkSMSessionClient::StartBusyWork ( )
virtual

BusyWork should be declared inside method that will request several network call that we don't want to interrupt such as GatherInformation and Pull.

◆ EndBusyWork()

virtual void vtkSMSessionClient::EndBusyWork ( )
virtual

BusyWork should be declared inside method that will request several network call that we don't want to interrupt such as GatherInformation and Pull.

◆ GetCollaborationManager()

vtkSMCollaborationManager* vtkSMSessionClient::GetCollaborationManager ( )
overridevirtual

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

Reimplemented from vtkSMSession.

◆ PrepareProgressInternal()

void vtkSMSessionClient::PrepareProgressInternal ( )
overridevirtual

Should be called to begin/end receiving progresses on this session.

Overridden to relay to the server(s).

Reimplemented from vtkPVSessionBase.

◆ CleanupPendingProgressInternal()

void vtkSMSessionClient::CleanupPendingProgressInternal ( )
overridevirtual

Should be called to begin/end receiving progresses on this session.

Overridden to relay to the server(s).

Reimplemented from vtkPVSessionBase.

◆ GetConnectID()

int vtkSMSessionClient::GetConnectID ( )

Return the connect id of this client.

◆ GetNextGlobalUniqueIdentifier()

vtkTypeUInt32 vtkSMSessionClient::GetNextGlobalUniqueIdentifier ( )
overridevirtual

Provides the next available identifier.

This implementation works locally. without any code distribution. To support the distributed architecture the vtkSMSessionClient override those method to call them on the DATA_SERVER vtkPVSessionBase instance.

Reimplemented from vtkPVSessionBase.

◆ GetNextChunkGlobalUniqueIdentifier()

vtkTypeUInt32 vtkSMSessionClient::GetNextChunkGlobalUniqueIdentifier ( vtkTypeUInt32  chunkSize)
overridevirtual

Return the first Id of the requested chunk.

1 = ReverveNextIdChunk(10); | Reserved ids [1,2,3,4,5,6,7,8,9,10] 11 = ReverveNextIdChunk(10);| Reserved ids [11,12,13,14,15,16,17,18,19,20] b = a + 10;

Reimplemented from vtkPVSessionBase.

◆ OnServerNotificationMessageRMI()

void vtkSMSessionClient::OnServerNotificationMessageRMI ( void *  message,
int  message_length 
)

◆ SetRenderServerController()

void vtkSMSessionClient::SetRenderServerController ( vtkMultiProcessController )
protected

◆ SetDataServerController()

void vtkSMSessionClient::SetDataServerController ( vtkMultiProcessController )
protected

◆ SetupDataServerRenderServerConnection()

void vtkSMSessionClient::SetupDataServerRenderServerConnection ( )
protected

◆ UnRegisterSIObject()

void vtkSMSessionClient::UnRegisterSIObject ( vtkSMMessage msg)
overrideprotectedvirtual

Delete server side object.

(SIObject)

Reimplemented from vtkPVSessionBase.

◆ RegisterSIObject()

void vtkSMSessionClient::RegisterSIObject ( vtkSMMessage msg)
overrideprotectedvirtual

Notify server side object that it is used by one more client.

(SIObject)

Reimplemented from vtkPVSessionBase.

◆ GetRealLocation()

vtkTypeUInt32 vtkSMSessionClient::GetRealLocation ( vtkTypeUInt32  )
protected

Translates the location to a real location based on whether a separate render-server exists.

◆ SetURI()

virtual void vtkSMSessionClient::SetURI ( const char *  )
protectedvirtual

◆ OnWrongTagEvent()

bool vtkSMSessionClient::OnWrongTagEvent ( vtkObject caller,
unsigned long  eventid,
void *  calldata 
)
overrideprotectedvirtual

Callback when any vtkMultiProcessController subclass fires a WrongTagEvent.

Return true if the event was handle locally.

Reimplemented from vtkPVSession.

◆ OnConnectionLost()

virtual void vtkSMSessionClient::OnConnectionLost ( vtkObject caller,
unsigned long  eventid,
void *  calldata 
)
protectedvirtual

Callback when any vtkMultiProcessController subclass fires a ErrorEvent.

Member Data Documentation

◆ RenderServerController

vtkMultiProcessController* vtkSMSessionClient::RenderServerController
protected

Definition at line 255 of file vtkSMSessionClient.h.

◆ DataServerController

vtkMultiProcessController* vtkSMSessionClient::DataServerController
protected

Definition at line 256 of file vtkSMSessionClient.h.

◆ DataServerInformation

vtkPVServerInformation* vtkSMSessionClient::DataServerInformation
protected

Definition at line 258 of file vtkSMSessionClient.h.

◆ RenderServerInformation

vtkPVServerInformation* vtkSMSessionClient::RenderServerInformation
protected

Definition at line 259 of file vtkSMSessionClient.h.

◆ ServerInformation

vtkPVServerInformation* vtkSMSessionClient::ServerInformation
protected

Definition at line 260 of file vtkSMSessionClient.h.

◆ ServerLastInvokeResult

vtkClientServerStream* vtkSMSessionClient::ServerLastInvokeResult
protected

Definition at line 261 of file vtkSMSessionClient.h.

◆ AbortConnect

bool vtkSMSessionClient::AbortConnect
protected

Definition at line 263 of file vtkSMSessionClient.h.

◆ URI

char* vtkSMSessionClient::URI
protected

Definition at line 266 of file vtkSMSessionClient.h.

◆ NoMoreDelete

bool vtkSMSessionClient::NoMoreDelete
protected

Definition at line 272 of file vtkSMSessionClient.h.

◆ CollaborationCommunicator

vtkSMCollaborationManager* vtkSMSessionClient::CollaborationCommunicator
protected

Definition at line 275 of file vtkSMSessionClient.h.


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