//=========================================================================== // @(#) $Name: $ // @(#) $Id: ArtsProtocolTableData.hh,v 1.1.1.1 2000/03/29 22:53:59 kkeys Exp $ //=========================================================================== // CAIDA Copyright Notice // // By accessing this software, arts++, you are duly informed // of and agree to be bound by the conditions described below in this // notice: // // This software product, arts++, is developed by Daniel W. McRobb, and // copyrighted(C) 1998 by the University of California, San Diego // (UCSD), with all rights reserved. UCSD administers the CAIDA grant, // NCR-9711092, under which part of this code was developed. // // There is no charge for arts++ software. You can redistribute it // and/or modify it under the terms of the GNU General Public License, // v. 2 dated June 1991 which is incorporated by reference herein. // arts++ is distributed WITHOUT ANY WARRANTY, IMPLIED OR EXPRESS, OF // MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE or that the use // of it will not infringe on any third party's intellectual property // rights. // // You should have received a copy of the GNU GPL along with arts++. // Copies can also be obtained from: // // http://www.gnu.org/copyleft/gpl.html // // or by writing to: // // University of California, San Diego // // SDSC/CAIDA // 9500 Gilman Dr., MS-0505 // La Jolla, CA 92093 - 0505 USA // // Or contact: // // info@caida.org //=========================================================================== #ifndef _ARTSPROTOCOLTABLEDATA_HH_ #define _ARTSPROTOCOLTABLEDATA_HH_ extern "C" { #include #include "caida_t.h" } #include #include "ArtsProtocolTableEntry.hh" //--------------------------------------------------------------------------- // 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. //--------------------------------------------------------------------------- class ArtsProtocolTableData { public: //------------------------------------------------------------------------- // ArtsProtocolTableData() //......................................................................... // constructor //------------------------------------------------------------------------- ArtsProtocolTableData(); //------------------------------------------------------------------------- // ~ArtsProtocolTableData() //......................................................................... // destructor //------------------------------------------------------------------------- ~ArtsProtocolTableData(); //------------------------------------------------------------------------- // 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; //------------------------------------------------------------------------- // 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); //------------------------------------------------------------------------- // 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; //------------------------------------------------------------------------- // 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); //------------------------------------------------------------------------- // 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; //------------------------------------------------------------------------- // 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); //------------------------------------------------------------------------- // vector & ProtocolEntries() const //......................................................................... // Returns a reference to the vector of protocol entries in the // ArtsProtocolTableData object. //------------------------------------------------------------------------- vector & ProtocolEntries() const; //------------------------------------------------------------------------- // void SortEntriesByBytes() //......................................................................... // //------------------------------------------------------------------------- void SortEntriesByBytes(); void SortEntriesByPkts(); //------------------------------------------------------------------------- // 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; //------------------------------------------------------------------------- // 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; //------------------------------------------------------------------------- // 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); //------------------------------------------------------------------------- // 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); //------------------------------------------------------------------------- // 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; //------------------------------------------------------------------------- // 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; //------------------------------------------------------------------------- // ArtsProtocolTableData & // operator = (const ArtsProtocolTableData & artsProtocolTableData) //......................................................................... // Overloaded '=' operator for assigning one ArtsProtocolTableData // to another. //------------------------------------------------------------------------- ArtsProtocolTableData & operator = (const ArtsProtocolTableData & artsProtocolTableData); //------------------------------------------------------------------------- // friend ostream & // operator << (ostream& os, // const ArtsProtocolTableData & artsProtocolTableData) //......................................................................... // Overload ostream '<<' operator to dump the contents of an // ArtsProtocolTableData object to an ostream in a human-readable // form. Returns the ostream. //------------------------------------------------------------------------- friend ostream & operator << (ostream& os, const ArtsProtocolTableData & artsProtocolTableData); private: uint16_t _sampleInterval; uint64_t _totpkts; uint64_t _totbytes; mutable vector _protocolEntries; mutable uint32_t _length; }; #endif // _ARTSPROTOCOLTABLEDATA_HH_