vtkSMSessionClient.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkSMSessionClient_h
#define vtkSMSessionClient_h
 
#include "vtkRemotingServerManagerModule.h" //needed for exports
#include "vtkSMSession.h"
 
class vtkMultiProcessController;
class vtkPVServerInformation;
class vtkSMCollaborationManager;
class vtkSMProxyLocator;
class vtkSMProxyManager;
 
class VTKREMOTINGSERVERMANAGER_EXPORT vtkSMSessionClient : public vtkSMSession
{
public:
  static vtkSMSessionClient* New();
  vtkTypeMacro(vtkSMSessionClient, vtkSMSession);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  const char* GetURI() override { return this->URI; };
 
 
  virtual bool Connect(const char* url, int timeout = 60)
  {
    vtkNetworkAccessManager::ConnectionResult result;
    return this->Connect(url, timeout, nullptr, result);
  }
  virtual bool Connect(const char* url, int timeout, bool (*callback)(),
    vtkNetworkAccessManager::ConnectionResult& connectionResult);
 
  bool GetIsAlive() override;
 
  ServerFlags GetProcessRoles() override { return CLIENT; }
 
  vtkMultiProcessController* GetController(ServerFlags processType) override;
 
  vtkPVServerInformation* GetServerInformation() override { return this->ServerInformation; }
 
  void Initialize() override;
 
 
  void PushState(vtkSMMessage* msg) override;
  void PullState(vtkSMMessage* message) override;
  void ExecuteStream(vtkTypeUInt32 location, const vtkClientServerStream& stream,
    bool ignore_errors = false) override;
  const vtkClientServerStream& GetLastResult(vtkTypeUInt32 location) override;
 
 
  vtkSetMacro(AbortConnect, bool);
 
  void CloseSession();
 
  bool GatherInformation(
    vtkTypeUInt32 location, vtkPVInformation* information, vtkTypeUInt32 globalid) override;
 
  int GetNumberOfProcesses(vtkTypeUInt32 servers) override;
 
  bool IsMPIInitialized(vtkTypeUInt32 servers) override;
 
  //---------------------------------------------------------------------------
  // API for Collaboration management
  //---------------------------------------------------------------------------
 
  // Called before application quit or session disconnection
  // Used to prevent quitting client to delete proxy of a running session.
  void PreDisconnection() override;
 
  virtual bool IsNotBusy();
  virtual void StartBusyWork();
  virtual void EndBusyWork();
 
  vtkSMCollaborationManager* GetCollaborationManager() override;
 
 
  void PrepareProgressInternal() override;
  void CleanupPendingProgressInternal() override;
 
  int GetConnectID();
 
  //---------------------------------------------------------------------------
  // API for GlobalId management
  //---------------------------------------------------------------------------
 
  vtkTypeUInt32 GetNextGlobalUniqueIdentifier() override;
 
  vtkTypeUInt32 GetNextChunkGlobalUniqueIdentifier(vtkTypeUInt32 chunkSize) override;
 
  void OnServerNotificationMessageRMI(void* message, int message_length);
 
protected:
  vtkSMSessionClient();
  ~vtkSMSessionClient() override;
 
  void SetRenderServerController(vtkMultiProcessController*);
  void SetDataServerController(vtkMultiProcessController*);
 
  void SetupDataServerRenderServerConnection();
 
  void UnRegisterSIObject(vtkSMMessage* msg) override;
 
  void RegisterSIObject(vtkSMMessage* msg) override;
 
  vtkTypeUInt32 GetRealLocation(vtkTypeUInt32);
 
  // Both maybe the same when connected to pvserver.
  vtkMultiProcessController* RenderServerController;
  vtkMultiProcessController* DataServerController;
 
  vtkPVServerInformation* DataServerInformation;
  vtkPVServerInformation* RenderServerInformation;
  vtkPVServerInformation* ServerInformation;
  vtkClientServerStream* ServerLastInvokeResult;
 
  vtkSetStringMacro(URI);
 
  bool AbortConnect;
  char* URI;
 
  // This flag allow us to disable remote Object deletion in a collaboration
  // context when a client is leaving a visalization session.
  // Typically we don't want this client to broadcast to the other to delete all
  // the proxy because it does not need them anymore as it is leaving...
  bool NoMoreDelete;
 
  // Field used to communicate with other clients
  vtkSMCollaborationManager* CollaborationCommunicator;
 
  bool OnWrongTagEvent(vtkObject* caller, unsigned long eventid, void* calldata) override;
 
  virtual void OnConnectionLost(vtkObject* caller, unsigned long eventid, void* calldata);
 
private:
  vtkSMSessionClient(const vtkSMSessionClient&) = delete;
  void operator=(const vtkSMSessionClient&) = delete;
 
  int NotBusy;
  vtkTypeUInt32 LastGlobalID;
  vtkTypeUInt32 LastGlobalIDAvailable;
};
 
#endif