streams.Metric Class Reference

Class that represents a metric object, used for port, operator, and pe metrics. More...

Classes
class	Kind

Public Member Functions
def	getName (self)
	Get the metric name. More...
def	getDescription (self)
	Get the metric description. More...
def	getKind (self)
	Get the metric kind. More...
def	setValue
def	setValueNoLock
def	getValue (self)
	Get the metric value (this is an atomic operation) More...
def	getValueNoLock (self)
	Get the metric value (same as getValue(), as locking is not needed) More...
def	incrementValue
def	incrementValueNoLock

Detailed Description

Class that represents a metric object, used for port, operator, and pe metrics.

Member Function Documentation

getName()

def streams.Metric.getName	(		self,
			str
	)

Get the metric name.

Returns

name

getDescription()

def streams.Metric.getDescription	(		self,
			str
	)

Get the metric description.

Returns

description

getKind()

def streams.Metric.getKind	(		self,
			Kind
	)

Get the metric kind.

Returns

kind of the metric

setValue()

def streams.Metric.setValue	(		self,
			v
	)

setValueNoLock()

def streams.Metric.setValueNoLock	(		self,
			v
	)

getValue()

def streams.Metric.getValue	(		self,
			int
	)

Get the metric value (this is an atomic operation)

Returns

metric value

getValueNoLock()

def streams.Metric.getValueNoLock	(		self,
			int
	)

Get the metric value (same as getValue(), as locking is not needed)

Returns

metric value

incrementValue()

def streams.Metric.incrementValue	(		self,
			increment
	)

incrementValueNoLock()

def streams.Metric.incrementValueNoLock	(		self,
			increment
	)

---

The documentation for this class was generated from the following file:

• streams/__init__.py