SSF.OS
Class ProbeSession

java.lang.Object
  |
  +--SSF.OS.ProtocolSession
        |
        +--SSF.OS.ProbeSession

All Implemented Interfaces:

com.renesys.raceway.DML.Configurable

public class ProbeSession

extends ProtocolSession

Class facilitating the use of the package SSF.Util.Streams. From any protocol or protocol-related code, access the "probe" protocol and call getRecorder to get a handle on an implementation of StreamInterface suitable for sending records.

See Also:

SSF.Util.Streams

Field Summary

Fields inherited from class SSF.OS.ProtocolSession

name, use

Constructor Summary

ProbeSession()

Method Summary

void	config(com.renesys.raceway.DML.Configuration cfg) Example DML configuration:
void	config(java.lang.String hostname, int portnum, java.lang.String certif)
void	config(java.lang.String filename, java.lang.String certif)
int	getHostCode()
int	getHostCode(int ifacenum)
StreamInterface	getRecorder()
StreamInterface	GetRecorder(java.lang.Runnable finalizer)
boolean	push(ProtocolMessage msg, ProtocolSession from) Routine to call when a message is being sent to ("pushed into") this ProtocolSession by another ProtocolSession.

Methods inherited from class SSF.OS.ProtocolSession

close, closed, debugIdentifier, inGraph, init, open, opened, pushAfterDelay, pushAfterDelayFailed, setGraph, version

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProbeSession

public ProbeSession()

Method Detail

getHostCode

public int getHostCode()

getHostCode

public int getHostCode(int ifacenum)

config

public void config(com.renesys.raceway.DML.Configuration cfg)
            throws com.renesys.raceway.DML.configException

Example DML configuration:

   ProtocolSession [
     name probe use SSF.OS.ProbeSession
     file "flow_data/flowCampus2.dat"
     stream "ipnetflow"
   ]
 

Specified by:

config in interface com.renesys.raceway.DML.Configurable

Overrides:

config in class ProtocolSession

com.renesys.raceway.DML.configException

config

public void config(java.lang.String filename,
                   java.lang.String certif)
            throws com.renesys.raceway.DML.configException

com.renesys.raceway.DML.configException

config

public void config(java.lang.String hostname,
                   int portnum,
                   java.lang.String certif)
            throws com.renesys.raceway.DML.configException

com.renesys.raceway.DML.configException

push

public boolean push(ProtocolMessage msg,
                    ProtocolSession from)

Description copied from class: ProtocolSession

Routine to call when a message is being sent to ("pushed into") this ProtocolSession by another ProtocolSession. The pusher sends a reference to itself in the second argument. This push happens immediately, without any simulation time elapsing, regardless of other activities taking place in the ProtocolGraph.

If you desire "safe" interaction with other CPU activities, even though your push() consumes no measurable/modelable CPU cycles, define the "cpudelay true" attribute for the ProtocolGraph and use pushAfterDelay(message,fromSession,0.0). This will guarantee proper ordering; that is, the framework will wait until the CPU is free before proceeding with the requested push().

Specified by:

push in class ProtocolSession

getRecorder

public StreamInterface getRecorder()

GetRecorder

public StreamInterface GetRecorder(java.lang.Runnable finalizer)