KVIrc 5.2.4
Developer APIs
Public Member Functions | Protected Types | Protected Attributes | Friends | List of all members
KviIrcConnectionStateData Class Reference

#include <KviIrcConnectionStateData.h>

Public Member Functions

void changeEnabledCapList (const QString &szCapList)
 
const QString & commandToExecAfterConnect () const
 
const QStringList & enabledCaps () const
 
bool identifyMsgCapabilityEnabled () const
 
bool ignoreOneYouHaveNotRegisteredError () const
 
bool isInsideAuthenticate () const
 
bool isInsideInitialCapLs () const
 
bool isInsideInitialCapReq () const
 
bool isInsideInitialStartTls () const
 
 KviIrcConnectionStateData ()
 
kvi_time_t lastReceivedChannelWhoReply () const
 
kvi_time_t lastReceivedWhoisReply () const
 
kvi_time_t lastSentChannelWhoRequest () const
 
const LoginNickNameStateloginNickNameState () const
 
bool sentQuit () const
 
const QString & sentSaslMethod () const
 
bool sentStartTls () const
 
void setCommandToExecAfterConnect (const QString &szCmd)
 
void setIgnoreOneYouHaveNotRegisteredError (bool bIgnore)
 
void setInsideAuthenticate (bool bInside)
 
void setInsideInitialCapLs (bool bInside)
 
void setInsideInitialCapReq (bool bInside)
 
void setInsideInitialStartTls (bool bInside)
 
void setLastReceivedChannelWhoReply (kvi_time_t tTime)
 
void setLastReceivedWhoisReply (kvi_time_t tTime)
 
void setLastSentChannelWhoRequest (kvi_time_t tTime)
 
void setLoginNickNameState (const LoginNickNameState &eLoginNickNameState)
 
void setSentQuit ()
 
void setSentSaslMethod (const QString &szMethod)
 
void setSentStartTls ()
 
void setSimulateUnexpectedDisconnect (bool bSimulate)
 
bool simulateUnexpectedDisconnect () const
 
 ~KviIrcConnectionStateData ()
 

Protected Types

enum  LoginNickNameState {
  UsedConnectionSpecificNickName , UsedProfileSpecificNickName , UsedAlternativeProfileSpecificNickName , UsedServerSpecificNickName ,
  UsedAlternativeServerSpecificNickName , UsedNetworkSpecificNickName , UsedAlternativeNetworkSpecificNickName , UsedGlobalNickName1 ,
  UsedGlobalNickName2 , UsedGlobalNickName3 , UsedGlobalNickName4 , UsedRandomNickName1 ,
  UsedRandomNickName2 , UsedRandomNickName3 , UsedRandomNickName4 , UsedManualNickname
}
 

Protected Attributes

bool m_bIdentifyMsgCapabilityEnabled = false
 
bool m_bIgnoreOneYouHaveNotRegisteredError = false
 
bool m_bInsideAuthenticate = false
 
bool m_bInsideInitialCapLs = false
 
bool m_bInsideInitialCapReq = false
 
bool m_bInsideInitialStartTls = false
 
bool m_bSentQuit = false
 
bool m_bSentStartTls = false
 
bool m_bSimulateUnexpectedDisconnect = false
 
LoginNickNameState m_eLoginNickNameState = UsedConnectionSpecificNickName
 
QStringList m_lEnabledCaps
 
QString m_szCommandToExecAfterConnect
 
QString m_szSentSaslMethod
 
kvi_time_t m_tLastReceivedChannelWhoReply
 
kvi_time_t m_tLastReceivedWhoisReply = 0
 
kvi_time_t m_tLastSentChannelWhoRequest
 

Friends

class KviIrcConnection
 
class KviIrcServerParser
 
class KviUserParser
 

Member Enumeration Documentation

◆ LoginNickNameState

