vtkNetworkAccessManager.h

Go to the documentation of this file.

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

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

class vtkMultiProcessController;

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

  enum class ConnectionResult
  {
    CONNECTION_SUCCESS,
    CONNECTION_TIMEOUT,
    CONNECTION_ABORT,
    CONNECTION_HANDSHAKE_ERROR,
    CONNECTION_FAILURE
  };


  virtual vtkMultiProcessController* NewConnection(const char* url)
  {
    ConnectionResult result;
    return this->NewConnection(url, result);
  }
  virtual vtkMultiProcessController* NewConnection(const char* url, ConnectionResult& result) = 0;

  virtual void AbortPendingConnection() = 0;

  virtual int ProcessEvents(unsigned long timeout_msecs) = 0;

  virtual bool GetNetworkEventsAvailable() = 0;

  virtual bool GetPendingConnectionsPresent() = 0;

  virtual void DisableFurtherConnections(int port, bool disable) = 0;

  virtual bool GetWrongConnectID() = 0;

protected:
  vtkNetworkAccessManager();
  ~vtkNetworkAccessManager() override;

private:
  vtkNetworkAccessManager(const vtkNetworkAccessManager&) = delete;
  void operator=(const vtkNetworkAccessManager&) = delete;
};

#endif