Packages

case class Header(fileFlags: Byte, fileFormat: FileFormat, fileVersion: Byte, compressionMethod: CompressionMethod, silkVersion: SilkVersion, recordSize: Short, recordVersion: Short, headerEntries: IndexedSeq[HeaderEntry]) extends Product with Serializable

A SiLK file header, including contained header entries. Supports only "new-style" header format (SiLK versions 1.0+).

fileFlags

The bits encoding file flags. Currently only whether the file is big-endian.

fileFormat

The SiLK file format contained within this file.

fileVersion

The SiLK file version--specifically the version of the header format.

compressionMethod

The compression method used by data in this file.

silkVersion

The version of SiLK used to create this file.

recordSize

The size of individual (uncompressed) records in this file.

recordVersion

The record version of the file format.

headerEntries

Sequence of additional extensible header records of various types.

See also

Header.isBigEndian

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Header
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Header(fileFlags: Byte, fileFormat: FileFormat, fileVersion: Byte, compressionMethod: CompressionMethod, silkVersion: SilkVersion, recordSize: Short, recordVersion: Short, headerEntries: IndexedSeq[HeaderEntry])

    fileFlags

    The bits encoding file flags. Currently only whether the file is big-endian.

    fileFormat

    The SiLK file format contained within this file.

    fileVersion

    The SiLK file version--specifically the version of the header format.

    compressionMethod

    The compression method used by data in this file.

    silkVersion

    The version of SiLK used to create this file.

    recordSize

    The size of individual (uncompressed) records in this file.

    recordVersion

    The record version of the file format.

    headerEntries

    Sequence of additional extensible header records of various types.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def annotations: Seq[String]

    Annotations made on this SiLK file, if any.

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  7. val compressionMethod: CompressionMethod
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. val fileFlags: Byte
  10. val fileFormat: FileFormat
  11. val fileVersion: Byte
  12. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. def flowTypeId: Option[FlowType]

    Optional SiLK flow type for all flows in this packed file.

  14. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. val headerEntries: IndexedSeq[HeaderEntry]
  16. def invocations: Seq[String]

    Command-lines used to produce this SiLK file, if any.

  17. def isBigEndian: Boolean

    True if data within the records of this file are stored in big-endian (MSB first) format.

  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. def probeName: Option[String]

    Optional probe name recorded with SiLK file.

  23. val recordSize: Short
  24. val recordVersion: Short
  25. def sensorId: Option[Sensor]

    Optional SiLK sensor ID for all flows in this packed file.

  26. val silkVersion: SilkVersion
  27. def startTimeOffset: Option[Long]

    Optional base start time, in milliseconds since the UNIX epoch.

    Optional base start time, in milliseconds since the UNIX epoch. Times in this packed file are expressed as a delta from this base start time.

  28. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  32. def writeTo(outputStream: OutputStream): Unit

    Writes the header to the provided output stream.

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped