com.pcbsys.nirvana.client.nChannelPublishKeys Class Reference

This class contains the information about a single channel key. More...

#include <nChannelPublishKeys.h>

Public Member Functions
int	getDepth ()
	Returns the depth of the publish key.
std::string	getName ()
	Returns the name of the publish key.
	nChannelPublishKeys (std::string name, int depth)
	Constructs a publish key object to be used in the channel creation.

---

Detailed Description

This class contains the information about a single channel key.

It contains the name and the depth of the key.

---

Constructor & Destructor Documentation

nChannelPublishKeys::nChannelPublishKeys	(	std::string	name,
		int	depth
	)

Constructs a publish key object to be used in the channel creation.

Parameters:

	name	name of the key
	depth	The number of unique values to keep in the channel

Exceptions:

nIllegalArgumentException

If the name is invalid or the depth is less then 1

---

Member Function Documentation

int nChannelPublishKeys::getDepth

(

)

Returns the depth of the publish key.

Returns:

int depth

std::string nChannelPublishKeys::getName

(

)

Returns the name of the publish key.

Returns:

String name