com.pcbsys.nirvana.client.com.pcbsys.nirvana.client.nReconnectHandler Interface Reference

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...

Inherited by com.pcbsys.nirvana.client.p2p.nServiceWorker, com.pcbsys.nirvana.nAdminAPI.nPkgReconnectHandler, and MyChannels.Nirvana.InternalSession.


Public Member Functions

void disconnected (nSession anSession)
 This method is called asynchronously when a session is disconnected.
void reconnected (nSession anSession)
 This method is called asynchronously when a session is reconnected.
bool tryAgain (nSession anSession)
 This method is called asynchronously between a session being disconnected and a reconnection attempt.

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

void com.pcbsys.nirvana.client.com.pcbsys.nirvana.client.nReconnectHandler.disconnected ( nSession  anSession  ) 

This method is called asynchronously when a session is disconnected.

Parameters:
anSession The session that got disconnected

void com.pcbsys.nirvana.client.com.pcbsys.nirvana.client.nReconnectHandler.reconnected ( nSession  anSession  ) 

This method is called asynchronously when a session is reconnected.

Parameters:
anSession The session that got reconnected

bool com.pcbsys.nirvana.client.com.pcbsys.nirvana.client.nReconnectHandler.tryAgain ( nSession  anSession  ) 

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:
anSession The session to try and reconnect
Returns:
a bool specifying whether the default reconnect logic should be used or not.