Logo

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

CflowdConfig Documentation

CflowdConfig

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

Quick Index

DESCRIPTION

Class Summary

class CflowdConfig

{

public:
const string k_defaultCflowdConfigFile = "/usr/local/arts/etc/cflowd.conf";
CflowdConfig();
~CflowdConfig();
int LogFacility() const;
int LogFacility(int logFacility);
int TcpCollectPort() const;
int TcpCollectPort(int tcpCollectPort);
const string & MapDirectory() const;
const string & MapDirectory(const string & mapDirectory);
const string & RawFlowSockFile() const;
const string & RawFlowSockFile(const string & rawFlowSockFile);
const string & FlowDirectory() const;
const string & FlowDirectory(const string & flowDirectory);
uint32_t FlowFileLength() const;
uint32_t FlowFileLength(uint32_t flowFileLength);
uint32_t NumFlowFiles() const;
uint32_t NumFlowFiles(uint32_t numFlowFiles);
const string & TableSockFile() const;
const string & TableSockFile(const string & tableSockFile);
CflowdCiscoMap & CiscoMap() const ;
CflowdFlowPortList & FlowPortList() const ;
CflowdCollectorMap & CollectorMap() const ;
void Clear();
protected:
}; // CflowdConfig

Back to the top of CflowdConfig

DESCRIPTION


---------------------------------------------------------------------------
class CflowdConfig
---------------------------------------------------------------------------
This class is used to hold cflowd configuration information.
---------------------------------------------------------------------------

Back to the top of CflowdConfig

const string k_defaultCflowdConfigFile = "/usr/local/arts/etc/cflowd.conf";

No documentation available.

  const string k_defaultCflowdConfigFile = "/usr/local/arts/etc/cflowd.conf";

Back to the top of CflowdConfig

CflowdConfig();


-------------------------------------------------------------------------
CflowdConfig()
.........................................................................
constructor
-------------------------------------------------------------------------

  CflowdConfig();

Back to the top of CflowdConfig

~CflowdConfig();


-------------------------------------------------------------------------
~CflowdConfig()
.........................................................................
destructor
-------------------------------------------------------------------------

  ~CflowdConfig();

Back to the top of CflowdConfig

int LogFacility() const;


-------------------------------------------------------------------------
int LogFacility() const
.........................................................................
Returns the syslog facility for cflowd. This corresponds to the LOGFACILITY setting in the OPTIONS stanza in cflowd.conf.
-------------------------------------------------------------------------

  int LogFacility() const;

Back to the top of CflowdConfig

int LogFacility(int logFacility);


-------------------------------------------------------------------------
int LogFacility(int logFacility)
.........................................................................
Sets and returns the syslog facility for cflowd.
-------------------------------------------------------------------------

  int LogFacility(int logFacility);

Back to the top of CflowdConfig

int TcpCollectPort() const;


-------------------------------------------------------------------------
int TcpCollectPort() const
.........................................................................
Returns the TCP port number on which cflowd is listening for collector connections from cfdcollect. This corresponds to the TCPCOLLECTPORT setting in the OPTIONS stanza in cflowd.conf.
-------------------------------------------------------------------------

  int TcpCollectPort() const;

Back to the top of CflowdConfig

int TcpCollectPort(int tcpCollectPort);


-------------------------------------------------------------------------
int TcpCollectPort(int tcpCollectPort)
.........................................................................
Sets and returns the TCP port number on which cflowd will listen for collector connections from cfdcollect.
-------------------------------------------------------------------------

  int TcpCollectPort(int tcpCollectPort);

Back to the top of CflowdConfig

const string & MapDirectory() const;


-------------------------------------------------------------------------
const string & MapDirectory() const
.........................................................................
UNUSED
-------------------------------------------------------------------------

  const string & MapDirectory() const;

Back to the top of CflowdConfig

const string & MapDirectory(const string & mapDirectory);


-------------------------------------------------------------------------
const string & MapDirectory(const string & mapDirectory)
.........................................................................
UNUSED
-------------------------------------------------------------------------

  const string & MapDirectory(const string & mapDirectory);

Back to the top of CflowdConfig

const string & RawFlowSockFile() const;


-------------------------------------------------------------------------
const string & RawFlowSockFile() const
.........................................................................
Returns the path to the named stream socket on which cflowdmux will listen for connections from raw flow clients. This corresponds to the RAWFLOWSOCKFILE setting in the OPTIONS stanza in cflowd.conf.
-------------------------------------------------------------------------

  const string & RawFlowSockFile() const;

Back to the top of CflowdConfig

const string & RawFlowSockFile(const string & rawFlowSockFile);


-------------------------------------------------------------------------
const string & RawFlowSockFile(const string & rawFlowSockFile)
.........................................................................
Sets and returns the path to the named stream socket on which cflowdmux will listen for connections from raw flow clients.
-------------------------------------------------------------------------

  const string & RawFlowSockFile(const string & rawFlowSockFile);

Back to the top of CflowdConfig

const string & FlowDirectory() const;


-------------------------------------------------------------------------
const string & FlowDirectory() const
.........................................................................
UNUSED
-------------------------------------------------------------------------

  const string & FlowDirectory() const;

Back to the top of CflowdConfig

const string & FlowDirectory(const string & flowDirectory);


-------------------------------------------------------------------------
const string & FlowDirectory(const string & flowDirectory)
.........................................................................
UNUSED
-------------------------------------------------------------------------

  const string & FlowDirectory(const string & flowDirectory);

Back to the top of CflowdConfig

uint32_t FlowFileLength() const;


-------------------------------------------------------------------------
uint32_t FlowFileLength() const
.........................................................................
UNUSED
-------------------------------------------------------------------------

  uint32_t  FlowFileLength() const;

Back to the top of CflowdConfig

uint32_t FlowFileLength(uint32_t flowFileLength);


-------------------------------------------------------------------------
uint32_t FlowFileLength(uint32_t flowFileLength)
.........................................................................
UNUSED
-------------------------------------------------------------------------

  uint32_t FlowFileLength(uint32_t flowFileLength);

Back to the top of CflowdConfig

uint32_t NumFlowFiles() const;


-------------------------------------------------------------------------
uint32_t NumFlowFiles() const
.........................................................................
UNUSED
-------------------------------------------------------------------------

  uint32_t NumFlowFiles() const;

Back to the top of CflowdConfig

uint32_t NumFlowFiles(uint32_t numFlowFiles);


-------------------------------------------------------------------------
uint32_t NumFlowFiles(uint32_t numFlowFiles)
.........................................................................
UNUSED
-------------------------------------------------------------------------

  uint32_t NumFlowFiles(uint32_t numFlowFiles);

Back to the top of CflowdConfig

const string & TableSockFile() const;


-------------------------------------------------------------------------
const string & TableSockFile() const
.........................................................................
Returns the path to the named stream socket on which cflowd will listen for connections from local clients requesting tabular data (cfdases, cfdnets, et. al.). This corresponds to the TABLESOCKFILE setting in the OPTIONS stanza in cflowd.conf.
-------------------------------------------------------------------------

  const string & TableSockFile() const;

Back to the top of CflowdConfig

const string & TableSockFile(const string & tableSockFile);


-------------------------------------------------------------------------
const string & TableSockFile(const string & tableSockFile)
.........................................................................
Sets and returns the path to the named stream socket on which cflowd will listen for connections from local clients requesting tabular data (cfdases, cfdnets, et. al.).
-------------------------------------------------------------------------

  const string & TableSockFile(const string & tableSockFile);

Back to the top of CflowdConfig

CflowdCiscoMap & CiscoMap() const ;


-------------------------------------------------------------------------
inline CflowdCiscoMap & CiscoMap() const
.........................................................................
Returns a reference to the map of CflowdCisco pointers contained in the cflowd configuration. This is a map keyed by IP address. Each CflowdCisco corresponds to a CISCOEXPORTER stanza in cflowd.conf, but our map may contain multiple pointers to the same CflowdCisco (we normally have keys for each interface IP address, pointing to the same CflowdCisco).
-------------------------------------------------------------------------

  inline CflowdCiscoMap & CiscoMap() const
                                    
;

Function is currently defined inline.


Back to the top of CflowdConfig

CflowdFlowPortList & FlowPortList() const ;


-------------------------------------------------------------------------
CflowdFlowPortList & FlowPortList() const
.........................................................................
Returns a reference to the contained CflowdFlowPortList. The CflowdFlowPortList holds a list of the UDP ports on which cflowdmux is listening for flow-export packets.
-------------------------------------------------------------------------

  CflowdFlowPortList & FlowPortList() const
                                    
;

Function is currently defined inline.


Back to the top of CflowdConfig

CflowdCollectorMap & CollectorMap() const ;


-------------------------------------------------------------------------
CflowdCollectorMap & CollectorMap() const
.........................................................................
Returns a reference to the contained CflowdCollectorMap. The CflowdCollectorMap holds pointers to multiple CflowdCollector objects and is keyed by IP address.
-------------------------------------------------------------------------

  CflowdCollectorMap & CollectorMap() const
                                        
;

Function is currently defined inline.


Back to the top of CflowdConfig

void Clear();


-------------------------------------------------------------------------
void Clear()
.........................................................................
Clears the CflowdConfig object.
-------------------------------------------------------------------------

  void Clear();

Back to the top of CflowdConfig

All Members

public:
const string k_defaultCflowdConfigFile = "/usr/local/arts/etc/cflowd.conf";
int LogFacility() const;
int LogFacility(int logFacility);
int TcpCollectPort() const;
int TcpCollectPort(int tcpCollectPort);
const string & MapDirectory() const;
const string & MapDirectory(const string & mapDirectory);
const string & RawFlowSockFile() const;
const string & RawFlowSockFile(const string & rawFlowSockFile);
const string & FlowDirectory() const;
const string & FlowDirectory(const string & flowDirectory);
uint32_t FlowFileLength() const;
uint32_t FlowFileLength(uint32_t flowFileLength);
uint32_t NumFlowFiles() const;
uint32_t NumFlowFiles(uint32_t numFlowFiles);
const string & TableSockFile() const;
const string & TableSockFile(const string & tableSockFile);
CflowdCiscoMap & CiscoMap() const ;
CflowdFlowPortList & FlowPortList() const ;
CflowdCollectorMap & CollectorMap() const ;
void Clear();
protected:

Back to the top of CflowdConfig

Ancestors

Class does not inherit from any other class.

Back to the top of CflowdConfig

Descendants

Class is not inherited by any others.

Back to the top of CflowdConfig

Generated from source by the Cocoon utilities on Tue Sep 22 04:08:53 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.