pqServerResource.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 pqServerResource_h
#define pqServerResource_h
 
#include "pqCoreModule.h"
 
#include "vtkParaViewDeprecation.h" // for PARAVIEW_DEPRECATED_IN_5_11_0
 
#include <QString>
class pqServerConfiguration;
 
class PQCORE_EXPORT pqServerResource
{
public:
  pqServerResource();
  ~pqServerResource();
  pqServerResource& operator=(const pqServerResource&);
 
  pqServerResource(const QString& uri);
 
  pqServerResource(const QString& uri, const pqServerConfiguration& config);
 
  pqServerResource(const pqServerResource&);
 
  const pqServerConfiguration& configuration() const;
 
  QString toURI() const;
 
  QString serializeString() const;
 
  QString scheme() const;
 
  void setScheme(const QString&);
 
  bool isReverse() const;
 
  QString host() const;
 
  void setHost(const QString&);
 
  int port() const;
 
  int port(int default_port) const;
 
  void setPort(int);
 
  QString dataServerHost() const;
 
  void setDataServerHost(const QString&);
 
  int dataServerPort() const;
 
  int dataServerPort(int default_port) const;
 
  void setDataServerPort(int);
 
  QString renderServerHost() const;
 
  void setRenderServerHost(const QString&);
 
  int renderServerPort() const;
 
  int renderServerPort(int default_port) const;
 
  void setRenderServerPort(int);
 
  QString path() const;
 
  void setPath(const QString&);
 
  QString serverName() const;
 
  void setServerName(const QString& name);
 
  void addData(const QString& key, const QString& value);
 
  QString data(const QString& key) const;
 
  QString data(const QString& key, const QString& default_value) const;
 
  bool hasData(const QString& key) const;
 
  pqServerResource schemeHostsPorts() const;
 
  pqServerResource schemeHosts() const;
 
  pqServerResource hostPath() const;
 
  pqServerResource pathServerName() const;
 
  PARAVIEW_DEPRECATED_IN_5_11_0("Use the resource directly instead")
  pqServerResource sessionServer() const { return *this; };
 
  PARAVIEW_DEPRECATED_IN_5_11_0("Use the resource directly instead")
  void setSessionServer(const pqServerResource&){};
 
 
  bool operator==(const pqServerResource&) const;
  bool operator!=(const pqServerResource&) const;
  bool operator<(const pqServerResource&) const;
 
private:
  class pqImplementation;
  pqImplementation* const Implementation;
};
 
#endif