KVIrc 5.2.0
Developer APIs
Public Types | Public Slots | Signals | Public Member Functions | Protected Slots | Protected Member Functions | Protected Attributes | Friends | List of all members
KviIrcContext Class Reference

#include <KviIrcContext.h>

+ Inheritance diagram for KviIrcContext:

Public Types

enum  State {
  Idle , PendingReconnection , Connecting , LoggingIn ,
  Connected
}
 

Public Slots

void closeAllDeadChannels ()
 
void closeAllDeadQueries ()
 

Signals

void stateChanged ()
 

Public Member Functions

void abortReconnect ()
 
KviAsynchronousConnectionDataasynchronousConnectionData () const
 
void beginAsynchronousConnect (unsigned int uDelayInMSecs)
 
void closeAllContextWindows ()
 
KviIrcConnectionconnection () const
 
void connectOrDisconnect ()
 
void connectToCurrentServer ()
 
KviConsoleWindowconsole () const
 
void createLinksWindow ()
 
void createListWindow ()
 
void destroyAsynchronousConnectionData ()
 
KviChannelWindowfindDeadChannel (const QString &name)
 
KviQueryWindowfindDeadQuery (const QString &nick)
 
KviChannelWindowfirstDeadChannel ()
 
KviQueryWindowfirstDeadQuery ()
 
unsigned int id () const
 
bool isConnected () const
 
bool isLoggingIn () const
 
KviExternalServerDataParserlinksWindow () const
 
KviExternalServerDataParserlistWindow () const
 
std::vector< KviIrcDataStreamMonitor * > & monitorList ()
 
void registerContextWindow (KviWindow *pWnd)
 
void registerDataStreamMonitor (KviIrcDataStreamMonitor *m)
 
void registerDeadChannel (KviChannelWindow *c)
 
void registerDeadQuery (KviQueryWindow *q)
 
void setAsynchronousConnectionData (KviAsynchronousConnectionData *d)
 
void setLinksWindowPointer (KviExternalServerDataParser *l)
 
void setListWindowPointer (KviExternalServerDataParser *l)
 
State state () const
 
void terminateConnectionRequest (bool bForce, const QString &szQuitMessage=QString(), bool bSimulateUnexpectedDisconnect=false)
 
bool unregisterContextWindow (KviWindow *pWnd)
 
void unregisterDataStreamMonitor (KviIrcDataStreamMonitor *m)
 
bool unregisterDeadChannel (KviChannelWindow *c)
 
bool unregisterDeadQuery (KviQueryWindow *q)
 
 ~KviIrcContext ()
 

Protected Slots

void asynchronousConnect ()
 

Protected Member Functions

void connectButtonClicked ()
 
void connectionEstablished ()
 
void connectionFailed (int iError)
 
void connectionTerminated ()
 
void destroyConnection ()
 
 KviIrcContext (KviConsoleWindow *pConsole)
 
void loginComplete ()
 
void setState (State eState)
 
void timerEvent (QTimerEvent *e) override
 

Protected Attributes

std::vector< KviWindow * > m_ContextWindows
 
std::vector< KviChannelWindow * > m_DeadChannels
 
std::vector< KviQueryWindow * > m_DeadQueries
 
State m_eState = Idle
 
int m_iHeartbeatTimerId
 
KviAsynchronousConnectionDatam_pAsynchronousConnectionData = nullptr
 
KviIrcConnectionm_pConnection = nullptr
 
KviConsoleWindowm_pConsole
 
KviExternalServerDataParserm_pLinksWindow = nullptr
 
KviExternalServerDataParserm_pListWindow = nullptr
 
std::vector< KviIrcDataStreamMonitor * > m_pMonitorList
 
QTimer * m_pReconnectTimer = nullptr
 
KviAsynchronousConnectionDatam_pSavedAsynchronousConnectionData = nullptr
 
unsigned int m_uConnectAttemptCount = 1
 
unsigned int m_uId
 

Friends

class KviChannelWindow
 
class KviConsoleWindow
 
class KviIrcConnection
 
class KviIrcContextToolBar
 
class KviQueryWindow
 

Member Enumeration Documentation

◆ State

Enumerator
Idle 
PendingReconnection 
Connecting 
LoggingIn 
Connected 

Constructor & Destructor Documentation

◆ KviIrcContext()

KviIrcContext::KviIrcContext ( KviConsoleWindow pConsole)
protected

