ArtsPortTableEntry

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

Quick Index

DESCRIPTION

Class Summary

class ArtsPortTableEntry

{

public:
ArtsPortTableEntry();
~ArtsPortTableEntry();
uint16_t PortNumber() const;
uint16_t PortNumber(uint16_t portNum);
uint64_t InPkts() const;
uint64_t InPkts(uint64_t pkts);
uint64_t InBytes() const;
uint64_t InBytes(uint64_t bytes);
uint64_t OutPkts() const;
uint64_t OutPkts(uint64_t pkts);
uint64_t OutBytes() const;
uint64_t OutBytes(uint64_t bytes);
uint8_t Descriptor() const;
uint8_t Descriptor(uint8_t descriptor);
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 ArtsPortTableEntry & artsPortTableEntry);
friend ostream & operator << (ostream& os, const ArtsPortTableEntry & artsPortTableEntry);
protected:
}; // ArtsPortTableEntry

Back to the top of ArtsPortTableEntry

DESCRIPTION


---------------------------------------------------------------------------
class ArtsPortTableEntry
---------------------------------------------------------------------------
Class representing a port table entry.
---------------------------------------------------------------------------

Back to the top of ArtsPortTableEntry

ArtsPortTableEntry();


-------------------------------------------------------------------------
ArtsPortTableEntry()
.........................................................................
constructor
-------------------------------------------------------------------------

  ArtsPortTableEntry();

Back to the top of ArtsPortTableEntry

~ArtsPortTableEntry();


-------------------------------------------------------------------------
~ArtsPortTableEntry()
.........................................................................
destructor
-------------------------------------------------------------------------

  ~ArtsPortTableEntry();

Back to the top of ArtsPortTableEntry

uint16_t PortNumber() const;


-------------------------------------------------------------------------
uint16_t PortNumber() const;
.........................................................................
Returns the port number for the port entry.
-------------------------------------------------------------------------

  uint16_t PortNumber() const;

Back to the top of ArtsPortTableEntry

uint16_t PortNumber(uint16_t portNum);


-------------------------------------------------------------------------
uint16_t PortNumber(uint16_t portNum)
.........................................................................
Sets and returns the port number for the port entry.
-------------------------------------------------------------------------

  uint16_t PortNumber(uint16_t portNum);

Back to the top of ArtsPortTableEntry

uint64_t InPkts() const;


-------------------------------------------------------------------------
uint64_t InPkts() const
.........................................................................
Returns the input packet count for the port entry. This is the number of packets received by the port. For example, InPkts() for port 80 would represent the number of packets sent to HTTP servers from HTTP clients.
-------------------------------------------------------------------------

  uint64_t InPkts() const;

Back to the top of ArtsPortTableEntry

uint64_t InPkts(uint64_t pkts);


-------------------------------------------------------------------------
uint64_t InPkts(uint64_t pkts)
.........................................................................
Sets and returns the input packet count for the port entry. This is the number of packets received by the port. For example, InPkts() for port 80 would represent the number of packets sent to HTTP servers from HTTP clients.
-------------------------------------------------------------------------

  uint64_t InPkts(uint64_t pkts);

Back to the top of ArtsPortTableEntry

uint64_t InBytes() const;


-------------------------------------------------------------------------
inline uint64_t InBytes() const
.........................................................................
Returns the input byte count for the port entry. This is the number of bytes received by the port. For example, InBytes() for port 80 would represent the number of bytes sent to HTTP servers from HTTP clients.
-------------------------------------------------------------------------

  uint64_t InBytes() const;

Back to the top of ArtsPortTableEntry

uint64_t InBytes(uint64_t bytes);


-------------------------------------------------------------------------
inline uint64_t InBytes(uint64_t bytes)
.........................................................................
Sets and returns the input byte count for the port entry. This is the number of bytes received by the port. For example, InBytes() for port 80 would represent the number of bytes sent to HTTP servers from HTTP clients.
-------------------------------------------------------------------------

  uint64_t InBytes(uint64_t bytes);

Back to the top of ArtsPortTableEntry

uint64_t OutPkts() const;


-------------------------------------------------------------------------
uint64_t OutPkts() const
.........................................................................
Returns the output packet count for the port entry. This is the number of packets sent from the port. For example, OutPkts() for port 80 would represent the number of packets sent from HTTP servers to HTTP clients.
-------------------------------------------------------------------------

  uint64_t OutPkts() const;

Back to the top of ArtsPortTableEntry

uint64_t OutPkts(uint64_t pkts);


-------------------------------------------------------------------------
uint64_t OutPkts(uint64_t pkts)
.........................................................................
Sets and returns the output packet count for the port entry. This is the number of packets sent from the port. For example, OutPkts() for port 80 would represent the number of packets sent from HTTP servers to HTTP clients.
-------------------------------------------------------------------------

  uint64_t OutPkts(uint64_t pkts);

Back to the top of ArtsPortTableEntry

uint64_t OutBytes() const;


-------------------------------------------------------------------------
uint64_t OutBytes() const
.........................................................................
Returns the output byte count for the port entry. This is the number of bytes sent from the port. For example, OutBytes() for port 80 would represent the number of bytes sent from HTTP servers to HTTP clients.
-------------------------------------------------------------------------

  uint64_t OutBytes() const;

Back to the top of ArtsPortTableEntry

uint64_t OutBytes(uint64_t bytes);


-------------------------------------------------------------------------
inline uint64_t OutBytes(uint64_t bytes)
.........................................................................
Sets and returns the output byte count for the port entry. This is the number of bytes sent from the port. For example, OutBytes() for port 80 would represent the number of bytes sent from HTTP servers to HTTP clients.
-------------------------------------------------------------------------

  uint64_t OutBytes(uint64_t bytes);

Back to the top of ArtsPortTableEntry

uint8_t Descriptor() const;


-------------------------------------------------------------------------
uint8_t Descriptor() const
.........................................................................
Returns the descriptor for the port entry. The Descriptor is a bitmask containing encoded lengths for the packet and byte counters. Currently its use is mostly internal to this class.
-------------------------------------------------------------------------

  uint8_t  Descriptor() const;

Back to the top of ArtsPortTableEntry

uint8_t Descriptor(uint8_t descriptor);


-------------------------------------------------------------------------
uint8_t Descriptor(uint8_t descriptor)
.........................................................................
Sets and returns the descriptor for the port entry. The Descriptor is a bitmask containing encoded lengths for the packet and byte counters. Currently its use is mostly internal to this class (hence this particular member function could be private?).
-------------------------------------------------------------------------

  uint8_t  Descriptor(uint8_t descriptor);

Back to the top of ArtsPortTableEntry

uint32_t Length(uint8_t version ) const;


-------------------------------------------------------------------------
uint32_t Length(uint8_t version = 0) const
.........................................................................
Returns the number of bytes needed to store the port entry in a file.
-------------------------------------------------------------------------

  uint32_t Length(uint8_t version = 0) const;

Back to the top of ArtsPortTableEntry

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


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

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

Back to the top of ArtsPortTableEntry

int read(int fd, uint8_t version );


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

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

Back to the top of ArtsPortTableEntry

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


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

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

Back to the top of ArtsPortTableEntry

int write(int fd, uint8_t version ) const;


-------------------------------------------------------------------------
int write(int fd, uint8_t version = 0) const
.........................................................................
Writes an ArtsPortTableEntry 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 ArtsPortTableEntry

operator = (const ArtsPortTableEntry & artsPortTableEntry);

No documentation available.

  operator = (const ArtsPortTableEntry & artsPortTableEntry);

Back to the top of ArtsPortTableEntry

friend ostream & operator << (ostream& os, const ArtsPortTableEntry & artsPortTableEntry);


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

  friend ostream & operator << (ostream& os,
                                const ArtsPortTableEntry & artsPortTableEntry);

Back to the top of ArtsPortTableEntry

All Members

public:
uint16_t PortNumber() const;
uint16_t PortNumber(uint16_t portNum);
uint64_t InPkts() const;
uint64_t InPkts(uint64_t pkts);
uint64_t InBytes() const;
uint64_t InBytes(uint64_t bytes);
uint64_t OutPkts() const;
uint64_t OutPkts(uint64_t pkts);
uint64_t OutBytes() const;
uint64_t OutBytes(uint64_t bytes);
uint8_t Descriptor() const;
uint8_t Descriptor(uint8_t descriptor);
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 ArtsPortTableEntry & artsPortTableEntry);
friend ostream & operator << (ostream& os, const ArtsPortTableEntry & artsPortTableEntry);
protected:

Back to the top of ArtsPortTableEntry

Ancestors

Class does not inherit from any other class.

Back to the top of ArtsPortTableEntry

Descendants

Class is not inherited by any others.

Back to the top of ArtsPortTableEntry

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

Report problems to jkotula@unimax.com