vtkPVSessionCore.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkPVSessionCore_h
#define vtkPVSessionCore_h

#include "vtkObject.h"
#include "vtkRemotingServerManagerModule.h" //needed for exports
#include "vtkSMMessageMinimal.h"            // needed for vtkSMMessage.
#include "vtkWeakPointer.h"                 // needed for vtkMultiProcessController

class vtkClientServerInterpreter;
class vtkClientServerStream;
class vtkCollection;
class vtkMPIMToNSocketConnection;
class vtkMultiProcessController;
class vtkPVInformation;
class vtkSIObject;
class vtkSIProxyDefinitionManager;

class VTKREMOTINGSERVERMANAGER_EXPORT vtkPVSessionCore : public vtkObject
{
public:
  static vtkPVSessionCore* New();
  vtkTypeMacro(vtkPVSessionCore, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  vtkGetObjectMacro(Interpreter, vtkClientServerInterpreter);


  vtkGetObjectMacro(ProxyDefinitionManager, vtkSIProxyDefinitionManager);

  virtual void PushState(vtkSMMessage* message);

  virtual void PullState(vtkSMMessage* message);

  virtual void ExecuteStream(
    vtkTypeUInt32 location, const vtkClientServerStream& stream, bool ignore_errors = false);

  virtual const vtkClientServerStream& GetLastResult();

  virtual void UnRegisterSIObject(vtkSMMessage* message);

  virtual void RegisterSIObject(vtkSMMessage* message);

  vtkSIObject* GetSIObject(vtkTypeUInt32 globalid);

  vtkObject* GetRemoteObject(vtkTypeUInt32 globalid);

  void RegisterRemoteObject(vtkTypeUInt32 globalid, vtkObject* obj);

  void UnRegisterRemoteObject(vtkTypeUInt32 globalid);

  virtual bool GatherInformation(
    vtkTypeUInt32 location, vtkPVInformation* information, vtkTypeUInt32 globalid);

  int GetNumberOfProcesses();


  void SetMPIMToNSocketConnection(vtkMPIMToNSocketConnection*);
  vtkGetObjectMacro(MPIMToNSocketConnection, vtkMPIMToNSocketConnection);

  virtual vtkTypeUInt32 GetNextGlobalUniqueIdentifier();

  virtual vtkTypeUInt32 GetNextChunkGlobalUniqueIdentifier(vtkTypeUInt32 chunkSize);

  enum MessageTypes
  {
    PUSH_STATE = 12,
    PULL_STATE = 13,
    EXECUTE_STREAM = 14,
    GATHER_INFORMATION = 15,
    REGISTER_SI = 16,
    UNREGISTER_SI = 17,
  };
  // Methods used to managed MPI satellite
  void PushStateSatelliteCallback();
  void ExecuteStreamSatelliteCallback();
  void GatherInformationStatelliteCallback();
  void RegisterSIObjectSatelliteCallback();
  void UnRegisterSIObjectSatelliteCallback();

  virtual void GetAllRemoteObjects(vtkCollection* collection);

  void GarbageCollectSIObject(int* clientIds, int nbClients);

protected:
  vtkPVSessionCore();
  ~vtkPVSessionCore() override;

  virtual void PushStateInternal(vtkSMMessage*);

  virtual void ExecuteStreamInternal(const vtkClientServerStream& stream, bool ignore_errors);

  bool GatherInformationInternal(vtkPVInformation* information, vtkTypeUInt32 globalid);

  bool CollectInformation(vtkPVInformation*);

  virtual void RegisterSIObjectInternal(vtkSMMessage* message);

  virtual void UnRegisterSIObjectInternal(vtkSMMessage* message);

  void OnInterpreterError(vtkObject*, unsigned long, void* calldata);

  enum
  {
    ROOT_SATELLITE_RMI_TAG = 887822,
    ROOT_SATELLITE_INFO_TAG = 887823
  };

  vtkSIProxyDefinitionManager* ProxyDefinitionManager;
  vtkWeakPointer<vtkMultiProcessController> ParallelController;
  vtkClientServerInterpreter* Interpreter;
  vtkMPIMToNSocketConnection* MPIMToNSocketConnection;

private:
  vtkPVSessionCore(const vtkPVSessionCore&) = delete;
  void operator=(const vtkPVSessionCore&) = delete;

  class vtkInternals;
  vtkInternals* Internals;
  bool SymmetricMPIMode;

  // Local counter for global Ids
  vtkTypeUInt32 LocalGlobalID;

  ostream* LogStream;
};

#endif