vtkSocket.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
 
#ifndef vtkSocket_h
#define vtkSocket_h
 
#include "vtkCommonSystemModule.h" // For export macro
#include "vtkObject.h"
 
VTK_ABI_NAMESPACE_BEGIN
class vtkSocketCollection;
class VTKCOMMONSYSTEM_EXPORT vtkSocket : public vtkObject
{
public:
  vtkTypeMacro(vtkSocket, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  // ----- Status API ----
  int GetConnected() { return (this->SocketDescriptor >= 0); }

  void CloseSocket();
 
  // ------ Communication API ---
  int Send(const void* data, int length);

  int Receive(void* data, int length, int readFully = 1);

  vtkGetMacro(SocketDescriptor, int);

  vtkGetMacro(BoundAddress, std::string);

  static int SelectSockets(
    const int* sockets_to_select, int size, unsigned long msec, int* selected_index);
 
protected:
  vtkSocket();
  ~vtkSocket() override;
 
  int SocketDescriptor;
 
  friend class vtkSocketCollection;

  int CreateSocket();

  void CloseSocket(int socketdescriptor);


  int BindSocket(int socketdescriptor, int port, const std::string& bindAddr);
  int BindSocket(int socketdescriptor, int port);

  int SelectSocket(int socketdescriptor, unsigned long msec);

  int Accept(int socketdescriptor);

  int Listen(int socketdescriptor);

  int Connect(int socketdescriptor, const char* hostname, int port);

  int GetPort(int socketdescriptor);
 
private:
  std::string BoundAddress;
 
  vtkSocket(const vtkSocket&) = delete;
  void operator=(const vtkSocket&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif