CSSSListener Class Reference

#include <Csocket.h>

Inheritance diagram for CSSSListener:

Collaboration diagram for CSSSListener:

Public Member Functions
	CSSSListener (uint16_t iPort, const CS_STRING &sBindHost="")
void	SetDetach (bool b)
bool	GetDetach () const
uint16_t	GetPort () const
const CS_STRING &	GetSockName () const
const CS_STRING &	GetBindHost () const
bool	GetIsSSL () const
int	GetMaxConns () const
uint32_t	GetTimeout () const
CSSockAddr::EAFRequire	GetAFRequire () const
const CS_STRING &	GetCipher () const
const CS_STRING &	GetDHParamLocation () const
const CS_STRING &	GetKeyLocation () const
const CS_STRING &	GetPemLocation () const
const CS_STRING &	GetPemPass () const
uint32_t	GetRequireClientCertFlags () const
void	SetPort (uint16_t iPort)
	sets the port to listen on. Set to 0 to listen on a random port
void	SetSockName (const CS_STRING &sSockName)
	sets the sock name for later reference (ie FindSockByName)
void	SetBindHost (const CS_STRING &sBindHost)
	sets the host to bind to
void	SetIsSSL (bool b)
	set to true to enable SSL
void	SetMaxConns (int i)
	set max connections as called by accept()
void	SetTimeout (uint32_t i)
	sets the listen timeout. The listener class will close after timeout has been reached if not 0
void	SetAFRequire (CSSockAddr::EAFRequire iAFRequire)
	sets the AF family type required
void	SetCipher (const CS_STRING &s)
	set the cipher strength to use, default is HIGH
void	SetPemLocation (const CS_STRING &s)
	set the location of the pemfile
void	SetKeyLocation (const CS_STRING &s)
	set the location of the keyfile
void	SetDHParamLocation (const CS_STRING &s)
	set the location of the dhparamfile
void	SetPemPass (const CS_STRING &s)
	set the pemfile pass
void	SetRequiresClientCert (bool b)
	set to true if require a client certificate (deprecated
void	SetRequireClientCertFlags (unsigned int iRequireCertFlags)
	bitwise flags, 0 means don't require cert, SSL_VERIFY_PEER verifies peers, SSL_VERIFY_FAIL_IF_NO_PEER_CERT will cause the connection to fail if no cert

Constructor & Destructor Documentation

CSSSListener()

CSSSListener::CSSSListener ( uint16_t iPort, const CS_STRING & sBindHost = "" )

inline

References CSListener::CSListener(), CS_STRING, and CSListener::SetIsSSL().

Member Function Documentation

GetAFRequire()

CSSockAddr::EAFRequire CSListener::GetAFRequire ( ) const

inlineinherited

GetBindHost()

const CS_STRING & CSListener::GetBindHost ( ) const

inlineinherited

References CS_STRING.

GetCipher()

const CS_STRING & CSListener::GetCipher ( ) const

inlineinherited

References CS_STRING.

GetDetach()

bool CSListener::GetDetach ( ) const

inlineinherited

GetDHParamLocation()

const CS_STRING & CSListener::GetDHParamLocation ( ) const

inlineinherited

References CS_STRING.

GetIsSSL()

bool CSListener::GetIsSSL ( ) const

inlineinherited

GetKeyLocation()

const CS_STRING & CSListener::GetKeyLocation ( ) const

inlineinherited

References CS_STRING.

GetMaxConns()

int CSListener::GetMaxConns ( ) const

inlineinherited

GetPemLocation()

const CS_STRING & CSListener::GetPemLocation ( ) const

inlineinherited

References CS_STRING.

GetPemPass()

const CS_STRING & CSListener::GetPemPass ( ) const

inlineinherited

References CS_STRING.

GetPort()

uint16_t CSListener::GetPort ( ) const

inlineinherited

GetRequireClientCertFlags()

uint32_t CSListener::GetRequireClientCertFlags ( ) const

inlineinherited

GetSockName()

const CS_STRING & CSListener::GetSockName ( ) const

inlineinherited

References CS_STRING.

GetTimeout()

uint32_t CSListener::GetTimeout ( ) const

inlineinherited

SetAFRequire()

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

inlineinherited

sets the AF family type required

Referenced by CSockManager::ListenHost(), and CSockManager::ListenRand().

SetBindHost()

void CSListener::SetBindHost ( const CS_STRING & sBindHost )

inlineinherited

sets the host to bind to

References CS_STRING.

SetCipher()

void CSListener::SetCipher ( const CS_STRING & s )

inlineinherited

set the cipher strength to use, default is HIGH

References CS_STRING.

SetDetach()

void CSListener::SetDetach ( bool b )

inlineinherited

SetDHParamLocation()

void CSListener::SetDHParamLocation ( const CS_STRING & s )

inlineinherited

set the location of the dhparamfile

References CS_STRING.

SetIsSSL()

void CSListener::SetIsSSL ( bool b )

inlineinherited

set to true to enable SSL

Referenced by CSSSListener::CSSSListener(), CSockManager::ListenHost(), and CSockManager::ListenRand().

SetKeyLocation()

void CSListener::SetKeyLocation ( const CS_STRING & s )

inlineinherited

set the location of the keyfile

References CS_STRING.

SetMaxConns()

void CSListener::SetMaxConns ( int i )

inlineinherited

set max connections as called by accept()

Referenced by CSockManager::ListenHost(), and CSockManager::ListenRand().

SetPemLocation()

void CSListener::SetPemLocation ( const CS_STRING & s )

inlineinherited

set the location of the pemfile

References CS_STRING.

SetPemPass()

void CSListener::SetPemPass ( const CS_STRING & s )

inlineinherited

set the pemfile pass

References CS_STRING.

SetPort()

void CSListener::SetPort ( uint16_t iPort )

inlineinherited

sets the port to listen on. Set to 0 to listen on a random port

SetRequireClientCertFlags()

void CSListener::SetRequireClientCertFlags ( unsigned int iRequireCertFlags )

inlineinherited

bitwise flags, 0 means don't require cert, SSL_VERIFY_PEER verifies peers, SSL_VERIFY_FAIL_IF_NO_PEER_CERT will cause the connection to fail if no cert

SetRequiresClientCert()

void CSListener::SetRequiresClientCert ( bool b )

inlineinherited

set to true if require a client certificate (deprecated

See also

SetRequireClientCertFlags)

SetSockName()

void CSListener::SetSockName ( const CS_STRING & sSockName )

inlineinherited

sets the sock name for later reference (ie FindSockByName)

References CS_STRING.

Referenced by CSockManager::ListenHost(), and CSockManager::ListenRand().

SetTimeout()

void CSListener::SetTimeout ( uint32_t i )

inlineinherited

sets the listen timeout. The listener class will close after timeout has been reached if not 0

Referenced by CSockManager::ListenHost(), and CSockManager::ListenRand().

---

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

• Csocket.h