vtkPVSession.h

Go to the documentation of this file.

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

#include "vtkObject.h"
#include "vtkParaViewDeprecation.h" // for PARAVIEW_DEPRECATED
#include "vtkRemotingCoreModule.h"  //needed for exports

class vtkMPIMToNSocketConnection;
class vtkMultiProcessController;
class vtkPVProgressHandler;
class vtkPVServerInformation;

class VTKREMOTINGCORE_EXPORT vtkPVSession : public vtkObject
{
public:
  vtkTypeMacro(vtkPVSession, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  virtual bool GetIsAlive() = 0;

  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
  };

  virtual ServerFlags GetProcessRoles();

  bool HasProcessRole(vtkTypeUInt32 flag)
  {
    return ((flag & static_cast<vtkTypeUInt32>(this->GetProcessRoles())) == flag);
  }

  virtual vtkMultiProcessController* GetController(ServerFlags processType);

  virtual vtkMPIMToNSocketConnection* GetMPIMToNSocketConnection() { return nullptr; }

  virtual vtkPVServerInformation* GetServerInformation() = 0;

  virtual bool IsMultiClients();


  vtkGetObjectMacro(ProgressHandler, vtkPVProgressHandler);


  void PrepareProgress();
  void CleanupPendingProgress();

  bool GetPendingProgress();

protected:
  vtkPVSession();
  ~vtkPVSession() override;

  enum
  {
    EXCEPTION_EVENT_TAG = 31416
  };

  virtual bool OnWrongTagEvent(vtkObject* caller, unsigned long eventid, void* calldata);


  virtual void PrepareProgressInternal();
  virtual void CleanupPendingProgressInternal();

  virtual void Activate();

  virtual void DeActivate();

  vtkPVProgressHandler* ProgressHandler;

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

  int ProgressCount;
  // This flags ensures that while we are waiting for an previous progress-pair
  // to finish, we don't start new progress-pairs.
  bool InCleanupPendingProgress;
};

PARAVIEW_DEPRECATED_IN_6_1_0("Please use the `vtkPVSession` class instead.")
typedef vtkPVSession vtkSession;

#endif