FlowMonitor Class Reference

FlowMonitor holds and manipulates the flow monitor. More...

Public Member Functions
string	getMonitorName ()
	Returns the name of the flow monitor. More...
FlowRecord	getRecord ()
	Returns the flow record. More...
void	unsetRecord ()
	Unsets the flow record. More...
FlowMonitorData	getInterfaceInput (string, bool)
	Returns the input flow monitor data on the specified interface. More...
FlowMonitorData	getInterfaceOutput (string, bool)
	Returns the output flow monitor data on the specified interface. More...
int	getActiveFlowCount ()
	Returns the number of active flows. More...
int	getTotalFlowAdded ()
	Returns the total number of flows. More...
int	getMonitorDataCount ()
	Returns the number of flow monitor data. More...
FlowMonitorData	getMonitorDataAt (int)
	Returns the flow monitor data at the specified index. More...
int	getExporterCount ()
	Returns the number of NetFlow exporters. More...
NFExporter	getExporterAt (int)
	Returns the NetFlow exporter at the specified index. More...
string	toString ()
	Returns the flow record output. More...
bool	monitorInUse ()
	Returns true if the flow monitor is in use, otherwise false. More...
int	getCurrentEntryCount ()
	Returns the number of flows. More...
int	getHighWaterMark ()
	Returns the high watermark value. More...
int	getFlowsAddedCount ()
	Returns the total number of flows. More...
int	getFlowsAgedCount ()
	Returns the total number of expired flows. More...
int	getActiveTimeoutCount ()
	Returns the total number of flows that were closed due to long activity. More...
int	getInactiveTimeoutCount ()
	Returns the total number of flows that were closed due to inactivity. More...
CacheFlowDatabase	getCacheDatabase ()
	Returns cache flow database. More...

Detailed Description

FlowMonitor holds and manipulates the flow monitor.

Member Function Documentation

getActiveFlowCount()

int FlowMonitor::getActiveFlowCount

(

)

Returns the number of active flows.

Returns

int, the number of active flows.

getActiveTimeoutCount()

int FlowMonitor::getActiveTimeoutCount

(

)

Returns the total number of flows that were closed due to long activity.

Returns

int, the total number of flows that were closed due to long activity.

getCacheDatabase()

CacheFlowDatabase FlowMonitor::getCacheDatabase

(

)

Returns cache flow database.

Returns

CacheFlowDatabase, the CacheFlowDatabase object.

getCurrentEntryCount()

int FlowMonitor::getCurrentEntryCount

(

)

Returns the number of flows.

Returns

int, the number of flows.

getExporterAt()

NFExporter FlowMonitor::getExporterAt

(

int

)

Returns the NetFlow exporter at the specified index.

Parameters

index,the

index of the NetFlow exporter of interest.

Returns

NFExporter, the NFExporter object at the specified index.

getExporterCount()

int FlowMonitor::getExporterCount

(

)

Returns the number of NetFlow exporters.

Returns

int, the number of NetFlow exporters.

getFlowsAddedCount()

int FlowMonitor::getFlowsAddedCount

(

)

Returns the total number of flows.

Returns

int, the total number of flows.

getFlowsAgedCount()

int FlowMonitor::getFlowsAgedCount

(

)

Returns the total number of expired flows.

Returns

int, the total number of expired flows.

getHighWaterMark()

int FlowMonitor::getHighWaterMark

(

)

Returns the high watermark value.

Returns

int, the high watermark value.

getInactiveTimeoutCount()

int FlowMonitor::getInactiveTimeoutCount

(

)

Returns the total number of flows that were closed due to inactivity.

Returns

int, the total number of flows that were closed due to inactivity.

getInterfaceInput()

FlowMonitorData FlowMonitor::getInterfaceInput	(	string	,
		bool
	)

Returns the input flow monitor data on the specified interface.

Parameters

interfaceName,interfaceName	can be one of the following plus an interface number where appropriate: Console, Aux, Ethernet, FastEthernet, GigabitEthernet, Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async. Example: FastEthernet0/0
isIpv6,true	if IPv6, false if IPv4.

Returns

FlowMonitorData, the FlowMonitorData object.

getInterfaceOutput()

FlowMonitorData FlowMonitor::getInterfaceOutput	(	string	,
		bool
	)

Returns the output flow monitor data on the specified interface.

Parameters

interfaceName,interfaceName	can be one of the following plus an interface number where appropriate: Console, Aux, Ethernet, FastEthernet, GigabitEthernet, Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async. Example: FastEthernet0/0
isIpv6,true	if IPv6, false if IPv4.

Returns

FlowMonitorData, the FlowMonitorData object.

getMonitorDataAt()

FlowMonitorData FlowMonitor::getMonitorDataAt

(

int

)

Returns the flow monitor data at the specified index.

Parameters

index,the

index of the flow monitor data of interest.

Returns

FlowMonitorData, the FlowMonitorData object at the specified index.

getMonitorDataCount()

int FlowMonitor::getMonitorDataCount

(

)

Returns the number of flow monitor data.

Returns

int, the number of flow monitor data.

getMonitorName()

string FlowMonitor::getMonitorName

(

)

Returns the name of the flow monitor.

Returns

string, the name of the flow monitor.

getRecord()

FlowRecord FlowMonitor::getRecord

(

)

Returns the flow record.

Returns

FlowRecord, the FlowRecord object.

getTotalFlowAdded()

int FlowMonitor::getTotalFlowAdded

(

)

Returns the total number of flows.

Returns

int, the total number of flows.

monitorInUse()

bool FlowMonitor::monitorInUse

(

)

Returns true if the flow monitor is in use, otherwise false.

Returns

bool, true if the flow monitor is in use, otherwise false.

toString()

string FlowMonitor::toString

(

)

Returns the flow record output.

Returns

string, the flow record output.

unsetRecord()

void FlowMonitor::unsetRecord

(

)

Unsets the flow record.

---

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

• CFlowMonitor.pki