ArtsPortMatrixData

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

Quick Index

Class Summary

class ArtsPortMatrixData

{

public:

ArtsPortMatrixData() ;

uint16_t SampleInterval() const ;

uint16_t SampleInterval(uint16_t sampleInterval) ;

uint32_t Count() const ;

uint32_t Count(uint32_t count) ;

uint64_t TotalPkts() const ;

uint64_t TotalPkts(uint64_t totalPkts) ;

uint64_t TotalBytes() const ;

uint64_t TotalBytes(uint64_t totalBytes) ;

uint64_t Orphans() const ;

uint64_t Orphans(uint64_t orphans) ;

vector<ArtsPortMatrixEntry> & PortEntries() 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 );

int write(int fd, uint8_t version );

friend ostream& operator << (ostream& os, const ArtsPortMatrixData & artsPortMatrixData);

void SortEntriesByBytes();

void SortEntriesByPkts();

protected:

}; // ArtsPortMatrixData

Back to the top of ArtsPortMatrixData

DESCRIPTION

---------------------------------------------------------------------------
class ArtsPortMatrixData
---------------------------------------------------------------------------
This class encapsulates the data portion of an ARTS port matrix object. A port matrix contains packet and byte counters for traffic sent from source transport port numbers to destination transport port numbers. Like the ArtsPortTableData and ArtsSelectedPortTableData classes, it can be used to track traffic by application. However, keeping data in the ArtsPortMatrixData format allows you to retain the sourcePort->destinationPort relationship, which permits more flexible accounting (and can be used later to generate an ArtsSelectedPortTable object according to user-specified criteria; see the ConvertToArtsSelectedPortTable() member of the ArtsPortMatrixAggregator class, and the ArtsPortChooser class).

This class is not normally instantiated directly, but instead instantiated from the containing class (an Arts or ArtsPortMatrix object).
---------------------------------------------------------------------------

Back to the top of ArtsPortMatrixData

ArtsPortMatrixData() ;

-------------------------------------------------------------------------
inline ArtsPortMatrixData()
.........................................................................
constructor
-------------------------------------------------------------------------

  inline ArtsPortMatrixData()
                                                                                                                                     
;

Function is currently defined inline.

Back to the top of ArtsPortMatrixData

uint16_t SampleInterval() const ;

-------------------------------------------------------------------------
inline uint16_t SampleInterval() const
.........................................................................
Returns the sampling ratio if the port matrix was built using packet sampling techniques. Normally this value is 1, meaning we're working with complete data sets (for example, from Cisco flow-export).
-------------------------------------------------------------------------

  inline uint16_t SampleInterval() const
                                          
;

Function is currently defined inline.

Back to the top of ArtsPortMatrixData

uint16_t SampleInterval(uint16_t sampleInterval) ;

-------------------------------------------------------------------------
inline uint16_t SampleInterval(uint16_t sampleInterval)
.........................................................................
Sets and returns the sampling ratio if the port matrix was built using packet sampling techniques. Normally this value is 1, meaning we're working with complete data sets (for example, from Cisco flow-export).
-------------------------------------------------------------------------

  inline uint16_t SampleInterval(uint16_t sampleInterval)
                                                                                      
;

Function is currently defined inline.

Back to the top of ArtsPortMatrixData

uint32_t Count() const ;

-------------------------------------------------------------------------
inline uint32_t Count() const
.........................................................................
Returns the number of port matrix entries (cells) in an ArtsPortMatrixData object.
-------------------------------------------------------------------------

  inline uint32_t Count() const
                                 
;

Function is currently defined inline.

Back to the top of ArtsPortMatrixData

uint32_t Count(uint32_t count) ;

-------------------------------------------------------------------------
inline uint32_t Count(uint32_t count)
.........................................................................
Sets and Returns the number of port matrix entries (cells) in an ArtsPortMatrixData object.
-------------------------------------------------------------------------

  inline uint32_t Count(uint32_t count)
                                                           
;

Function is currently defined inline.

Back to the top of ArtsPortMatrixData

uint64_t TotalPkts() const ;

-------------------------------------------------------------------------
inline uint64_t TotalPkts() const
.........................................................................
Returns the total packets of traffic in the ArtsPortMatrixData object. The total is the sum of all traffic from each source to each destination.
-------------------------------------------------------------------------

  inline uint64_t TotalPkts() const
                                   
;

Function is currently defined inline.

Back to the top of ArtsPortMatrixData

uint64_t TotalPkts(uint64_t totalPkts) ;

-------------------------------------------------------------------------
inline uint64_t TotalPkts(uint64_t totalPkts)
.........................................................................
Sets and returns the total packets of traffic in the ArtsPortMatrixData object. The total is the sum of all traffic from each source to each destination.
-------------------------------------------------------------------------

  inline uint64_t TotalPkts(uint64_t totalPkts)
                                                                   
;

Function is currently defined inline.

Back to the top of ArtsPortMatrixData

uint64_t TotalBytes() const ;

-------------------------------------------------------------------------
inline uint64_t TotalBytes() const
.........................................................................
Returns the total bytes of traffic in the ArtsPortMatrixData object. The total is the sum of all traffic from each source to each destination.
-------------------------------------------------------------------------

  inline uint64_t TotalBytes() const
                                    
;

Function is currently defined inline.

Back to the top of ArtsPortMatrixData