◆ ~KviIrcContext()

KviIrcContext::~KviIrcContext ( )

Member Function Documentation

◆ abortReconnect()

void KviIrcContext::abortReconnect ( )

◆ asynchronousConnect

void KviIrcContext::asynchronousConnect ( )
protectedslot

◆ asynchronousConnectionData()

KviAsynchronousConnectionData * KviIrcContext::asynchronousConnectionData ( ) const
inline

◆ beginAsynchronousConnect()

void KviIrcContext::beginAsynchronousConnect ( unsigned int  uDelayInMSecs)

◆ closeAllContextWindows()

void KviIrcContext::closeAllContextWindows ( )

◆ closeAllDeadChannels

void KviIrcContext::closeAllDeadChannels ( )
slot

◆ closeAllDeadQueries

void KviIrcContext::closeAllDeadQueries ( )
slot

◆ connectButtonClicked()

void KviIrcContext::connectButtonClicked ( )
protected

◆ connection()

KviIrcConnection * KviIrcContext::connection ( ) const
inline

◆ connectionEstablished()

void KviIrcContext::connectionEstablished ( )
protected

◆ connectionFailed()

void KviIrcContext::connectionFailed ( int  iError)
protected

◆ connectionTerminated()

void KviIrcContext::connectionTerminated ( )
protected

References __tr2qs, _OUTPUT_MUTE, KviIrcConnectionUserInfo::awayReason(), beginAsynchronousConnect(), KviIrcConnectionRequestQueue::clearAll(), KviIrcServer::clearReconnectInfo(), Connected, Connecting, connection(), d, KviIrcServer::enabledSTARTTLS(), KviIrcConnection::gatherChannelAndPasswordPairs(), KviIrcConnection::gatherQueryNames(), KviIrcServer::hostName(), KviIrcServer::id(), KviIrcServer::initUMode(), KviIrcServer::ip(), KviIrcConnectionUserInfo::isAway(), KviIrcServer::isIPv6(), KviIrcConnection::keepChannelsOpenAfterDisconnect(), KviIrcConnection::keepQueriesOpenAfterDisconnect(), KVI_OPTION_BOOL, KVI_OPTION_UINT, KVI_OUT_CONNECTION, KviEvent_OnIRCConnectionTerminated, KviOption_boolAutoReconnectOnUnexpectedDisconnect, KviOption_boolKeepChannelsOpenOnDisconnect, KviOption_boolKeepChannelsOpenOnUnexpectedDisconnect, KviOption_boolKeepQueriesOpenOnDisconnect, KviOption_boolKeepQueriesOpenOnUnexpectedDisconnect, KviOption_boolRejoinChannelsAfterReconnect, KviOption_boolReopenQueriesAfterReconnect, KviOption_uintAutoReconnectDelay, KVS_TRIGGER_EVENT_0_HALTED, LoggingIn, KviIrcServerReconnectInfo::m_bIsAway, m_eState, KviIrcServerReconnectInfo::m_lJoinChannels, KviIrcServerReconnectInfo::m_lOpenQueries, m_pConnection, m_pConsole, KviIrcServerReconnectInfo::m_szAwayReason, KviIrcServerReconnectInfo::m_szNick, KviIrcServerReconnectInfo::m_szPass, KviIrcConnectionUserInfo::nickName(), KviIrcConnectionUserInfo::nickNameBeforeAway(), KviWindow::output(), KviIrcServer::password(), KviIrcConnectionUserInfo::password(), PendingReconnection, KviIrcServer::port(), KviIrcConnection::requestQueue(), KviIrcConnectionStateData::sentQuit(), setAsynchronousConnectionData(), setState(), KviIrcConnectionStateData::simulateUnexpectedDisconnect(), KviIrcConnection::stateData(), KviIrcConnection::userInfo(), and KviIrcServer::useSSL().

Referenced by KviIrcConnection::linkTerminated().

◆ connectOrDisconnect()

void KviIrcContext::connectOrDisconnect ( )
inline

◆ connectToCurrentServer()

void KviIrcContext::connectToCurrentServer ( )

