pqServer.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-FileCopyrightText: Copyright (c) Sandia Corporation
// SPDX-License-Identifier: BSD-3-Clause
#ifndef pqServer_h
#define pqServer_h
 
class vtkObject;
class pqTimeKeeper;
class vtkProcessModule;
class vtkPVServerInformation;
class vtkPVXMLElement;
class vtkSMApplication;
class vtkSMProxy;
class vtkSMProxySelectionModel;
class vtkSMRenderViewProxy;
class vtkSMSession;
class vtkSMSessionProxyManager;
 
#include "pqCoreModule.h"
#include "pqServerManagerModelItem.h"
#include "pqServerResource.h"
#include "pqTimer.h"
#include "vtkSMMessageMinimal.h"
#include "vtkSmartPointer.h"
#include "vtkWeakPointer.h"
 
#include <QPointer>
 
class PQCORE_EXPORT pqServer : public pqServerManagerModelItem
{
  Q_OBJECT
public:
  pqServer(vtkIdType connectionId, QObject* parent = nullptr);
  ~pqServer() override;
 
  const pqServerResource& getResource();
  void setResource(const pqServerResource& server_resource);
 
  vtkSMSession* session() const;
 
  vtkIdType GetConnectionID() const;
  vtkIdType sessionId() const { return this->GetConnectionID(); }
 
  vtkSMSessionProxyManager* proxyManager() const;
 
  vtkSMProxySelectionModel* activeSourcesSelectionModel() const;
 
  vtkSMProxySelectionModel* activeViewSelectionModel() const;
 
  int getNumberOfPartitions();
 
  bool isRemote() const;
 
  bool isMaster() const;
 
  bool isProcessingPending() const;
 
  bool isRenderServerSeparate();
 
  pqTimeKeeper* getTimeKeeper() const;
 
  vtkPVServerInformation* getServerInformation() const;
 
  bool isProgressPending() const;
 
  static void setHeartBeatTimeoutSetting(int msec);
  static int getHeartBeatTimeoutSetting();
 
  void setMonitorServerNotifications(bool);
 
  int getRemainingLifeTime() const;
 
  void setRemainingLifeTime(int value);
 
Q_SIGNALS:
  void nameChanged(pqServerManagerModelItem*);
 
  void fiveMinuteTimeoutWarning();
 
  void finalTimeoutWarning();
 
  void serverSideDisconnected();
 
protected:
  static const char* HEARBEAT_TIME_SETTING_KEY();
 
  void setHeartBeatTimeout(int msec);
 
  // ---- Collaboration client-to-clients communication mechanisme ----
 
Q_SIGNALS:
  void sentFromOtherClient(pqServer*, vtkSMMessage* msg);
 
  void triggeredMasterUser(int);
  void triggeredUserName(int, QString&);
  void triggeredUserListChanged();
  void triggerFollowCamera(int);
 
public Q_SLOTS:
  void sendToOtherClients(vtkSMMessage* msg);
 
  // ---- Collaboration client-to-clients communication mechanisme ----
 
protected Q_SLOTS:
  void heartBeat();
 
  void updateRemainingLifeTime();
 
  void processServerNotification();
 
  void onCollaborationCommunication(vtkObject*, unsigned long, void*, void*);
 
  void onConnectionLost(vtkObject*, unsigned long, void*, void*);
 
private:
  Q_DISABLE_COPY(pqServer)
 
  pqServerResource Resource;
  vtkIdType ConnectionID;
  vtkWeakPointer<vtkSMSession> Session;
  vtkSmartPointer<vtkSMProxy> ExecutableRunnerProxy;
 
  pqTimer IdleCollaborationTimer;
 
  class pqInternals;
  pqInternals* Internals;
};
 
#endif // !pqServer_h