Class

org.cert.netsa.io.ipfix

SessionGroup

Related Doc: package ipfix

Permalink

final case class SessionGroup(infoModel: InfoModel, transport: AnyRef, streamSessions: Boolean = true) extends Product with Serializable

A SessionGroup maintains a set of Sessions for a single transport session. Put more carefully, it maintains a group of sessions that can be distinguished solely by an observation domain identifier.

A SessionGroup is created to create either StreamSessions or DatagramSessions. A StreamSession is used when reading data from files or over TCP; it supports template withdrawal and re-use of a template ID raises an exception. A DatagramSession is used when reading data over UDP; it does not support template withdrawal and re-use of template IDs is permitted.

transport is an object may be used to describe the transport, such as an InetSocketAddress for network transports or a Path for a file transport. It may be null. The SessionGroup does not use this parameter, and the caller may use it however it chooses.

Creates a session group. Each new session in the group will be created using the given session factory.

infoModel

the information model

transport

an object that describes the transport of the transport session. It will be an InetSocketAddress for network transports, or a Path for a file transport. May be null.

streamSessions

true when the group is used to read data from a file or over TCP (creates a StreamSession), and false for reading data over UDP (creates a DatagramSession).

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SessionGroup
  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 SessionGroup(infoModel: InfoModel, transport: AnyRef, streamSessions: Boolean = true)

    Permalink

    infoModel

    the information model

    transport

    an object that describes the transport of the transport session. It will be an InetSocketAddress for network transports, or a Path for a file transport. May be null.

    streamSessions

    true when the group is used to read data from a file or over TCP (creates a StreamSession), and false for reading data over UDP (creates a DatagramSession).

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 finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  9. def getOrCreateSession(domain: Int): Session

    Permalink

    Retrieves a session from the group.

    Retrieves a session from the group. If a session with the given domain is not found, creates it, adds it, and returns the new session.

    domain

    an observation domain identifier

    returns

    the session associated with the domain

  10. def getSession(domain: Int): Option[Session]

    Permalink

    Retrieves a session from the group as an Option.

    Retrieves a session from the group as an Option.

    domain

    an observation domain identifier

    returns

    the session associated with the domain, or None if there is no such session

  11. def hasSession(domain: Int): Boolean

    Permalink

    Determines whether group is maintaining a session matching the given domain.

    Determines whether group is maintaining a session matching the given domain.

    domain

    an observation domain identifier

    returns

    true if this group has a session for the domain

  12. val infoModel: InfoModel

    Permalink

    the information model

  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  14. def iterator: Iterator[Session]

    Permalink

    Returns an iterator over the Sessions in the SessionGroup.

  15. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  18. def register(callback: TemplateCallback): Unit

    Permalink

    Registers a new template callback.

    Registers a new template callback.

    A session group may have any number of callbacks registered to it. Each registered callback is added to new sessions created by this session group.

    callback

    the template callback

  19. def retireSession(domain: Int): Boolean

    Permalink

    Removes a session from the group.

    Removes a session from the group.

    domain

    an observation domain identifier

    returns

    true if the group previously contained a session for the domain

  20. val streamSessions: Boolean

    Permalink

    true when the group is used to read data from a file or over TCP (creates a StreamSession), and false for reading data over UDP (creates a DatagramSession).

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

    Permalink
    Definition Classes
    AnyRef
  22. val transport: AnyRef

    Permalink

    an object that describes the transport of the transport session.

    an object that describes the transport of the transport session. It will be an InetSocketAddress for network transports, or a Path for a file transport. May be null.

  23. final def wait(): Unit

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

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

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

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped