NetworkUtilizationRecord (Kieker Monitoring and Analysis Framework, Vers. 1.14API Documentation)

java.lang.Object
- kieker.common.record.AbstractMonitoringRecord
- - kieker.common.record.system.NetworkUtilizationRecord

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<IMonitoringRecord>, IMonitoringRecord
```
public class NetworkUtilizationRecord
extends AbstractMonitoringRecord
```
Since:

1.12

Author:

Teerat Pitakrat API compatibility: Kieker 1.15.0

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`HOSTNAME`
`static java.lang.String`	`INTERFACE_NAME`
`static double`	`RX_BYTES_PER_SECOND`
`static double`	`RX_DROPPED_PER_SECOND`
`static double`	`RX_ERRORS_PER_SECOND`
`static double`	`RX_FRAME_PER_SECOND`
`static double`	`RX_OVERRUNS_PER_SECOND`
`static double`	`RX_PACKETS_PER_SECOND`
`static int`	`SIZE` Descriptive definition of the serialization size of the record.
`static long`	`SPEED`
`static long`	`TIMESTAMP` default constants.
`static double`	`TX_BYTES_PER_SECOND`
`static double`	`TX_CARRIER_PER_SECOND`
`static double`	`TX_COLLISIONS_PER_SECOND`
`static double`	`TX_DROPPED_PER_SECOND`
`static double`	`TX_ERRORS_PER_SECOND`
`static double`	`TX_OVERRUNS_PER_SECOND`
`static double`	`TX_PACKETS_PER_SECOND`
`static java.lang.Class<?>[]`	`TYPES`
`static java.lang.String[]`	`VALUE_NAMES` property name array.

Fields inherited from class kieker.common.record.AbstractMonitoringRecord
TYPE_SIZE_BOOLEAN, TYPE_SIZE_BYTE, TYPE_SIZE_CHARACTER, TYPE_SIZE_DOUBLE, TYPE_SIZE_FLOAT, TYPE_SIZE_INT, TYPE_SIZE_LONG, TYPE_SIZE_SHORT, TYPE_SIZE_STRING

Constructor Summary

Constructors
Constructor and Description
`NetworkUtilizationRecord(IValueDeserializer deserializer)`
`NetworkUtilizationRecord(long timestamp, java.lang.String hostname, java.lang.String interfaceName, long speed, double txBytesPerSecond, double txCarrierPerSecond, double txCollisionsPerSecond, double txDroppedPerSecond, double txErrorsPerSecond, double txOverrunsPerSecond, double txPacketsPerSecond, double rxBytesPerSecond, double rxDroppedPerSecond, double rxErrorsPerSecond, double rxFramePerSecond, double rxOverrunsPerSecond, double rxPacketsPerSecond)` Creates a new instance of this class using the given parameters.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)` Performs a null-check, a this-check, and a class-check.
`java.lang.String`	`getHostname()`
`java.lang.String`	`getInterfaceName()`
`double`	`getRxBytesPerSecond()`
`double`	`getRxDroppedPerSecond()`
`double`	`getRxErrorsPerSecond()`
`double`	`getRxFramePerSecond()`
`double`	`getRxOverrunsPerSecond()`
`double`	`getRxPacketsPerSecond()`
`int`	`getSize()` This method should deliver the size of a binary representation of this record.
`long`	`getSpeed()`
`long`	`getTimestamp()`
`double`	`getTxBytesPerSecond()`
`double`	`getTxCarrierPerSecond()`
`double`	`getTxCollisionsPerSecond()`
`double`	`getTxDroppedPerSecond()`
`double`	`getTxErrorsPerSecond()`
`double`	`getTxOverrunsPerSecond()`
`double`	`getTxPacketsPerSecond()`
`java.lang.String[]`	`getValueNames()` This method delivers an array containing the value names of the record.
`java.lang.Class<?>[]`	`getValueTypes()` This method delivers an array with the classes of the single values for the record.
`int`	`hashCode()`
`void`	`serialize(IValueSerializer serializer)` This method serializes this record using the given serializer.
`java.lang.String`	`toString()` Creates a string representation of this record. This method should not be used for serialization purposes since this is not the purpose of Object's toString method.

Methods inherited from class kieker.common.record.AbstractMonitoringRecord
checkArray, classForName, compareTo, createFromDeserializer, fromStringArrayToTypedArray2, getLoggingTimestamp, isNotEqual, isNotEqual, setLoggingTimestamp, typesForClass

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SIZE
```
public static final int SIZE
```
    Descriptive definition of the serialization size of the record.
    
    See Also:
    
    Constant Field Values
  - TYPES
```
public static final java.lang.Class<?>[] TYPES
```
  - VALUE_NAMES
```
public static final java.lang.String[] VALUE_NAMES
```
    property name array.
  - TIMESTAMP
```
public static final long TIMESTAMP
```
    default constants.
    
    See Also:
    
    Constant Field Values
  - HOSTNAME
```
public static final java.lang.String HOSTNAME
```
    See Also:
    
    Constant Field Values
  - INTERFACE_NAME
```
public static final java.lang.String INTERFACE_NAME
```
    See Also:
    
    Constant Field Values
  - SPEED
```
public static final long SPEED
```
    See Also:
    
    Constant Field Values
  - TX_BYTES_PER_SECOND
```
public static final double TX_BYTES_PER_SECOND
```
    See Also:
    
    Constant Field Values
  - TX_CARRIER_PER_SECOND
```
public static final double TX_CARRIER_PER_SECOND
```
    See Also:
    
    Constant Field Values
  - TX_COLLISIONS_PER_SECOND
```
public static final double TX_COLLISIONS_PER_SECOND
```
    See Also:
    
    Constant Field Values
  - TX_DROPPED_PER_SECOND
```
public static final double TX_DROPPED_PER_SECOND
```
    See Also:
    
    Constant Field Values
  - TX_ERRORS_PER_SECOND
```
public static final double TX_ERRORS_PER_SECOND
```
    See Also:
    
    Constant Field Values
  - TX_OVERRUNS_PER_SECOND
```
public static final double TX_OVERRUNS_PER_SECOND
```
    See Also:
    
    Constant Field Values
  - TX_PACKETS_PER_SECOND
```
public static final double TX_PACKETS_PER_SECOND
```
    See Also:
    
    Constant Field Values
  - RX_BYTES_PER_SECOND
```
public static final double RX_BYTES_PER_SECOND
```
    See Also:
    
    Constant Field Values
  - RX_DROPPED_PER_SECOND
```
public static final double RX_DROPPED_PER_SECOND
```
    See Also:
    
    Constant Field Values
  - RX_ERRORS_PER_SECOND
```
public static final double RX_ERRORS_PER_SECOND
```
    See Also:
    
    Constant Field Values
  - RX_FRAME_PER_SECOND
```
public static final double RX_FRAME_PER_SECOND
```
    See Also:
    
    Constant Field Values
  - RX_OVERRUNS_PER_SECOND
```
public static final double RX_OVERRUNS_PER_SECOND
```
    See Also:
    
    Constant Field Values
  - RX_PACKETS_PER_SECOND
```
public static final double RX_PACKETS_PER_SECOND
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - NetworkUtilizationRecord
```
public NetworkUtilizationRecord(long timestamp,
                                java.lang.String hostname,
                                java.lang.String interfaceName,
                                long speed,
                                double txBytesPerSecond,
                                double txCarrierPerSecond,
                                double txCollisionsPerSecond,
                                double txDroppedPerSecond,
                                double txErrorsPerSecond,
                                double txOverrunsPerSecond,
                                double txPacketsPerSecond,
                                double rxBytesPerSecond,
                                double rxDroppedPerSecond,
                                double rxErrorsPerSecond,
                                double rxFramePerSecond,
                                double rxOverrunsPerSecond,
                                double rxPacketsPerSecond)
```
    Creates a new instance of this class using the given parameters.
    
    Parameters:
    
    timestamp - timestamp
    
    hostname - hostname
    
    interfaceName - interfaceName
    
    speed - speed
    
    txBytesPerSecond - txBytesPerSecond
    
    txCarrierPerSecond - txCarrierPerSecond
    
    txCollisionsPerSecond - txCollisionsPerSecond
    
    txDroppedPerSecond - txDroppedPerSecond
    
    txErrorsPerSecond - txErrorsPerSecond
    
    txOverrunsPerSecond - txOverrunsPerSecond
    
    txPacketsPerSecond - txPacketsPerSecond
    
    rxBytesPerSecond - rxBytesPerSecond
    
    rxDroppedPerSecond - rxDroppedPerSecond
    
    rxErrorsPerSecond - rxErrorsPerSecond
    
    rxFramePerSecond - rxFramePerSecond
    
    rxOverrunsPerSecond - rxOverrunsPerSecond
    
    rxPacketsPerSecond - rxPacketsPerSecond
  - NetworkUtilizationRecord
```
public NetworkUtilizationRecord(IValueDeserializer deserializer)
                         throws RecordInstantiationException
```
    Parameters:
    
    deserializer - The deserializer to use
    
    Throws:
    
    RecordInstantiationException - when the record could not be deserialized
- Method Detail
  - serialize
```
public void serialize(IValueSerializer serializer)
               throws java.nio.BufferOverflowException
```
    This method serializes this record using the given serializer.
    
    Parameters:
    
    serializer - The serializer to serialize the record with. *
    
    Throws:
    
    java.nio.BufferOverflowException - If the underlying buffer has insufficient capacity to store this record
  - getValueTypes
```
public java.lang.Class<?>[] getValueTypes()
```
    This method delivers an array with the classes of the single values for the record.
    
    Returns:
    
    The types of the values. This returned array should be treated readonly.
  - getValueNames
```
public java.lang.String[] getValueNames()
```
    This method delivers an array containing the value names of the record.
    
    Returns:
    
    The types of the values. This returned array should be treated readonly.
  - getSize
```
public int getSize()
```
    This method should deliver the size of a binary representation of this record.
    
    Returns:
    
    The size.
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Performs a null-check, a this-check, and a class-check. Moreover, it checks each attribute for equality.
    
    Overrides:
    
    equals in class AbstractMonitoringRecord
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AbstractMonitoringRecord
  - getTimestamp
```
public final long getTimestamp()
```
  - getHostname
```
public final java.lang.String getHostname()
```
  - getInterfaceName
```
public final java.lang.String getInterfaceName()
```
  - getSpeed
```
public final long getSpeed()
```
  - getTxBytesPerSecond
```
public final double getTxBytesPerSecond()
```
  - getTxCarrierPerSecond
```
public final double getTxCarrierPerSecond()
```
  - getTxCollisionsPerSecond
```
public final double getTxCollisionsPerSecond()
```
  - getTxDroppedPerSecond
```
public final double getTxDroppedPerSecond()
```
  - getTxErrorsPerSecond
```
public final double getTxErrorsPerSecond()
```
  - getTxOverrunsPerSecond
```
public final double getTxOverrunsPerSecond()
```
  - getTxPacketsPerSecond
```
public final double getTxPacketsPerSecond()
```
  - getRxBytesPerSecond
```
public final double getRxBytesPerSecond()
```
  - getRxDroppedPerSecond
```
public final double getRxDroppedPerSecond()
```
  - getRxErrorsPerSecond
```
public final double getRxErrorsPerSecond()
```
  - getRxFramePerSecond
```
public final double getRxFramePerSecond()
```
  - getRxOverrunsPerSecond
```
public final double getRxOverrunsPerSecond()
```
  - getRxPacketsPerSecond
```
public final double getRxPacketsPerSecond()
```
  - toString
```
public java.lang.String toString()
```
    Creates a string representation of this record.
    
    This method should not be used for serialization purposes since this is not the purpose of Object's toString method.
    
    Specified by:
    
    toString in interface IMonitoringRecord
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A (human readable) string of this record.

Class NetworkUtilizationRecord

Field Summary

Fields inherited from class kieker.common.record.AbstractMonitoringRecord

Constructor Summary

Method Summary

Methods inherited from class kieker.common.record.AbstractMonitoringRecord

Methods inherited from class java.lang.Object

Field Detail

SIZE

TYPES

VALUE_NAMES

TIMESTAMP

HOSTNAME

INTERFACE_NAME

SPEED

TX_BYTES_PER_SECOND

TX_CARRIER_PER_SECOND

TX_COLLISIONS_PER_SECOND

TX_DROPPED_PER_SECOND

TX_ERRORS_PER_SECOND

TX_OVERRUNS_PER_SECOND

TX_PACKETS_PER_SECOND

RX_BYTES_PER_SECOND

RX_DROPPED_PER_SECOND

RX_ERRORS_PER_SECOND

RX_FRAME_PER_SECOND

RX_OVERRUNS_PER_SECOND

RX_PACKETS_PER_SECOND

Constructor Detail

NetworkUtilizationRecord

NetworkUtilizationRecord

Method Detail

serialize

getValueTypes

getValueNames

getSize

equals

hashCode

getTimestamp

getHostname

getInterfaceName

getSpeed

getTxBytesPerSecond

getTxCarrierPerSecond

getTxCollisionsPerSecond

getTxDroppedPerSecond

getTxErrorsPerSecond

getTxOverrunsPerSecond

getTxPacketsPerSecond

getRxBytesPerSecond

getRxDroppedPerSecond

getRxErrorsPerSecond

getRxFramePerSecond

getRxOverrunsPerSecond

getRxPacketsPerSecond

toString