References __tr2qs, KviAsynchronousConnectionData::bPortIsOk, KviAsynchronousConnectionData::bSTARTTLS, KviAsynchronousConnectionData::bUseIPv6, KviAsynchronousConnectionData::bUseLastServerInContext, KviAsynchronousConnectionData::bUseSSL, KviIrcServer::clearReconnectInfo(), Connecting, KviConsoleWindow::connectionAttached(), KviIrcServerDataBase::currentNetwork(), KviProxyDataBase::currentProxy(), KviIrcNetwork::currentServer(), d, KviUserIdentityManager::defaultIdentity(), destroyAsynchronousConnectionData(), KviIrcServer::enabledSTARTTLS(), KviUserIdentityManager::findIdentity(), g_pProxyDataBase, g_pServerDataBase, KviIrcServer::hostName(), KviIrcServer::id(), KviIrcServer::initUMode(), KviUserIdentityManager::instance(), KviIrcServer::isIPv6(), KVI_OPTION_BOOL, KVI_OUT_SYSTEMERROR, KVI_OUT_SYSTEMMESSAGE, KVI_OUT_SYSTEMWARNING, KviIrcConnection, KviOption_boolUseProxyHost, m_pAsynchronousConnectionData, m_pConnection, m_pConsole, KviAsynchronousConnectionData::m_pReconnectInfo, m_pReconnectTimer, m_pSavedAsynchronousConnectionData, KviIrcServerDataBase::makeCurrentServer(), KviIrcServerDataBase::networkCount(), KviWindow::outputNoFmt(), KviIrcServer::password(), KviIrcServer::port(), KviIrcServer::proxy(), KviIrcServer::proxyServer(), KviIrcServer::reconnectInfo(), KviKvsScript::run(), KviIrcConnectionStateData::setCommandToExecAfterConnect(), KviIrcServer::setReconnectInfo(), setState(), KviIrcConnection::start(), KviIrcConnection::stateData(), KviAsynchronousConnectionData::szBindAddress, KviAsynchronousConnectionData::szCommandToExecAfterConnect, KviAsynchronousConnectionData::szInitUMode, KviAsynchronousConnectionData::szLinkFilter, KviAsynchronousConnectionData::szNick, KviAsynchronousConnectionData::szPass, KviIrcServerDefinition::szServer, KviAsynchronousConnectionData::szServer, KviAsynchronousConnectionData::szServerId, KviAsynchronousConnectionData::uPort, KviIrcNetwork::userIdentityId(), KviIrcServer::userIdentityId(), and KviIrcServer::useSSL().

Referenced by asynchronousConnect(), and connectButtonClicked().

◆ console()

KviConsoleWindow * KviIrcContext::console ( ) const
inline

◆ createLinksWindow()

void KviIrcContext::createLinksWindow ( )

◆ createListWindow()

void KviIrcContext::createListWindow ( )

◆ destroyAsynchronousConnectionData()

void KviIrcContext::destroyAsynchronousConnectionData ( )

◆ destroyConnection()

void KviIrcContext::destroyConnection ( )
protected

◆ findDeadChannel()

KviChannelWindow * KviIrcContext::findDeadChannel ( const QString &  name)

◆ findDeadQuery()

KviQueryWindow * KviIrcContext::findDeadQuery ( const QString &  nick)

◆ firstDeadChannel()

KviChannelWindow * KviIrcContext::firstDeadChannel ( )

References m_DeadChannels.

◆ firstDeadQuery()

KviQueryWindow * KviIrcContext::firstDeadQuery ( )

◆ id()

unsigned int KviIrcContext::id ( ) const
inline

◆ isConnected()

bool KviIrcContext::isConnected ( ) const
inline

◆ isLoggingIn()

bool KviIrcContext::isLoggingIn ( ) const
inline

◆ linksWindow()

KviExternalServerDataParser * KviIrcContext::linksWindow ( ) const
inline

◆ listWindow()

KviExternalServerDataParser * KviIrcContext::listWindow ( ) const
inline

◆ loginComplete()

void KviIrcContext::loginComplete ( )
protected

References Connected, and setState().

Referenced by KviIrcConnection::loginComplete().

◆ monitorList()

std::vector< KviIrcDataStreamMonitor * > & KviIrcContext::monitorList ( )
inline

◆ registerContextWindow()

void KviIrcContext::registerContextWindow ( KviWindow pWnd)

References m_ContextWindows.

Referenced by UserWindow::UserWindow().

◆ registerDataStreamMonitor()

void KviIrcContext::registerDataStreamMonitor ( KviIrcDataStreamMonitor m)

◆ registerDeadChannel()

