ZNC  trunk
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Protected Attributes | List of all members
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_STRINGGetHostname () const
 
const CS_STRINGGetSockName () const
 
const CS_STRINGGetBindHost () const
 
uint16_t GetPort () const
 
int GetTimeout () const
 
bool GetIsSSL () const
 
CSSockAddr::EAFRequire GetAFRequire () const
 
const CS_STRINGGetCipher () const
 
const CS_STRINGGetPemLocation () const
 
const CS_STRINGGetKeyLocation () const
 
const CS_STRINGGetDHParamLocation () const
 
const CS_STRINGGetPemPass () 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 ( const CS_STRING sHostname,
uint16_t  iPort,
int  iTimeout = 60 
)
inline
Parameters
sHostnamehostname to connect to
iPortport to connect to
iTimeoutconnection timeout

References CSSockAddr::RAF_ANY.

virtual CSConnection::~CSConnection ( )
inlinevirtual

Member Function Documentation

CSSockAddr::EAFRequire CSConnection::GetAFRequire ( ) const
inline
const CS_STRING& CSConnection::GetBindHost ( ) const
inline
const CS_STRING& CSConnection::GetCipher ( ) const
inline
const CS_STRING& CSConnection::GetDHParamLocation ( ) const
inline
const CS_STRING& CSConnection::GetHostname ( ) const
inline
bool CSConnection::GetIsSSL ( ) const
inline
const CS_STRING& CSConnection::GetKeyLocation ( ) const
inline
const CS_STRING& CSConnection::GetPemLocation ( ) const
inline
const CS_STRING& CSConnection::GetPemPass ( ) const
inline
uint16_t CSConnection::GetPort ( ) const
inline
const CS_STRING& CSConnection::GetSockName ( ) const
inline
int CSConnection::GetTimeout ( ) const
inline
void CSConnection::SetAFRequire ( CSSockAddr::EAFRequire  iAFRequire)
inline

sets the AF family type required

void CSConnection::SetBindHost ( const CS_STRING s)
inline

sets the hostname to bind to (vhost support)

void CSConnection::SetCipher ( const CS_STRING s)
inline

set the cipher strength to use, default is HIGH

void CSConnection::SetHostname ( const CS_STRING s)
inline

sets the hostname to connect to

void CSConnection::SetIsSSL ( bool  b)
inline

set to true to enable SSL

void CSConnection::SetPemLocation ( const CS_STRING s)
inline

set the location of the pemfile

void CSConnection::SetPemPass ( const CS_STRING s)
inline

set the pemfile pass

void CSConnection::SetPort ( uint16_t  i)
inline

sets the port to connect to

void CSConnection::SetSockName ( const CS_STRING s)
inline

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

void CSConnection::SetTimeout ( int  i)
inline

sets the connection timeout

Member Data Documentation

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

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