com::pcbsys::nirvana::client::nNamedObject Class Reference

This class represents a client context on a RealmServer. More...

#include <nNamedObject.h>

Inherits CountableObject.

Inherited by com::pcbsys::nirvana::nbase::events::nNamedObjectHelper.

Public Member Functions
longlong	getEID ()
	Returns the current event ID that this named context is bound to. More...
longlong	getLength ()
	Returns the total number of events for this particular named context. More...
std::string	getName ()
	Returns the name of this client context. More...
UM_DEPRECATED bool	isPersistent ()
	Will this named object be restored after the Realm Server has been restarted. More...
bool	isPriorityEnabled ()
	If set the named object will queue multiple subscription such that the first subscriber will receive all events until it either disconnects or deletes the subscription, at which time, the next subscription request will start to receive events. More...
bool	isShared ()
	Will this named object be restored after the Realm Server has been restarted. More...

Detailed Description

This class represents a client context on a RealmServer.

In as much as that if a client session is closed and sometime later a new client session is created by referencing this named object the client can resume where they were

Member Function Documentation

longlong com::pcbsys::nirvana::client::nNamedObject::getEID

(

)

Returns the current event ID that this named context is bound to.

Returns

long event ID

longlong com::pcbsys::nirvana::client::nNamedObject::getLength

(

)

Returns the total number of events for this particular named context.

Returns

long length

Since

9.9

std::string com::pcbsys::nirvana::client::nNamedObject::getName

(

)

Returns the name of this client context.

Returns

String

UM_DEPRECATED bool com::pcbsys::nirvana::client::nNamedObject::isPersistent

(

)

Will this named object be restored after the Realm Server has been restarted.

Returns

bool flag

Deprecated:

This persistent flag is deprecated since 10.5. The method will be removed. Persistence of the durable will be defined by the persistence support of the parent channel. If the parent channel supports persistent events, its durables will always be created as persistent.

bool com::pcbsys::nirvana::client::nNamedObject::isPriorityEnabled

(

)

If set the named object will queue multiple subscription such that the first subscriber will receive all events until it either disconnects or deletes the subscription, at which time, the next subscription request will start to receive events.

Returns

if the named object is cluster wide

bool com::pcbsys::nirvana::client::nNamedObject::isShared

(

)

Will this named object be restored after the Realm Server has been restarted.

Returns

boolean flag

Since

9.9