#include <OsConnectionSocket.h>

Inheritance diagram for OsConnectionSocket:

[legend]

Collaboration diagram for OsConnectionSocket:

[legend]

Public Member Functions
	OsConnectionSocket (int remoteHostPort, const char remoteHostName, UtlBoolean makeBlocking=TRUE, const char localIp=NULL, const bool bConnect=true)

	OsConnectionSocket (int connectedSocketDescriptor)

	OsConnectionSocket (const char *localIp, int connectedSocketDescriptor)

virtual	~OsConnectionSocket ()

virtual int	connect ()

virtual UtlBoolean	reconnect ()

virtual int	read (char *buffer, int bufferLength)
	param: waitMilliseconds - The maximum number of milliseconds to block. This may be set to zero, in which case it does not block. More...

virtual int	read (char buffer, int bufferLength, UtlString ipAddress, int *port)
	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. More...

virtual int	read (char *buffer, int bufferLength, long waitMilliseconds)
	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. More...

virtual OsSocket::IpProtocolSocketType	getIpProtocol () const
	param: waitMilliseconds - The maximum number of milliseconds to block. This may be set to zero in which case it does not block. More...

virtual bool	isEncrypted () const
	Is this connection encrypted using TLS/SSL? More...

virtual bool	peerIdentity (UtlSList altNames=NULL, UtlString commonName=NULL) const
	Get any authenticated peer host names. More...

Public Member Functions inherited from OsSocket
virtual UtlContainableType	getContainableType () const
	Determine whether or not the values in a containable are comparable. More...

	OsSocket ()

virtual	~OsSocket ()

virtual int	write (const char buffer, int bufferLength, const char ipAddress, int port)

virtual int	write (const char *buffer, int bufferLength)

virtual int	write (const char *buffer, int bufferLength, long waitMilliseconds)
	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: Note: This does not necessarily mean that the bytes were returns: actually received on the other end. More...

virtual int	read (char buffer, int bufferLength, struct in_addr ipAddress, int *port)
	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. More...

virtual void	close ()
	param: waitMilliseconds - The maximum number of milliseconds to block. This may be set to zero in which case it does not block. More...

virtual void	makeNonblocking ()

virtual void	makeBlocking ()

virtual int	getSocketDescriptor () const

virtual void	getLocalHostIp (UtlString *localHostAddress) const

virtual const UtlString &	getLocalIp () const

virtual void	setLocalIp (const UtlString &localIp)

virtual int	getLocalHostPort () const

virtual void	getRemoteHostName (UtlString *remoteHostName) const

virtual void	getRemoteHostIp (struct in_addr remoteHostAddress, int remotePort=NULL)

virtual void	getRemoteHostIp (UtlString remoteHostAddress, int remotePort=NULL)

virtual int	getRemoteHostPort () const

virtual UtlBoolean	isOk () const

virtual UtlBoolean	isConnected () const

virtual UtlBoolean	isReadyToReadEx (long waitMilliseconds, UtlBoolean &rSocketError) const

virtual UtlBoolean	isReadyToRead (long waitMilliseconds=0) const

virtual UtlBoolean	isReadyToWrite (long waitMilliseconds=0) const

Public Member Functions inherited from UtlContainableAtomic
virtual unsigned	hash () const
	Calculate a hash code for this object. More...

virtual int	compareTo (UtlContainable const *) const
	Compare this object to another object. More...

Public Member Functions inherited from UtlContainable
virtual	~UtlContainable ()

unsigned	directHash () const
	Provides a hash function that uses the object pointer as the hash value. More...

virtual UtlBoolean	isEqual (UtlContainable const *) const
	Test this object to another object for equality. More...

virtual UtlBoolean	isInstanceOf (const UtlContainableType type) const
	Determine if this object is a derivative of the specified UtlContainableType. More...

Protected Member Functions
bool	initialize (const char *serverName, int serverPort, UtlBoolean blockingConnect)

Additional Inherited Members
Public Types inherited from OsSocket
enum	IpProtocolSocketType { UNKNOWN = -1, TCP = 0, UDP = 1, MULTICAST = 2, SSL_SOCKET = 3, CUSTOM = 4 }

Static Public Member Functions inherited from OsSocket
static UtlBoolean	socketInit ()

