ParaView
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends
vtkPVSessionServer Class Reference

#include <vtkPVSessionServer.h>

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

List of all members.

Public Types

enum  {
  PUSH = 12, PULL = 13, EXECUTE_STREAM = 14, GATHER_INFORMATION = 15,
  REGISTER_SI = 16, UNREGISTER_SI = 17, LAST_RESULT = 18, SERVER_NOTIFICATION_MESSAGE_RMI = 55624,
  CLIENT_SERVER_MESSAGE_RMI = 55625, CLOSE_SESSION = 55626, REPLY_GATHER_INFORMATION_TAG = 55627, REPLY_PULL = 55628,
  REPLY_LAST_RESULT = 55629, EXECUTE_STREAM_TAG = 55630
}

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual vtkMultiProcessControllerGetController (ServerFlags processType)
virtual bool Connect (const char *url)
bool Connect ()
virtual bool GetIsAlive ()
void OnClientServerMessageRMI (void *message, int message_length)
void OnCloseSessionRMI ()
virtual void MultipleConnectionOn ()
virtual void MultipleConnectionOff ()
virtual void SetMultipleConnection (bool)
virtual bool GetMultipleConnection ()

Static Public Member Functions

static vtkPVSessionServerNew ()
static int IsTypeOf (const char *type)
static vtkPVSessionServerSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkPVSessionServer ()
 ~vtkPVSessionServer ()
void SendLastResultToClient ()
void SendToNonActiveClients (vtkSMMessage *msg)
void BroadcastToClients (vtkSMMessage *msg)
void GatherInformationInternal (vtkTypeUInt32 location, const char *classname, vtkTypeUInt32 globalid, vtkMultiProcessStream &)

Protected Attributes

vtkMPIMToNSocketConnectionMPIMToNSocketConnection
bool MultipleConnection
vtkInternals * Internal

Friends

class vtkSICollaborationManager
class vtkInternals

Detailed Description

vtkSMSessionServer is a session used on data and/or render servers. It's designed for a process that works with a separate client process that acts as the visualization driver.

See also:
vtkSMSessionClient

Definition at line 32 of file vtkPVSessionServer.h.


Member Enumeration Documentation

anonymous enum

Client-Server Communication tags.

Enumerator:
PUSH 
PULL 
EXECUTE_STREAM 
GATHER_INFORMATION 
REGISTER_SI 
UNREGISTER_SI 
LAST_RESULT 
SERVER_NOTIFICATION_MESSAGE_RMI 
CLIENT_SERVER_MESSAGE_RMI 
CLOSE_SESSION 
REPLY_GATHER_INFORMATION_TAG 
REPLY_PULL 
REPLY_LAST_RESULT 
EXECUTE_STREAM_TAG 

Definition at line 66 of file vtkPVSessionServer.h.


Constructor & Destructor Documentation

vtkPVSessionServer::vtkPVSessionServer ( ) [protected]
vtkPVSessionServer::~vtkPVSessionServer ( ) [protected]

Member Function Documentation

static vtkPVSessionServer* vtkPVSessionServer::New ( ) [static]

Reimplemented from vtkObject.

virtual const char* vtkPVSessionServer::GetClassName ( ) [virtual]

Reimplemented from vtkPVSessionBase.

static int vtkPVSessionServer::IsTypeOf ( const char *  type) [static]

Reimplemented from vtkPVSessionBase.

virtual int vtkPVSessionServer::IsA ( const char *  type) [virtual]

Reimplemented from vtkPVSessionBase.

static vtkPVSessionServer* vtkPVSessionServer::SafeDownCast ( vtkObject o) [static]

Reimplemented from vtkPVSessionBase.

void vtkPVSessionServer::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

Reimplemented from vtkPVSessionBase.

virtual vtkMultiProcessController* vtkPVSessionServer::GetController ( ServerFlags  processType) [virtual]

Returns the active controller used to communicate with the process. Value must be DATA_SERVER_ROOT or RENDER_SERVER_ROOT or CLIENT. But only the CLIENT do return something different than NULL;

Reimplemented from vtkPVSession.

virtual bool vtkPVSessionServer::Connect ( const char *  url) [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-hos t>:<pvrenderserver-port> In this case, the hostname is irrelevant and is ignored.

bool vtkPVSessionServer::Connect ( )

Overload that constructs the url using the command line parameters specified and then calls Connect(url).

virtual bool vtkPVSessionServer::GetIsAlive ( ) [virtual]

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

Implements vtkSession.

virtual void vtkPVSessionServer::MultipleConnectionOn ( ) [virtual]

Enable or Disable multi-connection support. The MultipleConnection is only used inside the DATA_SERVER to support several clients to connect to it. By default we allow collaboration (this->MultipleConnection = true)

virtual void vtkPVSessionServer::MultipleConnectionOff ( ) [virtual]

Enable or Disable multi-connection support. The MultipleConnection is only used inside the DATA_SERVER to support several clients to connect to it. By default we allow collaboration (this->MultipleConnection = true)

virtual void vtkPVSessionServer::SetMultipleConnection ( bool  ) [virtual]

Enable or Disable multi-connection support. The MultipleConnection is only used inside the DATA_SERVER to support several clients to connect to it. By default we allow collaboration (this->MultipleConnection = true)

virtual bool vtkPVSessionServer::GetMultipleConnection ( ) [virtual]

Enable or Disable multi-connection support. The MultipleConnection is only used inside the DATA_SERVER to support several clients to connect to it. By default we allow collaboration (this->MultipleConnection = true)

void vtkPVSessionServer::OnClientServerMessageRMI ( void *  message,
int  message_length 
)
void vtkPVSessionServer::OnCloseSessionRMI ( )
void vtkPVSessionServer::GatherInformationInternal ( vtkTypeUInt32  location,
const char *  classname,
vtkTypeUInt32  globalid,
vtkMultiProcessStream  
) [protected]

Called when client triggers GatherInformation().

void vtkPVSessionServer::SendLastResultToClient ( ) [protected]

Sends the last result to client.

void vtkPVSessionServer::SendToNonActiveClients ( vtkSMMessage msg) [protected]
void vtkPVSessionServer::BroadcastToClients ( vtkSMMessage msg) [protected]

Friends And Related Function Documentation

friend class vtkSICollaborationManager [friend]

Definition at line 117 of file vtkPVSessionServer.h.

friend class vtkInternals [friend]

Definition at line 123 of file vtkPVSessionServer.h.


Member Data Documentation

Definition at line 112 of file vtkPVSessionServer.h.

Definition at line 114 of file vtkPVSessionServer.h.

vtkInternals* vtkPVSessionServer::Internal [protected]

Definition at line 121 of file vtkPVSessionServer.h.


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