vtkSocketController.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkSocketController.h

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
#ifndef vtkSocketController_h
#define vtkSocketController_h

#include "vtkParallelCoreModule.h" // For export macro
#include "vtkMultiProcessController.h"

class vtkSocketCommunicator;

class VTKPARALLELCORE_EXPORT vtkSocketController : public vtkMultiProcessController
{
public:
  static vtkSocketController *New();
  vtkTypeMacro(vtkSocketController,vtkMultiProcessController);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void Initialize(int* argc, char*** argv, int) override
    { this->Initialize(argc,argv); }
  void Initialize(int* argc, char*** argv) override;
  virtual void Initialize()
    { this->Initialize(nullptr,nullptr); }

  void Finalize() override {}
  void Finalize(int) override {}

  void SingleMethodExecute() override {}

  void MultipleMethodExecute() override {}

  void CreateOutputWindow() override {}

  virtual int WaitForConnection(int port);

  virtual void CloseConnection();

  virtual int ConnectTo(const char* hostName, int port );

  int GetSwapBytesInReceivedData();

  void SetCommunicator(vtkSocketCommunicator* comm);

  vtkMultiProcessController *CreateCompliantController();

  enum Consts {
    ENDIAN_TAG=1010580540,      // 0x3c3c3c3c
    IDTYPESIZE_TAG=1027423549,  // 0x3d3d3d3d
    VERSION_TAG=1044266558,     // 0x3e3e3e3e
    HASH_TAG=0x3f3f3f3f
  };

protected:

  vtkSocketController();
  ~vtkSocketController() override;

  // Initialize only once, finialize on destruction.
  static int Initialized;
private:
  vtkSocketController(const vtkSocketController&) = delete;
  void operator=(const vtkSocketController&) = delete;
};


#endif // vtkSocketController_h