The contents of this legacy page are no longer maintained nor supported, and are made available only for historical purposes.


CflowdCisco Documentation

CflowdCisco


[ libCfd | Source | Keywords | Summary | Ancestors | All Members | Descendants ]

Quick Index

DESCRIPTION

Class Summary

class CflowdCisco

{

public:
const uint16_t k_cflowdProtocolTableMask = 0x0001;
const uint16_t k_cflowdPortTableMask = 0x0002;
const uint16_t k_cflowdNetMatrixMask = 0x0004;
const uint16_t k_cflowdAsMatrixMask = 0x0008;
const uint16_t k_cflowdRawFlowMask = 0x0010;
const uint16_t k_cflowdPortMatrixMask = 0x0020;
const uint16_t k_cflowdInterfaceMatrixMask = 0x0040;
const uint16_t k_cflowdNextHopTableMask = 0x0080;
CflowdCisco();
~CflowdCisco();
ipv4addr_t IpAddress() const;
ipv4addr_t IpAddress(ipv4addr_t ipAddr);
uint16_t FlowPort() const;
uint16_t FlowPort(uint16_t flowPort);
uint16_t LocalAS() const;
uint16_t LocalAS(uint16_t localAS);
uint16_t TableIndex() const;
uint16_t TableIndex(uint16_t tableIndex);
CflowdCiscoFlowEngineMap & FlowEngines() const ;
CflowdCiscoFlowInterfaceMap & Interfaces() const ;
uint32_t LastCleared() const ;
uint32_t LastCleared(uint32_t lastCleared) ;
uint32_t LastUpdated() const ;
uint32_t LastUpdated(uint32_t lastUpdated) ;
int AddFlow(const CflowdRawFlow & flow);
istream & read(istream & is);
int read(int fd);
ostream & write(ostream & os) const;
int write(int fd) const;
int ClearTableData();
protected:
}; // CflowdCisco

Back to the top of CflowdCisco


DESCRIPTION


---------------------------------------------------------------------------
class CflowdCisco
---------------------------------------------------------------------------
This class abstracts a single Cisco router in cflowd++.
---------------------------------------------------------------------------

Back to the top of CflowdCisco


const uint16_t k_cflowdProtocolTableMask = 0x0001;

  const uint16_t  k_cflowdProtocolTableMask      = 0x0001;

Back to the top of CflowdCisco


const uint16_t k_cflowdPortTableMask = 0x0002;

No documentation available.

  const uint16_t  k_cflowdPortTableMask          = 0x0002;

Back to the top of CflowdCisco


const uint16_t k_cflowdNetMatrixMask = 0x0004;

No documentation available.

  const uint16_t  k_cflowdNetMatrixMask          = 0x0004;

Back to the top of CflowdCisco


const uint16_t k_cflowdAsMatrixMask = 0x0008;

No documentation available.

  const uint16_t  k_cflowdAsMatrixMask           = 0x0008;

Back to the top of CflowdCisco


const uint16_t k_cflowdRawFlowMask = 0x0010;

No documentation available.

  const uint16_t  k_cflowdRawFlowMask            = 0x0010;

Back to the top of CflowdCisco


const uint16_t k_cflowdPortMatrixMask = 0x0020;

No documentation available.

  const uint16_t  k_cflowdPortMatrixMask         = 0x0020;

Back to the top of CflowdCisco


const uint16_t k_cflowdInterfaceMatrixMask = 0x0040;

No documentation available.

  const uint16_t  k_cflowdInterfaceMatrixMask    = 0x0040;

Back to the top of CflowdCisco


const uint16_t k_cflowdNextHopTableMask = 0x0080;

No documentation available.

  const uint16_t  k_cflowdNextHopTableMask       = 0x0080;

Back to the top of CflowdCisco


CflowdCisco();


-------------------------------------------------------------------------
CflowdCisco()
.........................................................................
constructor
-------------------------------------------------------------------------

  CflowdCisco();

Back to the top of CflowdCisco


~CflowdCisco();


-------------------------------------------------------------------------
~CflowdCisco()
.........................................................................
destructor
-------------------------------------------------------------------------

  ~CflowdCisco();

Back to the top of CflowdCisco


ipv4addr_t IpAddress() const;


-------------------------------------------------------------------------
ipv4addr_t IpAddress() const
.........................................................................
Returns the IP address of the Cisco.
-------------------------------------------------------------------------

  ipv4addr_t IpAddress() const;

Back to the top of CflowdCisco


ipv4addr_t IpAddress(ipv4addr_t ipAddr);


