Container which holds the attributes required for describing a durable object on a channel. More...

Inherited by com.pcbsys.nirvana.client.nSerialDurableAttributes, and com.pcbsys.nirvana.client.nSharedDurableAttributes.

Public Types
enum	nDurableType
	Enumeration defining all durable types. More...

Public Member Functions
string	getName ()
	Returns the name of the durable object. More...

string	getSelector ()
	Selector that is going to be used on the durable object to filter events. More...

long	getStartEid ()
	Starting event ID of the durable that will be created from the attributes. More...

nDurableType	getType ()
	Returns the type of the durable. More...

bool	isClustered ()
	Indicates if the durable object is created as a cluster wide object. More...

bool	isPersistent ()
	Indicates if the durable object will be persisted on the server. More...

void	setClustered (bool clustered)
	Sets if the durable object can be used in a cluster. More...

virtual void	setPersistent (bool persistent)
	Sets if the durable object should be persisted on the server. More...

void	setSelector (string selector)
	Setting the selector that is going to be used on the durable object to filter events. More...

void	setStartEid (long startEid)
	Sets the starting event ID of the durable that will be created from the attributes. More...

Static Public Member Functions
static nDurableAttributes	create (nDurableType type, string name)
	Creates a durable attributes instance with the specified durable type and name. More...

Detailed Description

Container which holds the attributes required for describing a durable object on a channel.

Member Enumeration Documentation

enum com.pcbsys.nirvana.client.nDurableAttributes.nDurableType

Enumeration defining all durable types.

Member Function Documentation

static nDurableAttributes com.pcbsys.nirvana.client.nDurableAttributes.create	(	nDurableType	type,
		string	name
	)

static

Creates a durable attributes instance with the specified durable type and name.

Parameters

type	Requested durbale type
name	The name of the durable object

Returns: The created durable attributes instance

string com.pcbsys.nirvana.client.nDurableAttributes.getName ( )

Returns the name of the durable object.

Returns: Name of the durable object

string com.pcbsys.nirvana.client.nDurableAttributes.getSelector ( )

Selector that is going to be used on the durable object to filter events.

Returns: selector used as an event filter

long com.pcbsys.nirvana.client.nDurableAttributes.getStartEid ( )

Starting event ID of the durable that will be created from the attributes.

Returns: Id of the starting event

nDurableType com.pcbsys.nirvana.client.nDurableAttributes.getType ( )

Returns the type of the durable.

Returns: Durable type

bool com.pcbsys.nirvana.client.nDurableAttributes.isClustered ( )

Indicates if the durable object is created as a cluster wide object.

Returns: Flag indicating whether the durable object is cluster wide

bool com.pcbsys.nirvana.client.nDurableAttributes.isPersistent ( )

Indicates if the durable object will be persisted on the server.

Returns: If the durable object will be ssved on the disc

void com.pcbsys.nirvana.client.nDurableAttributes.setClustered ( bool clustered )

Sets if the durable object can be used in a cluster.

Parameters

clustered Flag indicating whether the durable object is cluster wide

virtual void com.pcbsys.nirvana.client.nDurableAttributes.setPersistent ( bool persistent )

virtual

Sets if the durable object should be persisted on the server.

For shared type this flag is always set to true by design.

Parameters

persistent Is the durable object should be stored on the server's disc.

void com.pcbsys.nirvana.client.nDurableAttributes.setSelector ( string selector )

Setting the selector that is going to be used on the durable object to filter events.

Parameters

selector String that will be used as an event filter.

Exceptions

nIllegalArgumentException Thrown in case a selector is attempted to be added on non-shared durable type

void com.pcbsys.nirvana.client.nDurableAttributes.setStartEid ( long startEid )

Sets the starting event ID of the durable that will be created from the attributes.

Parameters

startEid Starting event Id to be set

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation