vtkTCPNetworkAccessManager.h

Go to the documentation of this file.

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

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

class vtkMultiProcessController;

class VTKREMOTINGCORE_EXPORT vtkTCPNetworkAccessManager : public vtkNetworkAccessManager
{
public:
  static vtkTCPNetworkAccessManager* New();
  vtkTypeMacro(vtkTCPNetworkAccessManager, vtkNetworkAccessManager);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  using vtkNetworkAccessManager::NewConnection;
  vtkMultiProcessController* NewConnection(
    const char* url, vtkNetworkAccessManager::ConnectionResult& result) override;

  void AbortPendingConnection() override;

  int ProcessEvents(unsigned long timeout_msecs) override;

  bool GetNetworkEventsAvailable() override;

  bool GetPendingConnectionsPresent() override;

  void DisableFurtherConnections(int port, bool disable) override;

  bool GetWrongConnectID() override;

protected:
  vtkTCPNetworkAccessManager();
  ~vtkTCPNetworkAccessManager() override;

  // used by GetPendingConnectionsPresent and ProcessEvents
  int ProcessEventsInternal(unsigned long timeout_msecs, bool do_processing);

  vtkMultiProcessController* ConnectToRemote(const char* hostname, int port, const char* handshake,
    int timeout_in_seconds, vtkNetworkAccessManager::ConnectionResult& result);

  vtkMultiProcessController* WaitForConnection(int port, bool once, const char* handshake,
    bool nonblocking, vtkNetworkAccessManager::ConnectionResult& result);

  enum HandshakeErrors
  {
    HANDSHAKE_NO_ERROR = 0,
    HANDSHAKE_SOCKET_COMMUNICATOR_DIFFERENT,
    HANDSHAKE_DIFFERENT_PV_VERSIONS,
    HANDSHAKE_DIFFERENT_CONNECTION_IDS,
    HANDSHAKE_DIFFERENT_RENDERING_BACKENDS,
    HANDSHAKE_UNKNOWN_ERROR
  };

  int ParaViewHandshake(
    vtkMultiProcessController* controller, bool server_side, const char* handshake);
  void PrintHandshakeError(int errorcode, bool server_side);
  int AnalyzeHandshakeAndGetErrorCode(const char* clientHS, const char* serverHS);

  bool AbortPendingConnectionFlag;
  bool WrongConnectID;

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

  class vtkInternals;
  vtkInternals* Internals;
};

#endif