-------------------------------------------------------------------------
ipv4addr_t IpAddress(ipv4addr_t ipAddr)
.........................................................................
Sets and returns the IP address of the Cisco.
-------------------------------------------------------------------------

  ipv4addr_t IpAddress(ipv4addr_t ipAddr);

Back to the top of CflowdCisco


uint16_t FlowPort() const;


-------------------------------------------------------------------------
uint16_t FlowPort() const
.........................................................................
Returns the port number that we'll use to listen for flow-export packets from the Cisco. This correpsonds to the port number specified in the Cisco configuration, and the CFDATAPORT setting in the CISCOEXPORTER stanza of cflowd.conf.
-------------------------------------------------------------------------

  uint16_t FlowPort() const;

Back to the top of CflowdCisco


uint16_t FlowPort(uint16_t flowPort);


-------------------------------------------------------------------------
uint16_t FlowPort(uint16_t flowPort)
.........................................................................
Sets and returns the port number that we'll use to listen for flow-export packets from the Cisco.
-------------------------------------------------------------------------

  uint16_t FlowPort(uint16_t flowPort);

Back to the top of CflowdCisco


uint16_t LocalAS() const;


-------------------------------------------------------------------------
uint16_t LocalAS() const
.........................................................................
Returns the local AS of the Cisco, as specified with LOCALAS in the CISCOEXPORTER stanza of cflowd.conf.
-------------------------------------------------------------------------

  uint16_t LocalAS() const;

Back to the top of CflowdCisco


uint16_t LocalAS(uint16_t localAS);


-------------------------------------------------------------------------
uint16_t LocalAS(uint16_t localAS)
.........................................................................
Sets and returns the local AS of the Cisco.
-------------------------------------------------------------------------

  uint16_t LocalAS(uint16_t localAS);

Back to the top of CflowdCisco


uint16_t TableIndex() const;


-------------------------------------------------------------------------
uint16_t TableIndex() const
.........................................................................
Returns the table index bitfield for the Cisco.
-------------------------------------------------------------------------

  uint16_t TableIndex() const;

Back to the top of CflowdCisco


uint16_t TableIndex(uint16_t tableIndex);


-------------------------------------------------------------------------
uint16_t TableIndex(uint16_t tableIndex)
.........................................................................
Sets and returns the table index bitfield for the Cisco.
-------------------------------------------------------------------------

  uint16_t TableIndex(uint16_t tableIndex);

Back to the top of CflowdCisco


CflowdCiscoFlowEngineMap & FlowEngines() const ;


-------------------------------------------------------------------------
inline CflowdCiscoFlowEngineMap & FlowEngines() const
.........................................................................
Returns a reference to the CflowdCiscoFlowEngineMap contained in the CflowdCisco object. The CflowdCiscoFlowEngineMap is used to track sequence numbers for each flow-export engine on the Cisco (VIP adapters and RSPs).
-------------------------------------------------------------------------

  inline CflowdCiscoFlowEngineMap & FlowEngines() const
                                       
;

Function is currently defined inline.


Back to the top of CflowdCisco


CflowdCiscoFlowInterfaceMap & Interfaces() const ;


-------------------------------------------------------------------------
inline CflowdCiscoFlowInterfaceMap & Interfaces() const
.........................................................................
Returns a reference to the CflowdCiscoFlowInterfaceMap contained in the CflowdCisco object. The CflowdCiscoFlowInterfaceMap is used to hold tabular data on a per-input-interface basis.
-------------------------------------------------------------------------

  inline CflowdCiscoFlowInterfaceMap & Interfaces() const
                                      
;

Function is currently defined inline.


Back to the top of CflowdCisco


uint32_t LastCleared() const ;


-------------------------------------------------------------------------
inline uint32_t LastCleared() const
.........................................................................
Returns the last time we cleared the tabular data for the Cisco, in seconds since the UNIX epoch.
-------------------------------------------------------------------------

  inline uint32_t LastCleared() const
                                       
;

Function is currently defined inline.


Back to the top of CflowdCisco


uint32_t LastCleared(uint32_t lastCleared) ;


-------------------------------------------------------------------------
inline uint32_t LastCleared(uint32_t lastCleared)
.........................................................................
Sets and returns the last time we cleared the tabular data for the Cisco, in seconds since the UNIX epoch.
-------------------------------------------------------------------------

  inline uint32_t LastCleared(uint32_t lastCleared)
                                                                             
;

Function is currently defined inline.


Back to the top of CflowdCisco


uint32_t LastUpdated() const ;


-------------------------------------------------------------------------
inline uint32_t LastUpdated() const
.........................................................................
Returns the last time we updated the tabular data for the Cisco, in seconds since the UNIX epoch.
-------------------------------------------------------------------------

  inline uint32_t LastUpdated() const
                                       
;

Function is currently defined inline.


Back to the top of CflowdCisco


uint32_t LastUpdated(uint32_t lastUpdated) ;


-------------------------------------------------------------------------
inline uint32_t LastUpdated(uint32_t lastUpdated)
.........................................................................
Sets and returns the last time we updated the tabular data for the Cisco, in seconds since the UNIX epoch.
-------------------------------------------------------------------------

  inline uint32_t LastUpdated(uint32_t lastUpdated)
                                                                             
;

Function is currently defined inline.


Back to the top of CflowdCisco


int AddFlow(const CflowdRawFlow & flow);


-------------------------------------------------------------------------
int AddFlow(const CflowdRawFlow & flow)
.........................................................................
Adds data from a CflowdRawFlow to the Cisco's tabular data (per-input-interface). Always returns 0.
-------------------------------------------------------------------------

  int AddFlow(const CflowdRawFlow & flow);

Back to the top of CflowdCisco


istream & read(istream & is);


-------------------------------------------------------------------------
istream & read(istream & is)
.........................................................................
Reads the contents of a CflowdCisco from an istream. Returns the istream.
-------------------------------------------------------------------------

  istream & read(istream & is);

Back to the top of CflowdCisco


int read(int fd);


-------------------------------------------------------------------------
int read(int fd)
.........................................................................
Reads the contents of a CflowdCisco from a file descriptor. Returns the number of bytes read on success, -1 on failure.
-------------------------------------------------------------------------

  int read(int fd);

Back to the top of CflowdCisco


ostream & write(ostream & os) const;


-------------------------------------------------------------------------
ostream & write(ostream & os) const
.........................................................................
Writes the contents of a CflowdCisco to an ostream. Returns the ostream.
-------------------------------------------------------------------------

  ostream & write(ostream & os) const;

Back to the top of CflowdCisco


int write(int fd) const;


-------------------------------------------------------------------------
int write(int fd) const
.........................................................................
Writes the contents of a CflowdCisco to a file descriptor. Returns the number of bytes written on success, -1 on failure.
-------------------------------------------------------------------------

  int write(int fd) const;

Back to the top of CflowdCisco


int ClearTableData();


-------------------------------------------------------------------------
int ClearTableData()
.........................................................................
Clears the tabular data for the Cisco. Always returns 0.
-------------------------------------------------------------------------

  int ClearTableData();

Back to the top of CflowdCisco


All Members

public:
const uint16_t k_cflowdProtocolTableMask = 0x0001;
const uint16_t k_cflowdPortTableMask = 0x0002;
const uint16_t k_cflowdNetMatrixMask = 0x0004;
const uint16_t k_cflowdAsMatrixMask = 0x0008;
const uint16_t k_cflowdRawFlowMask = 0x0010;
const uint16_t k_cflowdPortMatrixMask = 0x0020;
const uint16_t k_cflowdInterfaceMatrixMask = 0x0040;
const uint16_t k_cflowdNextHopTableMask = 0x0080;
ipv4addr_t IpAddress() const;
ipv4addr_t IpAddress(ipv4addr_t ipAddr);
uint16_t FlowPort() const;
uint16_t FlowPort(uint16_t flowPort);
uint16_t LocalAS() const;
uint16_t LocalAS(uint16_t localAS);
uint16_t TableIndex() const;
uint16_t TableIndex(uint16_t tableIndex);
CflowdCiscoFlowEngineMap & FlowEngines() const ;
CflowdCiscoFlowInterfaceMap & Interfaces() const ;
uint32_t LastCleared() const ;
uint32_t LastCleared(uint32_t lastCleared) ;
uint32_t LastUpdated() const ;
uint32_t LastUpdated(uint32_t lastUpdated) ;
int AddFlow(const CflowdRawFlow & flow);
istream & read(istream & is);
int read(int fd);
ostream & write(ostream & os) const;
int write(int fd) const;
int ClearTableData();
protected:

Back to the top of CflowdCisco


Ancestors

Class does not inherit from any other class.

Back to the top of CflowdCisco


Descendants

Class is not inherited by any others.

Back to the top of CflowdCisco


Generated from source by the Cocoon utilities on Tue Sep 22 04:08:49 1998 .

Report problems to jkotula@unimax.com

Related Objects

See https://catalog.caida.org/software/cflowd/ to explore related objects to this document in the CAIDA Resource Catalog.