ArtsProtocolTableData

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

Quick Index

DESCRIPTION

Class Summary

class ArtsProtocolTableData

{

public:
ArtsProtocolTableData();
~ArtsProtocolTableData();
uint16_t SampleInterval() const;
uint16_t SampleInterval(uint16_t sampleInterval);
uint64_t TotalPkts() const;
uint64_t TotalPkts(uint64_t totalPkts);
uint64_t TotalBytes() const;
uint64_t TotalBytes(uint64_t totalBytes);
vector<ArtsProtocolTableEntry> & ProtocolEntries() const;
void SortEntriesByBytes();
void SortEntriesByPkts();
uint32_t ComputeLength(uint8_t version ) const;
uint32_t Length(uint8_t version ) const;
istream& read(istream& is, uint8_t version );
int read(int fd, uint8_t version );
ostream& write(ostream& os, uint8_t version ) const;
int write(int fd, uint8_t version ) const;
operator = (const ArtsProtocolTableData & artsProtocolTableData);
operator << (ostream& os, const ArtsProtocolTableData & artsProtocolTableData);
protected:
}; // ArtsProtocolTableData

Back to the top of ArtsProtocolTableData

DESCRIPTION


---------------------------------------------------------------------------
class ArtsProtocolTableData
---------------------------------------------------------------------------
This class encapsulates the data portion of an ARTS protocol table object. It contains a vector of protocols entries, each of which contains a protocol number plus packet and byte counters for traffic using the protocol.
---------------------------------------------------------------------------

Back to the top of ArtsProtocolTableData

ArtsProtocolTableData();


-------------------------------------------------------------------------
ArtsProtocolTableData()
.........................................................................
constructor
-------------------------------------------------------------------------

  ArtsProtocolTableData();

Back to the top of ArtsProtocolTableData

~ArtsProtocolTableData();


-------------------------------------------------------------------------
~ArtsProtocolTableData()
.........................................................................
destructor
-------------------------------------------------------------------------

  ~ArtsProtocolTableData();

Back to the top of ArtsProtocolTableData

uint16_t SampleInterval() const;


-------------------------------------------------------------------------
uint16_t SampleInterval() const
.........................................................................
Returns the sampling ratio, indicating the 1:N packet sampling used to obtain the data. Normally this value is 1, meaning we're working with complete data sets (for example, from Cisco flow-export).
-------------------------------------------------------------------------

  uint16_t SampleInterval() const;

Back to the top of ArtsProtocolTableData

uint16_t SampleInterval(uint16_t sampleInterval);


-------------------------------------------------------------------------
uint16_t SampleInterval(uint16_t sampleInterval)
.........................................................................
Sets and returns the sampling ratio, indicating the 1:N packet sampling used to obtain the data. Normally this value is 1, meaning we're working with complete data sets (for example, from Cisco flow-export).
-------------------------------------------------------------------------

  uint16_t SampleInterval(uint16_t sampleInterval);

Back to the top of ArtsProtocolTableData

uint64_t TotalPkts() const;


-------------------------------------------------------------------------
uint64_t TotalPkts() const
.........................................................................
Returns the total packets of traffic in the ArtsProtocolTableData object. The total is the sum of all traffic for all protocols contained in the object.
-------------------------------------------------------------------------

  uint64_t TotalPkts() const;

Back to the top of ArtsProtocolTableData

uint64_t TotalPkts(uint64_t totalPkts);


-------------------------------------------------------------------------
uint64_t TotalPkts(uint64_t totalPkts)
.........................................................................
Sets and returns the total packets of traffic in the ArtsProtocolTableData object. The total is the sum of all traffic for all protocols contained in the object.
-------------------------------------------------------------------------

  uint64_t TotalPkts(uint64_t totalPkts);

Back to the top of ArtsProtocolTableData

uint64_t TotalBytes() const;


-------------------------------------------------------------------------
uint64_t TotalBytes() const
.........................................................................
Returns the total bytes of traffic in the ArtsProtocolTableData object. The total is the sum of all traffic for all protocols contained in the object.
-------------------------------------------------------------------------

  uint64_t TotalBytes() const;

Back to the top of ArtsProtocolTableData

uint64_t TotalBytes(uint64_t totalBytes);


-------------------------------------------------------------------------
uint64_t TotalBytes(uint64_t totalBytes)
.........................................................................
Sets and returns the total bytes of traffic in the ArtsProtocolTableData object. The total is the sum of all traffic for all protocols contained in the object.
-------------------------------------------------------------------------

  uint64_t TotalBytes(uint64_t totalBytes);

Back to the top of ArtsProtocolTableData

vector<ArtsProtocolTableEntry> & ProtocolEntries() const;


