com::pcbsys::nirvana::client::nConflationAttributes Class Reference

This class represents the conflation attributes that can be used when creating resources which allow conflation. More...

#include <nConflationAttributes.h>

Inherits Countable.

Public Member Functions
virtual int	getAction ()
	This can be either Drop or Merge. More...
virtual longlong	getInterval ()
	The time that the configured resource will conflate events. More...
	nConflationAttributes (longlong interval)
	Creates a conflation attributes object defaulting the action to merging of events within the conflation interval. More...
	nConflationAttributes (int action, longlong interval)
	Creates a conflation attribute specifying the action as either drop or merge within the time interval specified. More...

Static Public Attributes
static const int	sDropEvents = 0
	Used in the constructor of nConflationAttributes to represent that action that should be taken during the conflation interval.
static const int	sMergeEvents = 1
	Used in the constructor of nConflationAttributes to represent that action that should be taken during the conflation interval.

Protected Member Functions
virtual void	setAction (int action)
	Sets the action for this conflation attribute. More...

Detailed Description

This class represents the conflation attributes that can be used when creating resources which allow conflation.

Constructor & Destructor Documentation

com::pcbsys::nirvana::client::nConflationAttributes::nConflationAttributes

(

longlong

interval

)

Creates a conflation attributes object defaulting the action to merging of events within the conflation interval.

Parameters

interval

time in milliseconds that events will be conflated

com::pcbsys::nirvana::client::nConflationAttributes::nConflationAttributes	(	int	action,
		longlong	interval
	)

Creates a conflation attribute specifying the action as either drop or merge within the time interval specified.

Parameters

action	Set the action to either drop or merge events
interval	time in milliseconds that events will be conflated

Exceptions

nIllegalArgumentException

Member Function Documentation

virtual int com::pcbsys::nirvana::client::nConflationAttributes::getAction ( )

virtual

This can be either Drop or Merge.

Returns

the configured action

virtual longlong com::pcbsys::nirvana::client::nConflationAttributes::getInterval ( )

virtual

The time that the configured resource will conflate events.

Returns

time in milliseconds

virtual void com::pcbsys::nirvana::client::nConflationAttributes::setAction ( int  action )

protectedvirtual

Sets the action for this conflation attribute.

Parameters

action

to use to set

Exceptions

nIllegalArgumentException