Session 1.5.0 - org.cert.netsa.io.ipfix.Session

Instance Constructors

new Session(group: SessionGroup, id: Int)

Auxiliary constructor
Auxiliary constructor
Creates a new session from the given session group and observation domain ID. The new session creates a new information model that inherits from the SessionGroup's information model.
group
the session group that owns the session
id
the observation domain ID

Attributes
protected

Value Members

final def !=(arg0: Any): Boolean

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

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

Definition Classes
AnyRef → Any
def add(template: Template, tid: Int): Option[Template]

Adds a Template to this Session using tid as the templateId and replacing the Template that previously used that ID, if any.
Adds a Template to this Session using tid as the templateId and replacing the Template that previously used that ID, if any. To add template only if it is not already present, use getOrAdd.
If template.size is 0, withdraws and returns the Template whose ID is tid. The Template if not withdrawn if this is a DatagramSession.
template
The template to add.
tid
The ID for the template.
returns
The template being replaced, or None

Exceptions thrown
Session.TemplateInterferenceException when a template is replaced that may not be replaced, by policy
java.lang.RuntimeException when the template's session is not this.
def addTemplateMetadata(metadata: TemplateMetadata): Unit

Updates the metadata for a particular template in this Session.
Updates the metadata for a particular template in this Session. Ignores metadata if its template ID is invalid.
final def apply(template: Template): Int

Gets the ID used by template within this Session.
Gets the ID used by template within this Session.

Since
1.3.1
Exceptions thrown
NoTemplateException if the Session does not know about that Template.
See also
getId
final def apply(tid: Int): Template

Gets a Template from the template library based on the template ID.
Gets a Template from the template library based on the template ID.

Since
1.3.1
Exceptions thrown
NoTemplateException if the Session does not have a Template with that ID.
See also
getTemplate
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

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

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
var expectedSequence: Long

The sequence number that is expected for the next message in this session.
The sequence number that is expected for the next message in this session.
It is value a value between 0 and 2^32-1, or -1 if no message has yet been observed in this session.
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def findUnusedId(): Option[Int]

Find a template ID not currently being used by this session.
Find a template ID not currently being used by this session. Returns None when the Session has no available IDs. (Not necessarily deterministic.)
returns
a currently unused template ID
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def getId(template: Template): Option[Int]

Gets the ID for the Template within this session as an Option.
def getOrAdd(template: Template, tid: Option[Int] = None): Int

Returns the ID for template in this Session, adding template to this Session if it does not exist.
Returns the ID for template in this Session, adding template to this Session if it does not exist.
If template must be added to the Session, an arbitrary ID is used when tid is None. If tid is not None, that ID is used if possible; otherwise an arbitrary ID is used. Use the add method if template must use a particular ID.
Takes no action and returns 0 if template.size is 0.
template
The Template to get or add
tid
An optional ID for template if it does not exist in the Session
returns
The ID of template in this Session
def getPersistentSession(): Session

Returns a read-only copy of this session that will not change.
Returns a read-only copy of this session that will not change.
returns
the persistent session
final def getTemplate(tid: Int): Option[Template]

Gets a Template from the template library based on the template ID as an Option.
Gets a Template from the template library based on the template ID as an Option.
tid
the template ID
returns
The template associated with the template ID, or None
def getTemplateMetadata(tid: Int): Option[TemplateMetadata]

Gets the metadata for the Template whose ID is tid as an Option.
def hashCode(): Int

Definition Classes
AnyRef → Any
final var idGetTmpl: TrieMap[Int, Template]

Maps a templateId to a Template.
Maps a templateId to a Template. "protected" since ReadOnlySession needs access

Attributes
protected
final val infoModel: InfoModel

The information model used by the session.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def iterator: Iterator[Template]

Returns an Iterator over the Templates in the Session.
val logger: Logger

Attributes
protected
Definition Classes
StrictLogging
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def noteMessage(m: Message): Unit

Check for missing or out of sequence records.
Check for missing or out of sequence records. If found, invoke any SequenceCallback objects that have been registered and log a message. A log message is not written if no SequenceCallback objects have been registered.
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final val observationDomain: Int

The observation domain for the session, an unsigned 32-bit value.
The observation domain for the session, an unsigned 32-bit value. Transport sessions that have a single observation domain typically have an observation domain ID of zero.
def register(callback: SequenceCallback): Unit

Registers a new sequence callback with this session.
Registers a new sequence callback with this session. A session can have any number of callbacks registered to it. Each registered callback will be called whenever a message arrives with an unexpected sequence number.
callback
the sequence number callback
def register(callback: Iterable[TemplateCallback]): Unit

Registers multiple templates callbacks with this session.
def register(callback: TemplateCallback): Unit

Registers a new template callback with this session.
Registers a new template callback with this session. A session can have any number of callbacks registered to it. Each registered callback will be called whenever a template is added or removed from the session template library.
callback
the template callback
def remove(template: Template): Option[Template]

Removes a template from this session.
Removes a template from this session.
template
The template to remove
returns
the template that was removed, or None if none
def remove(tid: Int): Option[Template]

Removes a template from this session.
Removes a template from this session.
tid
the template ID of the template to remove
returns
the template that was removed, or None if none
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final var templateMetadata: TrieMap[Int, TemplateMetadata]

Maps a templateId to its metadata
Maps a templateId to its metadata

Attributes
protected
final var tmplGetId: TrieMap[Template, Int]

Maps a Template to its templateId in this Session.
Maps a Template to its templateId in this Session.

Attributes
protected
def toString(): String

Definition Classes
AnyRef → Any
final val transport: AnyRef

The source information for this session.
The source information for this session. If the source is a file, transport is a String containing the file name. If the source is a network connection, transport is an InetSocketAddress representing the remote side of this session's connection.
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )
def withdraw(t: Template, tid: Int): Option[Template]

Internal function that removes a template when a withdrawal template is received on the input stream.
Internal function that removes a template when a withdrawal template is received on the input stream. That is, when add() is called with a withdrawal template.

Attributes
protected

Session

Related Docs: object Session | package ipfix

sealed class Session extends StrictLogging

Instance Constructors

new Session(group: SessionGroup, id: Int)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def add(template: Template, tid: Int): Option[Template]

def addTemplateMetadata(metadata: TemplateMetadata): Unit

final def apply(template: Template): Int

final def apply(tid: Int): Template

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

var expectedSequence: Long

def finalize(): Unit

final def findUnusedId(): Option[Int]

final def getClass(): Class[_]

final def getId(template: Template): Option[Int]

def getOrAdd(template: Template, tid: Option[Int] = None): Int

def getPersistentSession(): Session

final def getTemplate(tid: Int): Option[Template]

def getTemplateMetadata(tid: Int): Option[TemplateMetadata]

def hashCode(): Int

final var idGetTmpl: TrieMap[Int, Template]

final val infoModel: InfoModel

final def isInstanceOf[T0]: Boolean

final def iterator: Iterator[Template]

val logger: Logger

final def ne(arg0: AnyRef): Boolean

final def noteMessage(m: Message): Unit

final def notify(): Unit

final def notifyAll(): Unit

final val observationDomain: Int

def register(callback: SequenceCallback): Unit

def register(callback: Iterable[TemplateCallback]): Unit

def register(callback: TemplateCallback): Unit

def remove(template: Template): Option[Template]

def remove(tid: Int): Option[Template]

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

final var templateMetadata: TrieMap[Int, TemplateMetadata]

final var tmplGetId: TrieMap[Template, Int]

def toString(): String

final val transport: AnyRef

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def withdraw(t: Template, tid: Int): Option[Template]

Inherited from StrictLogging

Inherited from AnyRef

Inherited from Any

Ungrouped