-------------------------------------------------------------------------
vector<ArtsProtocolTableEntry> & ProtocolEntries() const
.........................................................................
Returns a reference to the vector of protocol entries in the ArtsProtocolTableData object.
-------------------------------------------------------------------------

  vector<ArtsProtocolTableEntry> & ProtocolEntries() const;

Back to the top of ArtsProtocolTableData

void SortEntriesByBytes();


-------------------------------------------------------------------------
void SortEntriesByBytes()
.........................................................................

-------------------------------------------------------------------------

  void SortEntriesByBytes();

Back to the top of ArtsProtocolTableData

void SortEntriesByPkts();

No documentation available.

  void SortEntriesByPkts();

Back to the top of ArtsProtocolTableData

uint32_t ComputeLength(uint8_t version ) const;


-------------------------------------------------------------------------
uint32_t ComputeLength(uint8_t version = 0) const
.........................................................................
Computes the bytes required to store the ArtsProtocolTableData object in a file.
-------------------------------------------------------------------------

  uint32_t ComputeLength(uint8_t version = 0) const;

Back to the top of ArtsProtocolTableData

uint32_t Length(uint8_t version ) const;


-------------------------------------------------------------------------
uint32_t Length(uint8_t version = 0) const
.........................................................................
Returns the bytes required to store the ArtsProtocolTableData object in a file.
-------------------------------------------------------------------------

  uint32_t Length(uint8_t version = 0) const;

Back to the top of ArtsProtocolTableData

istream& read(istream& is, uint8_t version );


-------------------------------------------------------------------------
istream& read(istream& is, uint8_t version = 0)
.........................................................................
Reads the contents of an ArtsProtocolTableData from an istream. Returns the istream.
-------------------------------------------------------------------------

  istream& read(istream& is, uint8_t version = 0);

Back to the top of ArtsProtocolTableData

int read(int fd, uint8_t version );


-------------------------------------------------------------------------
int read(int fd, uint8_t version = 0)
.........................................................................
Reads the contents of an ArtsProtocolTableData from a file descriptor. Returns the number of bytes read if successful, -1 on failure.
-------------------------------------------------------------------------

  int read(int fd, uint8_t version = 0);

Back to the top of ArtsProtocolTableData

ostream& write(ostream& os, uint8_t version ) const;


-------------------------------------------------------------------------
ostream& write(ostream& os, uint8_t version = 0) const
.........................................................................
Writes the contents of an ArtsProtocolTableData to an ostream. Returns the ostream.
-------------------------------------------------------------------------

  ostream& write(ostream& os, uint8_t version = 0) const;

Back to the top of ArtsProtocolTableData

int write(int fd, uint8_t version ) const;


-------------------------------------------------------------------------
int write(int fd, uint8_t version = 0) const
.........................................................................
Writes the contents of an ArtsProtocolTableData to a file descriptor. Returns the number of bytes written on success, -1 on failure.
-------------------------------------------------------------------------

  int write(int fd, uint8_t version = 0) const;

Back to the top of ArtsProtocolTableData

operator = (const ArtsProtocolTableData & artsProtocolTableData);

No documentation available.

  operator = (const ArtsProtocolTableData & artsProtocolTableData);

Back to the top of ArtsProtocolTableData

operator << (ostream& os, const ArtsProtocolTableData & artsProtocolTableData);

No documentation available.

  operator << (ostream& os,
               const ArtsProtocolTableData & artsProtocolTableData);

Back to the top of ArtsProtocolTableData

All Members

public:
uint16_t SampleInterval() const;
uint16_t SampleInterval(uint16_t sampleInterval);
uint64_t TotalPkts() const;
uint64_t TotalPkts(uint64_t totalPkts);
uint64_t TotalBytes() const;
uint64_t TotalBytes(uint64_t totalBytes);
vector<ArtsProtocolTableEntry> & ProtocolEntries() const;
void SortEntriesByBytes();
void SortEntriesByPkts();
uint32_t ComputeLength(uint8_t version ) const;
uint32_t Length(uint8_t version ) const;
istream& read(istream& is, uint8_t version );
int read(int fd, uint8_t version );
ostream& write(ostream& os, uint8_t version ) const;
int write(int fd, uint8_t version ) const;
operator = (const ArtsProtocolTableData & artsProtocolTableData);
operator << (ostream& os, const ArtsProtocolTableData & artsProtocolTableData);
protected:

Back to the top of ArtsProtocolTableData

Ancestors

Class does not inherit from any other class.

Back to the top of ArtsProtocolTableData

Descendants

Class is not inherited by any others.

Back to the top of ArtsProtocolTableData

Generated from source by the Cocoon utilities on Sat Oct 17 14:40:03 1998 .

Report problems to jkotula@unimax.com