Class/Object

org.cert.netsa.io.ipfix

IpfixSet

Related Docs: object IpfixSet | package ipfix

Permalink

sealed abstract class IpfixSet extends AnyRef

The IpfixSet class represents an IPFIX Set. (The name is "IpfixSet" to avoid conflicts with the standard Scala Set).

A Set is a generic term for a collection of records that have a similar structure. A Set consists of a 4-byte Set Header and one or more records.

There are three types of Sets: (1)Data Sets contain IPFIX flow records and are represented by the RecordSet class. (2)Template Sets and (3)Option Template Sets contain templates (or schemas) that describe the representation of the data in Data Sets. They are represented by the TemplateSet class.

To create a Set from IPFIX data stored in a java.nio.ByteBuffer that was read as part of message, use

val set = IpfixSet.fromBuffer(buffer, message)
Since

1.3.1 This class was previously called Set.

See also

The companion object for more details

Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. IpfixSet
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def size: Int

    Permalink

    Returns the number of items (Data Records or Template Records) in the Set.

  2. abstract def toBuffer(buffer: ByteBuffer): ByteBuffer

    Permalink

    Appends the Set to a buffer for writing to an IPFIX stream.

    Appends the Set to a buffer for writing to an IPFIX stream.

    Exceptions thrown

    java.nio.BufferOverflowException if there is not enough room in the buffer for all items in the Set. The buffer's position when an error is thrown unknown.

Concrete 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. final def asInstanceOf[T0]: T0

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    AnyRef → Any
  11. final val id: Int

    Permalink

    The identifier for this Set, which is a Template identifier if the Set is RecordSet.

  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  16. def recordIterator: Iterator[Record]

    Permalink

    Returns an Iterator over the Records in this IpfixSet, returning an empty Iterator if this is a TemplateSet.

  17. final val session: Session

    Permalink

    The Session which the Set was read from or will be written to.

  18. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  19. def templateIterator: Iterator[Template]

    Permalink

    Returns an Iterator over the Templates in this IpfixSet, returning an empty Iterator if this is a RecordSet.

  20. def toString(): String

    Permalink

    Returns a String representation the Set.

    Returns a String representation the Set.

    Definition Classes
    IpfixSet → AnyRef → Any
  21. final def wait(): Unit

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped