vtkSocket.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkSocket.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 vtkSocket_h
#define vtkSocket_h
 
#include "vtkCommonSystemModule.h" // For export macro
#include "vtkObject.h"
 
class vtkSocketCollection;
class VTKCOMMONSYSTEM_EXPORT vtkSocket : public vtkObject
{
public:
  vtkTypeMacro(vtkSocket, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent);
 
  // ----- 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);
 
 
  static int SelectSockets(const int* sockets_to_select, int size,
    unsigned long msec, int* selected_index);
protected:
  vtkSocket();
  ~vtkSocket();
 
  int SocketDescriptor;
 
  //BTX
  friend class vtkSocketCollection;
  //ETX
 
  int CreateSocket();
 
  void CloseSocket(int socketdescriptor);
 
  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:
  vtkSocket(const vtkSocket&); // Not implemented.
  void operator=(const vtkSocket&); // Not implemented.
};
 
 
#endif