/usr/include/sipxtapi/os/OsSocket.h is in libsipxtapi-dev 3.3.0~test17-2.1.
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 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 | //
// Copyright (C) 2004-2006 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// Copyright (C) 2004-2006 Pingtel Corp. All rights reserved.
// Licensed to SIPfoundry under a Contributor Agreement.
//
// $$
///////////////////////////////////////////////////////////////////////////////
#ifndef _OsSocket_h_
#define _OsSocket_h_
// SYSTEM INCLUDES
#if defined(__pingtel_on_posix__)
// To get "struct sockaddr_in".
#include <sys/socket.h>
#include <netinet/in.h>
#endif
#include <stdarg.h>
// APPLICATION INCLUDES
#include "os/OsDefs.h"
#include "utl/UtlContainableAtomic.h"
#include "utl/UtlString.h"
#include "os/OsBSem.h"
#include "os/OsAtomics.h"
// DEFINES
#define MAX_IP_ADDRESSES 32
#define MAX_ADAPTER_NAME_LENGTH 256
//: constant indentifier indicating the maximum number of IP addresses on this host.
#define OS_INVALID_SOCKET_DESCRIPTOR (-1)
#if defined(_WIN32)
# include <os/wnt/getWindowsDNSServers.h>
# include "os/wnt/WindowsAdapterInfo.h"
# define OsSocketGetERRNO() (WSAGetLastError())
# define OS_INVALID_INET_ADDRESS INADDR_NONE // 0xffffffff
#elif defined(_VXWORKS)
# include <os/Vxw/OsAdapterInfoVxw.h>
# define OsSocketGetERRNO() (errno)
# define OS_INVALID_INET_ADDRESS 0xffffffff
#elif defined(__pingtel_on_posix__)
# include "os/linux/AdapterInfo.h"
# define OsSocketGetERRNO() (errno)
# define OS_INVALID_INET_ADDRESS 0xffffffff
#else
# error Unsupported target platform.
#endif
// MACROS
// EXTERNAL FUNCTIONS
//used to access BindAddress from "C" code
extern "C" unsigned long osSocketGetDefaultBindAddress();
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// ENUMS
// FORWARD DECLARATIONS
//: Abstract Socket class
// This class encapsulates the Berkley socket in an object oriented,
// platform independent way. The intention is also to be independent of
// the protocol over IP as much as is possible. This should enable
// generic message transport with minimal knowledge of the underlying
// protocol.
class OsSocket : public UtlContainableAtomic
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:
static UtlBoolean socketInitialized;
/// Determine whether or not the values in a containable are comparable.
virtual UtlContainableType getContainableType() const;
/**<
* This returns a unique type for UtlString
*/
typedef enum
{
UNKNOWN = -1,
TCP = 0,
UDP = 1,
MULTICAST = 2,
SSL_SOCKET = 3,
CUSTOM = 4
} IpProtocolSocketType ;
//: Protocol Types
/* ============================ CREATORS ================================== */
OsSocket();
//:Default constructor
virtual
~OsSocket();
//:Destructor
/* ============================ MANIPULATORS ============================== */
static UtlBoolean socketInit();
static unsigned long initDefaultAdapterID(UtlString &adapter_id);
virtual int write(const char* buffer,
int bufferLength,
const char* ipAddress,
int port)
{
// default implementation ignores ipAddress and port
return write(buffer, bufferLength);
}
virtual int write(const char* buffer, int bufferLength);
//:Blocking write to the socket
// Write the characters in the given buffer to the socket.
// This method will block until all of the bytes are written.
//!param: buffer - The bytes to be written to the socket.
//!param: bufferLength - The number of bytes contained in buffer.
//!returns: The number of bytes actually written to the socket.
//!returns: <br>Note: This does not necessarily mean that the bytes were
//!returns: actually received on the other end.
virtual int write(const char* buffer, int bufferLength, long waitMilliseconds);
//:Non-blocking or limited blocking write to socket
// Same as blocking version except that this write will block
// for no more than the specified length of time.
//!param: waitMilliseconds - The maximum number of milliseconds to block. This may be set to zero, in which case it does not block.
virtual int read(char* buffer, int bufferLength);
//:Blocking read from the socket
// Read bytes into the buffer from the socket up to a maximum of
// bufferLength bytes. This method will block until there is
// something to read from the socket.
//!param: buffer - Place to put bytes read from the socket.
//!param: bufferLength - The maximum number of bytes buffer will hold.
//!returns: The number of bytes actually read.
virtual int read(char* buffer, int bufferLength,
UtlString* ipAddress, int* port);
//:Blocking read from the socket
// Read bytes into the buffer from the socket up to a maximum of
// bufferLength bytes. This method will block until there is
// something to read from the socket.
//!param: buffer - Place to put bytes read from the socket.
//!param: bufferLength - The maximum number of bytes buffer will hold.
//!param: ipAddress - The address of the socket that sent the bytes read.
//!param: port - The port of the socket that sent the bytes read.
//!returns: The number of bytes actually read.
virtual int read(char* buffer, int bufferLength,
struct in_addr* ipAddress, int* port);
//:Blocking read from the socket
// Read bytes into the buffer from the socket up to a maximum of
// bufferLength bytes. This method will block until there is
// something to read from the socket.
//!param: buffer - Place to put bytes read from the socket.
//!param: bufferLength - The maximum number of bytes buffer will hold.
//!param: ipAddress - The address of the socket that sent the bytes read.
//!param: port - The port of the socket that sent the bytes read.
//!returns: The number of bytes actually read.
virtual int read(char* buffer, int bufferLength, long waitMilliseconds);
//: Non-blocking or limited blocking read from socket
// Same as blocking version except that this read will block
// for no more than the specified length of time.
//!param: waitMilliseconds - The maximum number of milliseconds to block. This may be set to zero in which case it does not block.
virtual void close();
//: Closes the socket
virtual void makeNonblocking();
virtual void makeBlocking();
//: Make the connect and all subsequent operations blocking
// By default the sockets are blocking.
static void setDefaultBindAddress(const unsigned long bind_address);
//set the default ipaddress the phone should bind to
/* ============================ ACCESSORS ================================= */
virtual OsSocket::IpProtocolSocketType getIpProtocol() const = 0;
//:Return the protocol type of this socket
/// return the string representation of the SocketProtocolType
static const char* ipProtocolString(OsSocket::IpProtocolSocketType);
virtual UtlBoolean reconnect() = 0;
//:Set up the connection again, assuming the connection failed
virtual int getSocketDescriptor() const;
//:Return the socket descriptor
// Warning: Use of this method risks the creation of platform-dependent
// code.
static void getDomainName(UtlString &domain_name);
//gets static member m_DomainName
static unsigned long getDefaultBindAddress();
// get default ip address in network byte order
static void getHostName(UtlString* hostName);
//:Get this host's name
// Gets the host name independent of a socket.
static void getHostIp(UtlString* hostAddress);
//:Get this host's IP address
// virtual void getLocalHostName(UtlString* localHostName) const;
//:Return this host's name
// Returns a string containing the name of the host on which this socket
// resides. This may be the local name, a fully qualified domain name or
// anything in between. This name may vary on the same host if it is
// multi-homed, depending upon which NIC the Socket is associated with.
virtual void getLocalHostIp(UtlString* localHostAddress) const;
//:Return this host's ip address
// Returns the ip address for this host on which this socket is communicating
// On multi-homed machines, this is the address to the NIC over which the
// socket communicates. The format is of the form: xx.x.xxx.x
virtual const UtlString& getLocalIp() const;
//:Return this socket's Local Ip Address
virtual void setLocalIp(const UtlString& localIp) { mLocalIp = localIp; }
virtual int getLocalHostPort() const;
//:Return the local port number
// Returns the port to which this socket is bound on this host.
virtual void getRemoteHostName(UtlString* remoteHostName) const;
//:Return remote host name
// Returns a string containing the name of the host on which the socket
// on the other end of this socket is bound. This may be the local
// name, a fully qualified domain name or anything in between.
virtual void getRemoteHostIp(struct in_addr* remoteHostAddress,
int* remotePort = NULL);
//:Return remote host ip address
// Returns the ip address for the host on which the socket on the
// other end of this socket is bound.
virtual void getRemoteHostIp(UtlString* remoteHostAddress,
int* remotePort = NULL);
//:Return remote host ip address
// Returns the ip address for the host on which the socket on the
// other end of this socket is bound. The format is of the form:
// xx.x.xxx.x
virtual int getRemoteHostPort() const;
//:Return the remote port number
// Returns the port to which the socket on the other end of this socket
// is bound.
/* ============================ INQUIRY =================================== */
virtual UtlBoolean isOk() const;
//:Returns TRUE if this socket's descriptor is not the invalid descriptor
virtual UtlBoolean isConnected() const;
//:Returns TRUE if this socket is connected
virtual UtlBoolean isReadyToReadEx(long waitMilliseconds, UtlBoolean &rSocketError) const;
//:Poll if there are bytes to read
// Returns TRUE if socket is read to read.
// Returns FALSE if wait expires or socket error.
// rSocketError returns TRUE is socket error occurred.
virtual UtlBoolean isReadyToRead(long waitMilliseconds = 0) const;
//:Poll if there are bytes to read
// Returns TRUE if socket is ready to read.
// Returns FALSE if wait expires or socket error.
virtual UtlBoolean isReadyToWrite(long waitMilliseconds = 0) const;
//:Poll if socket is able to write without blocking
static UtlBoolean isIp4Address(const char* address);
//:Is the address a dotted IP4 address
// (i.e., nnn.nnn.nnn.nnn where 0 <= nnn <= 255)
static UtlBoolean isMcastAddr(const char* ipAddress);
//:Is the given dotted IP4 address a multicast address
static UtlBoolean isLocalHost(const char* hostAddress);
//:Is the given host name this host
static UtlBoolean isSameHost(const char* host1, const char* host2);
//:Are these two host names/addresses equivalent
static UtlBoolean getHostIpByName(const char* hostName, UtlString* hostAddress);
//:Look up IP address for host name
static void inet_ntoa_pt(struct in_addr input_address, UtlString& output_address);
//:Convert in_addr input_address to dot ip address to avoid memory leak
static UtlBoolean isFramed(IpProtocolSocketType type);
//:Returns TRUE if the given IpProtocolSocketType is a framed message protocol
// (that is, every read returns exactly one message), and so the Content-Length
// header may be omitted.
/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:
static const UtlContainableType TYPE; ///< Class type used for runtime checking
static OsBSem mInitializeSem;
OsAtomicLightInt socketDescriptor;
int localHostPort;
int remoteHostPort;
UtlString mLocalIp;
UtlString localHostName;
UtlString remoteHostName;
UtlString mRemoteIpAddress;
UtlBoolean mIsConnected;
/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:
static unsigned long m_DefaultBindAddress;
//default ip address the phone should bind to. May be IPADDR_ANY
static UtlString m_DomainName;
//domain name for host machine
OsSocket& operator=(const OsSocket& rhs);
//:Disable assignment operator
OsSocket(const OsSocket& rOsSocket);
//:Disable copy constructor
static UtlBoolean hasDefaultDnsDomain();
//:Returns TRUE if this host has a default DNS domain
};
/* ============================ INLINE METHODS ============================ */
#endif // _OsSocket_h_
|