CSConnection Class Reference

options for creating a connection More...

#include <Csocket.h>

Inheritance diagram for CSConnection:

Public Member Functions
	CSConnection (const CS_STRING &sHostname, uint16_t iPort, int iTimeout=60)
virtual	~CSConnection ()
const CS_STRING &	GetHostname () const
const CS_STRING &	GetSockName () const
const CS_STRING &	GetBindHost () const
uint16_t	GetPort () const
int	GetTimeout () const
bool	GetIsSSL () const
CSSockAddr::EAFRequire	GetAFRequire () const
const CS_STRING &	GetCipher () const
const CS_STRING &	GetPemLocation () const
const CS_STRING &	GetKeyLocation () const
const CS_STRING &	GetDHParamLocation () const
const CS_STRING &	GetPemPass () const
void	SetHostname (const CS_STRING &s)
	sets the hostname to connect to More...
void	SetSockName (const CS_STRING &s)
	sets the name of the socket, used for reference, ie in FindSockByName() More...
void	SetBindHost (const CS_STRING &s)
	sets the hostname to bind to (vhost support) More...
void	SetPort (uint16_t i)
	sets the port to connect to More...
void	SetTimeout (int i)
	sets the connection timeout More...
void	SetIsSSL (bool b)
	set to true to enable SSL More...
void	SetAFRequire (CSSockAddr::EAFRequire iAFRequire)
	sets the AF family type required More...
void	SetCipher (const CS_STRING &s)
	set the cipher strength to use, default is HIGH More...
void	SetPemLocation (const CS_STRING &s)
	set the location of the pemfile More...
void	SetPemPass (const CS_STRING &s)
	set the pemfile pass More...

Protected Attributes
CS_STRING	m_sHostname
CS_STRING	m_sSockName
CS_STRING	m_sBindHost
uint16_t	m_iPort
int	m_iTimeout
bool	m_bIsSSL
CSSockAddr::EAFRequire	m_iAFrequire
CS_STRING	m_sDHParamLocation
CS_STRING	m_sKeyLocation
CS_STRING	m_sPemLocation
CS_STRING	m_sPemPass
CS_STRING	m_sCipher

Detailed Description

options for creating a connection

Constructor & Destructor Documentation

CSConnection()

CSConnection::CSConnection ( const CS_STRING &  sHostname, uint16_t  iPort, int  iTimeout = 60  )

inline

Parameters

sHostname	hostname to connect to
iPort	port to connect to
iTimeout	connection timeout

References CSSockAddr::RAF_ANY.

~CSConnection()

virtual CSConnection::~CSConnection ( )

inlinevirtual

Member Function Documentation

GetAFRequire()

CSSockAddr::EAFRequire CSConnection::GetAFRequire ( ) const

inline

GetBindHost()

const CS_STRING& CSConnection::GetBindHost ( ) const

inline

GetCipher()

const CS_STRING& CSConnection::GetCipher ( ) const

inline

GetDHParamLocation()

const CS_STRING& CSConnection::GetDHParamLocation ( ) const

inline

GetHostname()

const CS_STRING& CSConnection::GetHostname ( ) const

inline

GetIsSSL()

bool CSConnection::GetIsSSL ( ) const

inline

GetKeyLocation()

const CS_STRING& CSConnection::GetKeyLocation ( ) const

inline

GetPemLocation()

const CS_STRING& CSConnection::GetPemLocation ( ) const

inline

GetPemPass()

const CS_STRING& CSConnection::GetPemPass ( ) const

inline

GetPort()

uint16_t CSConnection::GetPort ( ) const

inline

GetSockName()

const CS_STRING& CSConnection::GetSockName ( ) const

inline

GetTimeout()

int CSConnection::GetTimeout ( ) const

inline

SetAFRequire()

void CSConnection::SetAFRequire ( CSSockAddr::EAFRequire  iAFRequire )

inline

sets the AF family type required

SetBindHost()

void CSConnection::SetBindHost ( const CS_STRING &  s )

inline

sets the hostname to bind to (vhost support)

SetCipher()

void CSConnection::SetCipher ( const CS_STRING &  s )

inline

set the cipher strength to use, default is HIGH

SetHostname()

void CSConnection::SetHostname ( const CS_STRING &  s )

inline

sets the hostname to connect to

SetIsSSL()

void CSConnection::SetIsSSL ( bool  b )

inline

set to true to enable SSL

SetPemLocation()

void CSConnection::SetPemLocation ( const CS_STRING &  s )

inline

set the location of the pemfile

SetPemPass()

void CSConnection::SetPemPass ( const CS_STRING &  s )

inline

set the pemfile pass

SetPort()

void CSConnection::SetPort ( uint16_t  i )

inline

sets the port to connect to

SetSockName()

void CSConnection::SetSockName ( const CS_STRING &  s )

inline

sets the name of the socket, used for reference, ie in FindSockByName()

SetTimeout()

void CSConnection::SetTimeout ( int  i )

inline

sets the connection timeout

Member Data Documentation

m_bIsSSL

bool CSConnection::m_bIsSSL

protected

m_iAFrequire

CSSockAddr::EAFRequire CSConnection::m_iAFrequire

protected

m_iPort

uint16_t CSConnection::m_iPort

protected

m_iTimeout

int CSConnection::m_iTimeout

protected

m_sBindHost

CS_STRING CSConnection::m_sBindHost

protected

m_sCipher

CS_STRING CSConnection::m_sCipher

protected

m_sDHParamLocation

CS_STRING CSConnection::m_sDHParamLocation

protected

m_sHostname

CS_STRING CSConnection::m_sHostname

protected

m_sKeyLocation

CS_STRING CSConnection::m_sKeyLocation

protected

m_sPemLocation

CS_STRING CSConnection::m_sPemLocation

protected

m_sPemPass

CS_STRING CSConnection::m_sPemPass

protected

m_sSockName

CS_STRING CSConnection::m_sSockName

protected

---

The documentation for this class was generated from the following file:

• Csocket.h