ArtsPortTableData

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

Quick Index

DESCRIPTION

Class Summary

class ArtsPortTableData

{

public:
ArtsPortTableData();
~ArtsPortTableData();
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<ArtsPortTableEntry> & PortEntries() 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;
ArtsPortTableData & operator = (const ArtsPortTableData & artsPortTableData);
friend ostream& operator << (ostream& os, const ArtsPortTableData & artsPortTableData);
protected:
}; // ArtsPortTableData

Back to the top of ArtsPortTableData

DESCRIPTION


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

Back to the top of ArtsPortTableData

ArtsPortTableData();


-------------------------------------------------------------------------
ArtsPortTableData()
.........................................................................
constructor
-------------------------------------------------------------------------

  ArtsPortTableData();

Back to the top of ArtsPortTableData

~ArtsPortTableData();


-------------------------------------------------------------------------
~ArtsPortTableData()
.........................................................................
destructor
-------------------------------------------------------------------------

  ~ArtsPortTableData();

Back to the top of ArtsPortTableData

uint16_t SampleInterval() const;


-------------------------------------------------------------------------
uint16_t SampleInterval() const
.........................................................................
Returns the sampling ratio, indicating the 1:N packet sampling used to obtain the port 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 ArtsPortTableData

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 port 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 ArtsPortTableData

uint64_t TotalPkts() const;


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

  uint64_t TotalPkts() const;

Back to the top of ArtsPortTableData

uint64_t TotalPkts(uint64_t totalPkts);


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

  uint64_t TotalPkts(uint64_t totalPkts);

Back to the top of ArtsPortTableData

uint64_t TotalBytes() const;


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

  uint64_t TotalBytes() const;

Back to the top of ArtsPortTableData

uint64_t TotalBytes(uint64_t totalBytes);


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

  uint64_t TotalBytes(uint64_t totalBytes);

Back to the top of ArtsPortTableData

vector<ArtsPortTableEntry> & PortEntries() const;


-------------------------------------------------------------------------
vector<ArtsPortTableEntry> & PortEntries() const
.........................................................................
Returns a reference to the port entries contained in the object.
-------------------------------------------------------------------------

  vector<ArtsPortTableEntry> & PortEntries() const;

Back to the top of ArtsPortTableData

void SortEntriesByBytes();


-------------------------------------------------------------------------
void SortEntriesByBytes()
.........................................................................
Sorts the port table entries by their total bytes (InBytes() + OutBytes()).
-------------------------------------------------------------------------

  void SortEntriesByBytes();

Back to the top of ArtsPortTableData

void SortEntriesByPkts();


-------------------------------------------------------------------------
void SortEntriesByPkts()
.........................................................................
Sorts the port table entries by their total packets (InPkts() + OutPkts()).
-------------------------------------------------------------------------

  void SortEntriesByPkts();

Back to the top of ArtsPortTableData

uint32_t ComputeLength(uint8_t version ) const;


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

  uint32_t ComputeLength(uint8_t version = 0) const;

Back to the top of ArtsPortTableData

uint32_t Length(uint8_t version ) const;


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

  uint32_t Length(uint8_t version = 0) const;

Back to the top of ArtsPortTableData

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


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

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

Back to the top of ArtsPortTableData

int read(int fd, uint8_t version );


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

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

Back to the top of ArtsPortTableData

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


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

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

Back to the top of ArtsPortTableData

int write(int fd, uint8_t version ) const;


-------------------------------------------------------------------------
int write(int fd, uint8_t version = 0) const
.........................................................................
Writes the contents of an ArtsPortTableData to a file descriptor. Returns the number of bytes written if ssccessful, else returns -1.
-------------------------------------------------------------------------

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

Back to the top of ArtsPortTableData

ArtsPortTableData & operator = (const ArtsPortTableData & artsPortTableData);


-------------------------------------------------------------------------
ArtsPortTableData & operator = (const ArtsPortTableData & artsPortTableData)
.........................................................................
Overloaded '=' operator for assigning one ArtsPortTableData object to another.
-------------------------------------------------------------------------

  ArtsPortTableData & operator = (const ArtsPortTableData & artsPortTableData);

Back to the top of ArtsPortTableData

friend ostream& operator << (ostream& os, const ArtsPortTableData & artsPortTableData);


-------------------------------------------------------------------------
friend ostream& operator << (ostream& os, const ArtsPortTableData & artsPortTableData)
.........................................................................
Overloaded ostream '<<' operator to dump the contents of an ArtsPortTableData object to an ostream in a human-readable form. Returns the ostream.
-------------------------------------------------------------------------

  friend ostream& operator << (ostream& os,
                               const ArtsPortTableData & artsPortTableData);

Back to the top of ArtsPortTableData

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<ArtsPortTableEntry> & PortEntries() 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;
ArtsPortTableData & operator = (const ArtsPortTableData & artsPortTableData);
friend ostream& operator << (ostream& os, const ArtsPortTableData & artsPortTableData);
protected:

Back to the top of ArtsPortTableData

Ancestors

Class does not inherit from any other class.

Back to the top of ArtsPortTableData

Descendants

Class is not inherited by any others.

Back to the top of ArtsPortTableData

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

Report problems to jkotula@unimax.com