Cisco Packet Tracer Extensions API 8.1.0
API for communication between Cisco Packet Tracer application and its extension applications and modules.
Public Member Functions | List of all members
FlowMonitorData Class Reference

FlowMonitorData tracks a monitor that has been assigned to an interface. More...

Public Member Functions

Netflow::ENetflowDirection getDirection ()
 Returns the direction of the flow. More...
 
void setDirection (Netflow::ENetflowDirection)
 Sets the direction of the flow. More...
 
string getInterfaceName ()
 Returns the name of the interface. More...
 
int getFlowCount ()
 Returns the number of flows. More...
 
NetflowFlow getFlowAt (int)
 Returns the flow at the specified index. More...
 
int getTotalFlowCount ()
 Returns the total number of flows that were created by this monitor on this interface. More...
 
int getWaterMarkCount ()
 Returns the number of watermarks. More...
 
int getInactiveExpireCount ()
 Returns the total number of flows that were closed due to inactivity. More...
 
int getActiveExpireCount ()
 Returns the total number of flows that were closed due to long activity. More...
 
bool isIpv6 ()
 Returns true if this flow monitor data is IPv6, otherwise false. More...
 
bool isSameMonitor (string, bool)
 Returns true if the specified interface is the same flow monitor data, otherwise false. More...
 
bool hasInput ()
 Returns true if this flow monitor data has input, otherwise false. More...
 
bool hasOutput ()
 Returns true if this flow monitor data has output, otherwise false. More...
 
FlowMonitor getFlowMonitor ()
 Returns the flow monitor associated with this flow monitor data. More...
 

Detailed Description

FlowMonitorData tracks a monitor that has been assigned to an interface.

Member Function Documentation

◆ getActiveExpireCount()

int FlowMonitorData::getActiveExpireCount ( )

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.

◆ getDirection()

Netflow::ENetflowDirection FlowMonitorData::getDirection ( )

Returns the direction of the flow.

Returns
enum<Netflow::ENetflowDirection>, the direction of the flow. Flow directions: eInput = 0, eOutput = 1, eInputOutput = 2

◆ getFlowAt()

NetflowFlow FlowMonitorData::getFlowAt ( int  )

Returns the flow at the specified index.

Parameters
index,theindex of the flow of interest.
Returns
NetflowFlow, the NetflowFlow object at the specified index.

◆ getFlowCount()

int FlowMonitorData::getFlowCount ( )

Returns the number of flows.

Returns
string, the number of flows.

◆ getFlowMonitor()

FlowMonitor FlowMonitorData::getFlowMonitor ( )

Returns the flow monitor associated with this flow monitor data.

Returns
FlowMonitor, the FlowMonitor object associated with this flow monitor data.

◆ getInactiveExpireCount()

int FlowMonitorData::getInactiveExpireCount ( )

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.

◆ getInterfaceName()

string FlowMonitorData::getInterfaceName ( )

Returns the name of the interface.

Returns
string, the name of the interface.

◆ getTotalFlowCount()

int FlowMonitorData::getTotalFlowCount ( )

Returns the total number of flows that were created by this monitor on this interface.

Returns
int, the total number of flows that were created by this monitor on this interface.

◆ getWaterMarkCount()

int FlowMonitorData::getWaterMarkCount ( )

Returns the number of watermarks.

Returns
int, the number of watermarks.

◆ hasInput()

bool FlowMonitorData::hasInput ( )

Returns true if this flow monitor data has input, otherwise false.

Returns
bool, true if this flow monitor data has input, otherwise false.

◆ hasOutput()

bool FlowMonitorData::hasOutput ( )

Returns true if this flow monitor data has output, otherwise false.

Returns
bool, true if this flow monitor data has output, otherwise false.

◆ isIpv6()

bool FlowMonitorData::isIpv6 ( )

Returns true if this flow monitor data is IPv6, otherwise false.

Returns
bool, true if this flow monitor data is IPv6, otherwise false.

◆ isSameMonitor()

bool FlowMonitorData::isSameMonitor ( string  ,
bool   
)

Returns true if the specified interface is the same flow monitor data, otherwise false.

Parameters
intName,intNamecan 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,trueif IPv6, false if IPv4.
Returns
bool, true if the specified interface is the same flow monitor data, otherwise false.

◆ setDirection()

void FlowMonitorData::setDirection ( Netflow::ENetflowDirection  )

Sets the direction of the flow.

Parameters
direction,thedirection of the flow. Flow directions: eInput = 0, eOutput = 1, eInputOutput=2

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