/usr/include/vtk-5.10/vtkSocket.h is in libvtk5-dev 5.10.1+dfsg-2.1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 | /*=========================================================================
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.
=========================================================================*/
// .NAME vtkSocket - BSD socket encapsulation.
// .SECTION Description
// This abstract class encapsulates a BSD socket. It provides an API for
// basic socket operations.
#ifndef __vtkSocket_h
#define __vtkSocket_h
#include "vtkObject.h"
class vtkSocketCollection;
class VTK_COMMON_EXPORT vtkSocket : public vtkObject
{
public:
vtkTypeMacro(vtkSocket, vtkObject);
void PrintSelf(ostream& os, vtkIndent indent);
// ----- Status API ----
// Description:
// Check is the socket is alive.
int GetConnected() { return (this->SocketDescriptor >=0); }
// Description:
// Close the socket.
void CloseSocket();
// ------ Communication API ---
// Description:
// These methods send data over the socket.
// Returns 1 on success, 0 on error and raises vtkCommand::ErrorEvent.
int Send(const void* data, int length);
// Description:
// Receive data from the socket.
// This call blocks until some data is read from the socket.
// When readFully is set, this call will block until all the
// requested data is read from the socket.
// 0 on error, else number of bytes read is returned. On error,
// vtkCommand::ErrorEvent is raised.
int Receive(void* data, int length, int readFully=1);
// Description:
// Provides access to the internal socket descriptor. This is valid only when
// GetConnected() returns true.
vtkGetMacro(SocketDescriptor, int);
// Description:
// Selects set of sockets. Returns 0 on timeout, -1 on error.
// 1 on success. Selected socket's index is returned thru
// selected_index
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
// Description:
// Creates an endpoint for communication and returns the descriptor.
// -1 indicates error.
int CreateSocket();
// Description:
// Close the socket.
void CloseSocket(int socketdescriptor);
// Description:
// Binds socket to a particular port.
// Returns 0 on success other -1 is returned.
int BindSocket(int socketdescriptor, int port);
// Description:
// Selects a socket ie. waits for it to change status.
// Returns 1 on success; 0 on timeout; -1 on error. msec=0 implies
// no timeout.
int SelectSocket(int socketdescriptor, unsigned long msec);
// Description:
// Accept a connection on a socket. Returns -1 on error. Otherwise
// the descriptor of the accepted socket.
int Accept(int socketdescriptor);
// Description:
// Listen for connections on a socket. Returns 0 on success. -1 on error.
int Listen(int socketdescriptor);
// Description:
// Connect to a server socket. Returns 0 on success, -1 on error.
int Connect(int socketdescriptor, const char* hostname, int port);
// Description:
// Returns the port to which the socket is connected.
// 0 on error.
int GetPort(int socketdescriptor);
private:
vtkSocket(const vtkSocket&); // Not implemented.
void operator=(const vtkSocket&); // Not implemented.
};
#endif
|