void KviIrcContext::registerDeadChannel ( KviChannelWindow c)

References m_DeadChannels.

Referenced by KviChannelWindow::setDeadChan().

◆ registerDeadQuery()

void KviIrcContext::registerDeadQuery ( KviQueryWindow q)

References m_DeadQueries, and q.

Referenced by KviQueryWindow::setDeadQuery().

◆ setAsynchronousConnectionData()

void KviIrcContext::setAsynchronousConnectionData ( KviAsynchronousConnectionData d)

◆ setLinksWindowPointer()

void KviIrcContext::setLinksWindowPointer ( KviExternalServerDataParser l)
inline

References l.

Referenced by LinksWindow::LinksWindow(), and LinksWindow::~LinksWindow().

◆ setListWindowPointer()

void KviIrcContext::setListWindowPointer ( KviExternalServerDataParser l)
inline

References l.

Referenced by ListWindow::ListWindow(), and ListWindow::~ListWindow().

◆ setState()

void KviIrcContext::setState ( State  eState)
protected

◆ state()

State KviIrcContext::state ( ) const
inline

◆ stateChanged

void KviIrcContext::stateChanged ( )
signal

Referenced by setState().

◆ terminateConnectionRequest()

void KviIrcContext::terminateConnectionRequest ( bool  bForce,
const QString &  szQuitMessage = QString(),
bool  bSimulateUnexpectedDisconnect = false 
)

◆ timerEvent()

void KviIrcContext::timerEvent ( QTimerEvent *  e)
overrideprotected

◆ unregisterContextWindow()

bool KviIrcContext::unregisterContextWindow ( KviWindow pWnd)

References m_ContextWindows.

Referenced by UserWindow::~UserWindow().

◆ unregisterDataStreamMonitor()

void KviIrcContext::unregisterDataStreamMonitor ( KviIrcDataStreamMonitor m)

◆ unregisterDeadChannel()

bool KviIrcContext::unregisterDeadChannel ( KviChannelWindow c)

◆ unregisterDeadQuery()

bool KviIrcContext::unregisterDeadQuery ( KviQueryWindow q)

Friends And Related Symbol Documentation

◆ KviChannelWindow

friend class KviChannelWindow
friend

◆ KviConsoleWindow

friend class KviConsoleWindow
friend

◆ KviIrcConnection

friend class KviIrcConnection
friend

Referenced by connectToCurrentServer().

◆ KviIrcContextToolBar

friend class KviIrcContextToolBar
friend

◆ KviQueryWindow

friend class KviQueryWindow
friend

Member Data Documentation

◆ m_ContextWindows

std::vector<KviWindow *> KviIrcContext::m_ContextWindows
protected

◆ m_DeadChannels

std::vector<KviChannelWindow *> KviIrcContext::m_DeadChannels
protected

◆ m_DeadQueries

std::vector<KviQueryWindow *> KviIrcContext::m_DeadQueries
protected

◆ m_eState

State KviIrcContext::m_eState = Idle
protected

◆ m_iHeartbeatTimerId

int KviIrcContext::m_iHeartbeatTimerId
protected

◆ m_pAsynchronousConnectionData

KviAsynchronousConnectionData* KviIrcContext::m_pAsynchronousConnectionData = nullptr
protected

◆ m_pConnection

KviIrcConnection* KviIrcContext::m_pConnection = nullptr
protected

◆ m_pConsole

KviConsoleWindow* KviIrcContext::m_pConsole
protected

◆ m_pLinksWindow

KviExternalServerDataParser* KviIrcContext::m_pLinksWindow = nullptr
protected

◆ m_pListWindow

KviExternalServerDataParser* KviIrcContext::m_pListWindow = nullptr
protected

◆ m_pMonitorList

std::vector<KviIrcDataStreamMonitor *> KviIrcContext::m_pMonitorList
protected

◆ m_pReconnectTimer

QTimer* KviIrcContext::m_pReconnectTimer = nullptr
protected

◆ m_pSavedAsynchronousConnectionData

KviAsynchronousConnectionData* KviIrcContext::m_pSavedAsynchronousConnectionData = nullptr
protected

◆ m_uConnectAttemptCount

unsigned int KviIrcContext::m_uConnectAttemptCount = 1
protected

◆ m_uId

unsigned int KviIrcContext::m_uId
protected

Referenced by KviIrcContext().


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