com::pcbsys::nirvana::client::nReconnectHandler Class Referenceabstract

This interface should be implemented by classes wishing to register to receive callbacks when sessions are disconnected or to take control over the reconnect logic. More...

#include <nReconnectHandler.h>

Inherited by com::pcbsys::nirvana::client::p2p::nServiceWorker, com::pcbsys::nirvana::nAdminAPI::nPkgReconnectHandler, and com::pcbsys::nirvana::nAdminAPI::nRealmAdmin::ReconnectHandler.

Public Member Functions

virtual void disconnected (nSession *pSession)=0
 This method is called asynchronously when a session is disconnected. More...
 
virtual void reconnected (nSession *pSession)=0
 This method is called asynchronously when a session is reconnected. More...
 
virtual bool tryAgain (nSession *pSession)=0
 This method is called asynchronously between a session being disconnected and a reconnection attempt. More...
 

Detailed Description

This interface should be implemented by classes wishing to register to receive callbacks when sessions are disconnected or to take control over the reconnect logic.

Member Function Documentation

virtual void com::pcbsys::nirvana::client::nReconnectHandler::disconnected ( nSession pSession)
pure virtual

This method is called asynchronously when a session is disconnected.

Parameters
*pSessionThe session that got disconnected
virtual void com::pcbsys::nirvana::client::nReconnectHandler::reconnected ( nSession pSession)
pure virtual

This method is called asynchronously when a session is reconnected.

Parameters
*pSessionThe session that got reconnected
virtual bool com::pcbsys::nirvana::client::nReconnectHandler::tryAgain ( nSession pSession)
pure virtual

This method is called asynchronously between a session being disconnected and a reconnection attempt.

If you wish to use the default reconnect logic, simply return true. If not return false and implement your own custom reconnect logic.

Parameters
*pSessionThe session to try and reconnect
Returns
a bool specifying whether the default reconnect logic should be used or not.