static unsigned long	initDefaultAdapterID (UtlString &adapter_id)

static void	setDefaultBindAddress (const unsigned long bind_address)

static const char *	ipProtocolString (OsSocket::IpProtocolSocketType)
	return the string representation of the SocketProtocolType More...

static void	getDomainName (UtlString &domain_name)

static unsigned long	getDefaultBindAddress ()

static void	getHostName (UtlString *hostName)

static void	getHostIp (UtlString *hostAddress)

static UtlBoolean	isIp4Address (const char *address)

static UtlBoolean	isMcastAddr (const char *ipAddress)

static UtlBoolean	isLocalHost (const char *hostAddress)

static UtlBoolean	isSameHost (const char host1, const char host2)

static UtlBoolean	getHostIpByName (const char hostName, UtlString hostAddress)

static void	inet_ntoa_pt (struct in_addr input_address, UtlString &output_address)

static UtlBoolean	isFramed (IpProtocolSocketType type)

Static Public Member Functions inherited from UtlContainable
static unsigned	stringHash (char const *value)
	Provides a hash function appropriate for null-terminated string values. More...

static UtlBoolean	areSameTypes (const UtlContainableType type1, const UtlContainableType type2)
	Are UtlContainable types the same. More...

Static Public Attributes inherited from OsSocket
static UtlBoolean	socketInitialized = FALSE

Static Public Attributes inherited from UtlContainable
static const UtlContainableType	TYPE = "UtlContainable"

Protected Attributes inherited from OsSocket
OsAtomicLightInt	socketDescriptor

int	localHostPort

int	remoteHostPort

UtlString	mLocalIp

UtlString	localHostName

UtlString	remoteHostName

UtlString	mRemoteIpAddress

UtlBoolean	mIsConnected

Static Protected Attributes inherited from OsSocket
static const UtlContainableType	TYPE = "OsSocket"
	Class type used for runtime checking. More...

static OsBSem	mInitializeSem

Constructor & Destructor Documentation

OsConnectionSocket	(	int	remoteHostPort,
		const char *	remoteHostName,
		UtlBoolean	makeBlocking = `TRUE`,
		const char *	localIp = `NULL`,
		const bool	bConnect = `true`
	)

OsConnectionSocket ( int connectedSocketDescriptor )

OsConnectionSocket	(	const char *	localIp,
		int	connectedSocketDescriptor
	)

~OsConnectionSocket ( )

virtual

Member Function Documentation

int connect ( )

virtual

UtlBoolean reconnect ( )

virtual

Implements OsSocket.

int read	(	char *	buffer,
		int	bufferLength
	)

virtual

param: waitMilliseconds - The maximum number of milliseconds to block. This may be set to zero, in which case it does not block.

Reimplemented from OsSocket.

Reimplemented in OsNatConnectionSocket.

int read	(	char *	buffer,
		int	bufferLength,
		UtlString *	ipAddress,
		int *	port
	)

virtual

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.

Reimplemented from OsSocket.

Reimplemented in OsNatConnectionSocket.

int read	(	char *	buffer,
		int	bufferLength,
		long	waitMilliseconds
	)

virtual

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.

Reimplemented from OsSocket.

Reimplemented in OsNatConnectionSocket.

OsSocket::IpProtocolSocketType getIpProtocol ( ) const

virtual

param: waitMilliseconds - The maximum number of milliseconds to block. This may be set to zero in which case it does not block.

Implements OsSocket.

bool isEncrypted ( ) const

virtual

Is this connection encrypted using TLS/SSL?

bool peerIdentity	(	UtlSList *	altNames = `NULL`,
		UtlString *	commonName = `NULL`
	)		const

virtual

Get any authenticated peer host names.

Usually, the names in the altNames will be easier to parse and use than commonName Either or both of altNames or commonName may be NULL, in which case no names are returned; the return value still indicates the trust relationship with the peer certificate.

Returns

true if the connection is TLS/SSL and the peer has presented a certificate signed by a trusted certificate authority
false if not

Parameters

altNames UtlStrings for verfied subjectAltNames are added to this

Note: caller must free them.

Parameters

commonName the Subject name is returned here

bool initialize	(	const char *	serverName,
		int	serverPort,
		UtlBoolean	blockingConnect
	)

protected

Public Member Functions

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation