Class/Object

org.cert.netsa.io.ipfix

ExportStreamTemplatesFirst

Related Docs: object ExportStreamTemplatesFirst | package ipfix

Permalink

class ExportStreamTemplatesFirst extends ExportStream

ExportStreamTemplatesFirst extends the ExportStream class to ensure that Templates occur in the output stream before Records.

Instances of this class only produce output when the close() method is called.

Note: When template metadata or information element metadata is being written to the stream, those records may appear before some templates.

Linear Supertypes
ExportStream, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ExportStreamTemplatesFirst
  2. ExportStream
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def add(template: Template): ExportStream

    Permalink

    Adds template to the output stream unless the template has already been seen by this stream.

    Adds template to the output stream unless the template has already been seen by this stream.

    If template appears to be a template for describing either information element meta-data or template meta-data, then the template is ignored if the Export Stream is exporting that meta-data itself (see the describeElements and describeTemplates variables).

    Definition Classes
    ExportStreamTemplatesFirstExportStream
  5. def add(reader: MessageReader): ExportStream

    Permalink

    Add all records from a MesageReader to this ExportStream

    Add all records from a MesageReader to this ExportStream

    Definition Classes
    ExportStream
  6. def add(record: Record): ExportStream

    Permalink

    Adds record to the output stream.

    Adds record to the output stream. Prior to adding record, adds any Templates used by record that have not been seen before.

    If record appears to contain either information element meta-data or template meta-data, then the record is ignored if the Export Stream is exporting that meta-data itself (see the describeElements and describeTemplates variables).

    Definition Classes
    ExportStream
  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. def close(): Unit

    Permalink

    Flushes and closes the output stream.

    Flushes and closes the output stream.

    Definition Classes
    ExportStreamTemplatesFirstExportStream
  10. def dataWrittenCallback: Option[DataWrittenCallback]

    Permalink

    Gets the current callback invoked when bytes are written to the outputStream as an Option.

    Gets the current callback invoked when bytes are written to the outputStream as an Option.

    Definition Classes
    ExportStream
    Since

    1.3.1

  11. def dataWrittenCallback_=(callback: DataWrittenCallback): Unit

    Permalink

    Sets a callback to be invoked when bytes are written to the outputStream.

    Sets a callback to be invoked when bytes are written to the outputStream.

    Definition Classes
    ExportStream
    Since

    1.3.1

  12. var describeElements: Boolean

    Permalink

    Whether to export option records that describe private enterprise information elements.

    Whether to export option records that describe private enterprise information elements.

    If this is true, ExportStream generates these records itself and any such records given to the add method are ignored. The records are generated as-needed and may appear anywhere in the output.

    If this is false, input records that describe private enterprise elements are written to the output without ExportStream examining their content. This may result in duplicate descriptions in the output.

    In either case, ExportStream attempts to use the same template ID for the element metadata template as seen in the incoming data.

    Definition Classes
    ExportStream
  13. var describeTemplates: Boolean

    Permalink

    Whether to export option records that include the name and description of each template.

    Whether to export option records that include the name and description of each template.

    If this is true, ExportStream generates these records itself and any such records given to the add method are ignored. The records are generated as-needed and may appear anywhere in the output.

    If this is false, input records that describe templates are written to the output without ExportStream examining their content. This may result in duplicate descriptions in the output.

    In either case, ExportStream attempts to use the same template ID for the template metadata template as seen in the incoming data.

    Definition Classes
    ExportStream
  14. def elementDescriptionTID: Option[Int]

    Permalink

    Returns the template ID for the options template used by records that describe private enterprise information elements.

    Returns the template ID for the options template used by records that describe private enterprise information elements. Returns scala.None if no ID has been assigned.

    Definition Classes
    ExportStream
  15. def elementDescriptionTID_=(tid: Int): Unit

    Permalink

    Sets the template ID for the options template used by records that describe private enterprise information elements and exports the template to ensure the template ID is reserved.

    Sets the template ID for the options template used by records that describe private enterprise information elements and exports the template to ensure the template ID is reserved.

    Definition Classes
    ExportStream
    Exceptions thrown

    IllegalTemplateRecordException when tid is illegal or is already in use by the session.

    java.lang.RuntimeException when tid cannot be used for the template because the template already exists.

  16. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  18. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. def flush(): ExportStream

    Permalink

    Flushes any data currently sitting in memory.

    Flushes any data currently sitting in memory.

    Definition Classes
    ExportStream
  20. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  21. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  22. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  23. var knownTmpl: Set[Template]

    Permalink

    The set of templates that have been exported

    The set of templates that have been exported

    Definition Classes
    ExportStream
  24. var makeTimestamp: MessageTimestamp

    Permalink

    Callback to generate a timestamp

    Callback to generate a timestamp

    Definition Classes
    ExportStream
  25. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  26. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  27. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  28. def outputStream: WritableByteChannel

    Permalink

    Returns the file channel to which the data is being written

    Returns the file channel to which the data is being written

    Definition Classes
    ExportStreamTemplatesFirstExportStream
  29. def recordCount: Int

    Permalink

    Returns the number of data records added to the stream.

    Returns the number of data records added to the stream.

    Definition Classes
    ExportStream
  30. val session: Session

    Permalink

    The session to use.

    The session to use.

    Definition Classes
    ExportStream
  31. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  32. def templateCount: Int

    Permalink

    Returns the number of templates added to the stream.

    Returns the number of templates added to the stream.

    Definition Classes
    ExportStream
  33. def templateDescriptionTID: Option[Int]

    Permalink

    Returns the template ID for the options template used by records that describe templates.

    Returns the template ID for the options template used by records that describe templates. Returns scala.None if no ID has been assigned.

    Definition Classes
    ExportStream
  34. def templateDescriptionTID_=(tid: Int): Unit

    Permalink

    Sets the template ID for the options template used by records that describe templates and exports the template to ensure the template ID is reserved.

    Sets the template ID for the options template used by records that describe templates and exports the template to ensure the template ID is reserved.

    Definition Classes
    ExportStream
    Exceptions thrown

    IllegalTemplateRecordException when tid is illegal or is already in use by the session.

    java.lang.RuntimeException when tid cannot be used for the template because the template already exists.

  35. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  36. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from ExportStream

Inherited from AnyRef

Inherited from Any

Ungrouped