uint64_t TotalBytes(uint64_t totalBytes) ;

-------------------------------------------------------------------------
inline uint64_t TotalBytes(uint64_t totalBytes)
.........................................................................
Sets and returns the total bytes of traffic in the ArtsPortMatrixData object. The total is the sum of all traffic from each source to each destination.
-------------------------------------------------------------------------

  inline uint64_t TotalBytes(uint64_t totalBytes)
                                                                      
;

Function is currently defined inline.

Back to the top of ArtsPortMatrixData

uint64_t Orphans() const ;

-------------------------------------------------------------------------
inline uint64_t Orphans() const
.........................................................................

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

  inline uint64_t Orphans() const
                                   
;

Function is currently defined inline.

Back to the top of ArtsPortMatrixData

uint64_t Orphans(uint64_t orphans) ;

-------------------------------------------------------------------------
inline uint64_t Orphans(uint64_t orphans)
.........................................................................

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

  inline uint64_t Orphans(uint64_t orphans)
                                                                 
;

Function is currently defined inline.

Back to the top of ArtsPortMatrixData

vector<ArtsPortMatrixEntry> & PortEntries() const ;

-------------------------------------------------------------------------
inline vector<ArtsPortMatrixEntry> & PortEntries() const
.........................................................................
Return a reference to the vector of ArtsPortMatrixEntry objects. Note that even though this member may be called from a const object, the returned reference is not const; the vector is mutable.
-------------------------------------------------------------------------

  inline vector<ArtsPortMatrixEntry> & PortEntries() const
                                       
;

Function is currently defined inline.

Back to the top of ArtsPortMatrixData

uint32_t Length(uint8_t version ) const;

-------------------------------------------------------------------------
uint32_t Length(uint8_t version = 0) const
.........................................................................
Returns the length required to store the ArtsPortMatrixData object on disk.
-------------------------------------------------------------------------

  uint32_t Length(uint8_t version = 0) const;

Back to the top of ArtsPortMatrixData

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

-------------------------------------------------------------------------
istream& read(istream& is, uint8_t version = 0)
.........................................................................
Reads an ArtsPortMatrixData object from an istream. Returns the istream.
-------------------------------------------------------------------------

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

Back to the top of ArtsPortMatrixData

int read(int fd, uint8_t version );

-------------------------------------------------------------------------
int read(int fd, uint8_t version = 0)
.........................................................................
Reads an ArtsPortMatrixData object 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 ArtsPortMatrixData

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

-------------------------------------------------------------------------
ostream& write(ostream& os, uint8_t version = 0)
.........................................................................
Writes an ArtsPortMatrixData object to an ostream. Returns the ostream.
-------------------------------------------------------------------------

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

Back to the top of ArtsPortMatrixData

int write(int fd, uint8_t version );

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

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

Back to the top of ArtsPortMatrixData

friend ostream& operator << (ostream& os, const ArtsPortMatrixData & artsPortMatrixData);

-------------------------------------------------------------------------
ostream& operator << (ostream& os, const ArtsPortMatrixData & artsPortMatrixData)
.........................................................................
Overloaded '<<' operator. Dumps the contents of an ArtsPortMatrixData object to an ostream in a human-readable form. Returns the ostream.
-------------------------------------------------------------------------

  friend ostream& operator << (ostream& os,
                               const ArtsPortMatrixData & artsPortMatrixData);

Back to the top of ArtsPortMatrixData

void SortEntriesByBytes();

-------------------------------------------------------------------------
void SortEntriesByBytes()
.........................................................................
Sorts the port matrix entries in desending order by byte count (the entry with the most traffic in bytes will become the first entry). Note this uses the ArtsPortMatrixEntryGreaterBytes function object defined in ArtsPortMatrixEntry.hh
-------------------------------------------------------------------------

  void SortEntriesByBytes();

Back to the top of ArtsPortMatrixData

void SortEntriesByPkts();

-------------------------------------------------------------------------
void SortEntriesByPkts()
.........................................................................
Sorts the port matrix entries in descending order by packet count (the entry with the most traffic in packets will become the first entry). Note this uses the ArtsPortMatrixEntryGreaterPkts function object defined in ArtsPortMatrixEntry.hh
-------------------------------------------------------------------------

  void SortEntriesByPkts();

Back to the top of ArtsPortMatrixData

All Members

public:: uint16_t SampleInterval() const ;; uint16_t SampleInterval(uint16_t sampleInterval) ;; uint32_t Count() const ;; uint32_t Count(uint32_t count) ;; uint64_t TotalPkts() const ;; uint64_t TotalPkts(uint64_t totalPkts) ;; uint64_t TotalBytes() const ;; uint64_t TotalBytes(uint64_t totalBytes) ;; uint64_t Orphans() const ;; uint64_t Orphans(uint64_t orphans) ;; vector<ArtsPortMatrixEntry> & PortEntries() 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 );; int write(int fd, uint8_t version );; friend ostream& operator << (ostream& os, const ArtsPortMatrixData & artsPortMatrixData);; void SortEntriesByBytes();; void SortEntriesByPkts();
protected:

Back to the top of ArtsPortMatrixData

Ancestors

Class does not inherit from any other class.

Back to the top of ArtsPortMatrixData

Descendants

Class is not inherited by any others.

Back to the top of ArtsPortMatrixData

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

Report problems to jkotula@unimax.com