/usr/include/openigtlink/igtlSocket.h is in libopenigtlink1-dev 1.9.2~svn7468-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 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 | /*=========================================================================
Program: Open IGT Link Library
Module: $HeadURL: http://svn.na-mic.org/NAMICSandBox/trunk/OpenIGTLink/Source/igtlSocket.h $
Language: C++
Date: $Date: 2010-06-09 16:16:36 -0400 (Wed, 09 Jun 2010) $
Version: $Revision: 6525 $
Copyright (c) Insight Software Consortium. All rights reserved.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notices for more information.
=========================================================================*/
/*=========================================================================
Program: Visualization Toolkit
Module: $RCSfile: igtlSocket.h,v $
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.
=========================================================================*/
/** \class Socket
* \brief BSD socket encapsulation.
*
* This abstract class encapsulates a BSD socket.
* It provides an API for basic socket operations.
*
* This class was largely based on the igtlSocket class
* from the Visualization Toolkit VTK.
*
*/
#ifndef __igtlSocket_h
#define __igtlSocket_h
#include "igtlObject.h"
#include "igtlObjectFactory.h"
#include "igtlMacro.h"
#include "igtlWin32Header.h"
namespace igtl
{
class SocketCollection;
// class IGTL_EXPORT Socket
class IGTLCommon_EXPORT Socket : public Object
{
public:
typedef Socket Self;
typedef Object Superclass;
typedef SmartPointer<Self> Pointer;
typedef SmartPointer<const Self> ConstPointer;
igtlTypeMacro(igtl::Socket, igtl::Object)
igtlNewMacro(igtl::Socket);
public:
// ----- Status API ----
// Description:
// Check is the socket is alive.
int GetConnected() { return (this->m_SocketDescriptor >=0); }
// Description:
// Close the socket.
void CloseSocket() {this->CloseSocket(this->m_SocketDescriptor);}
// ------ 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:
// Skip reading data from the socket.
// The Skip() call has been newly introduced to the igtlSocket,
// after the class is imported from VTK, thus the call is
// not available in vtkSocket class.
int Skip(int length, int skipFully=1);
protected:
Socket();
~Socket();
void PrintSelf(std::ostream& os) const;
int m_SocketDescriptor;
igtlGetMacro(SocketDescriptor, int);
//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);
// 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);
private:
Socket(const Socket&); // Not implemented.
void operator=(const Socket&); // Not implemented.
};
}
#endif
|