OpenMAMA C++ API
Wombat::MamaEntitlementCallback Class Referenceabstract

Callback object passed to Mama::registerEntitlmentCallbacks(). More...

#include <mamacpp.h>

Public Member Functions

virtual ~MamaEntitlementCallback ()
 
virtual void onSessionDisconnect (const sessionDisconnectReason reason, const char *userId, const char *host, const char *appName)=0
 Function invoked when diconnect request is received from the entitlements server. More...
 
virtual void onEntitlementUpdate ()=0
 Function invoked after dynamic entitlements update has occurred. More...
 
virtual void onEntitlementCheckingSwitch (const int isEntitlementsCheckingDisabled)
 Function invoked after entitlements checking has been switched, for example, from enabled to disabled. More...
 

Detailed Description

Callback object passed to Mama::registerEntitlmentCallbacks().

The onSessionDisconnect() method will be invoked when a disconnect request is received from the entitlements server.

Constructor & Destructor Documentation

§ ~MamaEntitlementCallback()

virtual Wombat::MamaEntitlementCallback::~MamaEntitlementCallback ( )
inlinevirtual

Member Function Documentation

§ onSessionDisconnect()

virtual void Wombat::MamaEntitlementCallback::onSessionDisconnect ( const sessionDisconnectReason  reason,
const char *  userId,
const char *  host,
const char *  appName 
)
pure virtual

Function invoked when diconnect request is received from the entitlements server.

Parameters
reasonReason disconnect request was sent
userIdID of user who initiated the disconnection, either by attempting to initiate a new connection or an admin user explicitly issuing a disconnect
hostHostname/IP address of the site server or where userId is attempting to connect from
appName"site server" or application that userId is using to disconnect (possibly NULL)

§ onEntitlementUpdate()

virtual void Wombat::MamaEntitlementCallback::onEntitlementUpdate ( )
pure virtual

Function invoked after dynamic entitlements update has occurred.

§ onEntitlementCheckingSwitch()

virtual void Wombat::MamaEntitlementCallback::onEntitlementCheckingSwitch ( const int  isEntitlementsCheckingDisabled)
inlinevirtual

Function invoked after entitlements checking has been switched, for example, from enabled to disabled.