Enumerator
UsedConnectionSpecificNickName 
UsedProfileSpecificNickName 
UsedAlternativeProfileSpecificNickName 
UsedServerSpecificNickName 
UsedAlternativeServerSpecificNickName 
UsedNetworkSpecificNickName 
UsedAlternativeNetworkSpecificNickName 
UsedGlobalNickName1 
UsedGlobalNickName2 
UsedGlobalNickName3 
UsedGlobalNickName4 
UsedRandomNickName1 
UsedRandomNickName2 
UsedRandomNickName3 
UsedRandomNickName4 
UsedManualNickname 

Constructor & Destructor Documentation

◆ KviIrcConnectionStateData()

KviIrcConnectionStateData::KviIrcConnectionStateData ( )

◆ ~KviIrcConnectionStateData()

KviIrcConnectionStateData::~KviIrcConnectionStateData ( )
default

Member Function Documentation

◆ changeEnabledCapList()

void KviIrcConnectionStateData::changeEnabledCapList ( const QString &  szCapList)

◆ commandToExecAfterConnect()

const QString & KviIrcConnectionStateData::commandToExecAfterConnect ( ) const
inline

◆ enabledCaps()

const QStringList & KviIrcConnectionStateData::enabledCaps ( ) const
inline

◆ identifyMsgCapabilityEnabled()

bool KviIrcConnectionStateData::identifyMsgCapabilityEnabled ( ) const
inline

◆ ignoreOneYouHaveNotRegisteredError()

bool KviIrcConnectionStateData::ignoreOneYouHaveNotRegisteredError ( ) const
inline

◆ isInsideAuthenticate()

bool KviIrcConnectionStateData::isInsideAuthenticate ( ) const
inline

◆ isInsideInitialCapLs()

bool KviIrcConnectionStateData::isInsideInitialCapLs ( ) const
inline

◆ isInsideInitialCapReq()

bool KviIrcConnectionStateData::isInsideInitialCapReq ( ) const
inline

◆ isInsideInitialStartTls()

bool KviIrcConnectionStateData::isInsideInitialStartTls ( ) const
inline

◆ lastReceivedChannelWhoReply()

kvi_time_t KviIrcConnectionStateData::lastReceivedChannelWhoReply ( ) const
inline

◆ lastReceivedWhoisReply()

kvi_time_t KviIrcConnectionStateData::lastReceivedWhoisReply ( ) const
inline

◆ lastSentChannelWhoRequest()

kvi_time_t KviIrcConnectionStateData::lastSentChannelWhoRequest ( ) const
inline

◆ loginNickNameState()

const LoginNickNameState & KviIrcConnectionStateData::loginNickNameState ( ) const
inline

Returns the current login nickname state

Referenced by KviIrcConnection::pickNextLoginNickName().

◆ sentQuit()

bool KviIrcConnectionStateData::sentQuit ( ) const
inline

◆ sentSaslMethod()

const QString & KviIrcConnectionStateData::sentSaslMethod ( ) const
inline

◆ sentStartTls()

bool KviIrcConnectionStateData::sentStartTls ( ) const
inline

◆ setCommandToExecAfterConnect()

void KviIrcConnectionStateData::setCommandToExecAfterConnect ( const QString &  szCmd)
inline

◆ setIgnoreOneYouHaveNotRegisteredError()

void KviIrcConnectionStateData::setIgnoreOneYouHaveNotRegisteredError ( bool  bIgnore)
inline

◆ setInsideAuthenticate()

void KviIrcConnectionStateData::setInsideAuthenticate ( bool  bInside)
inline

◆ setInsideInitialCapLs()

void KviIrcConnectionStateData::setInsideInitialCapLs ( bool  bInside)
inline

◆ setInsideInitialCapReq()

void KviIrcConnectionStateData::setInsideInitialCapReq ( bool  bInside)
inline

◆ setInsideInitialStartTls()

void KviIrcConnectionStateData::setInsideInitialStartTls ( bool  bInside)
inline

◆ setLastReceivedChannelWhoReply()

void KviIrcConnectionStateData::setLastReceivedChannelWhoReply ( kvi_time_t  tTime)
inline

◆ setLastReceivedWhoisReply()

void KviIrcConnectionStateData::setLastReceivedWhoisReply ( kvi_time_t  tTime)
inline

◆ setLastSentChannelWhoRequest()

void KviIrcConnectionStateData::setLastSentChannelWhoRequest ( kvi_time_t  tTime)
inline

◆ setLoginNickNameState()

void KviIrcConnectionStateData::setLoginNickNameState ( const LoginNickNameState eLoginNickNameState)
inline

Sets the current login nickname state

Referenced by KviIrcConnection::loginToIrcServer(), and KviIrcConnection::pickNextLoginNickName().

◆ setSentQuit()

void KviIrcConnectionStateData::setSentQuit ( )
inline

◆ setSentSaslMethod()

void KviIrcConnectionStateData::setSentSaslMethod ( const QString &  szMethod)
inline

◆ setSentStartTls()

void KviIrcConnectionStateData::setSentStartTls ( )
inline

◆ setSimulateUnexpectedDisconnect()

void KviIrcConnectionStateData::setSimulateUnexpectedDisconnect ( bool  bSimulate)
inline

◆ simulateUnexpectedDisconnect()

bool KviIrcConnectionStateData::simulateUnexpectedDisconnect ( ) const
inline

Friends And Related Symbol Documentation

◆ KviIrcConnection

friend class KviIrcConnection
friend

◆ KviIrcServerParser

friend class KviIrcServerParser
friend

◆ KviUserParser

friend class KviUserParser
friend

Member Data Documentation

◆ m_bIdentifyMsgCapabilityEnabled

bool KviIrcConnectionStateData::m_bIdentifyMsgCapabilityEnabled = false
protected

Referenced by changeEnabledCapList().

◆ m_bIgnoreOneYouHaveNotRegisteredError

bool KviIrcConnectionStateData::m_bIgnoreOneYouHaveNotRegisteredError = false
protected

◆ m_bInsideAuthenticate

bool KviIrcConnectionStateData::m_bInsideAuthenticate = false
protected

◆ m_bInsideInitialCapLs

bool KviIrcConnectionStateData::m_bInsideInitialCapLs = false
protected

◆ m_bInsideInitialCapReq

bool KviIrcConnectionStateData::m_bInsideInitialCapReq = false
protected

◆ m_bInsideInitialStartTls

bool KviIrcConnectionStateData::m_bInsideInitialStartTls = false
protected

This is set to true if a forced STARTTLS request has been sent to the server followed by a PING. We use this flag to gracefully handle a ERR_NOTREGISTERED related to the PING if STARTTLS is not supported.

Note that in this case the STARTTLS support wasn't detected by a previous CAP LS (which wasn't sent at all).

◆ m_bSentQuit

bool KviIrcConnectionStateData::m_bSentQuit = false
protected

◆ m_bSentStartTls

bool KviIrcConnectionStateData::m_bSentStartTls = false
protected

◆ m_bSimulateUnexpectedDisconnect

bool KviIrcConnectionStateData::m_bSimulateUnexpectedDisconnect = false
protected

◆ m_eLoginNickNameState

LoginNickNameState KviIrcConnectionStateData::m_eLoginNickNameState = UsedConnectionSpecificNickName
protected

the current login nickname state

◆ m_lEnabledCaps

QStringList KviIrcConnectionStateData::m_lEnabledCaps
protected

Referenced by changeEnabledCapList().

◆ m_szCommandToExecAfterConnect

QString KviIrcConnectionStateData::m_szCommandToExecAfterConnect
protected

◆ m_szSentSaslMethod

QString KviIrcConnectionStateData::m_szSentSaslMethod
protected

◆ m_tLastReceivedChannelWhoReply

kvi_time_t KviIrcConnectionStateData::m_tLastReceivedChannelWhoReply
protected

◆ m_tLastReceivedWhoisReply

kvi_time_t KviIrcConnectionStateData::m_tLastReceivedWhoisReply = 0
protected

◆ m_tLastSentChannelWhoRequest

kvi_time_t KviIrcConnectionStateData::m_tLastSentChannelWhoRequest
protected

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