jist.runtime
Class JistAPI

java.lang.Object
  jist.runtime.JistAPI

Direct Known Subclasses:

JistAPI_Impl

public class JistAPI
extends java.lang.Object

Represents the JIST application interface to the JIST system. A simulation application should not have any references into the jist.runtime package other than to the JistAPI class.

Since:

JIST1.0

Version:

$Id: JistAPI.java,v 1.52 2005/02/25 05:12:28 barr Exp $

Author:

Rimon Barr <barr+jist@cs.cornell.edu>

Nested Class Summary

static class	JistAPI.Continuable Tags a method (explicitly) as continuable.
static class	JistAPI.Continuation Tags a method as call-with-continuation (blocking).
static interface	JistAPI.CustomRewriter Interface for custom rewrite pass.
static interface	JistAPI.DoNotRewrite Do not rewrite tagged class.
static interface	JistAPI.Entity Tags a simulation object as an Entity.
static interface	JistAPI.Logger Interface for custom logger.
static interface	JistAPI.Proxiable Tags an object as a target for a Proxy Entity.
static interface	JistAPI.Timeless Tags a simulation object as an Timeless.

Field Summary

static long	END Simulation end time constant.
static int	RUN_BSH Beanshell script constant.
static int	RUN_CLASS Java application constant.
static int	RUN_JPY Jython script constant.
static JistAPI.Entity	THIS Entity reference for 'this'.

Constructor Summary

JistAPI()

Method Summary

static void	callStaticAt(java.lang.reflect.Method meth, java.lang.Object[] params, long time) Invoke a static method at given simulation time.
static Channel	createChannel() Create a new Channel entity.
static void	end() End simulation at current time.
static void	endAt(long time) End simulation at given (absolute) time.
static long	getTime() Return the current simulation time.
static java.lang.String	getTimeString() Return time string in simulation time units.
static void	installRewrite(JistAPI.CustomRewriter rewrite) Install a new rewriting step at top of chain.
static boolean	isEntity(java.lang.Object o) Determine whether given reference is an entity reference.
static void	log(java.lang.String s) Emit string to simulation log.
static java.lang.Object	proxy(java.lang.Object proxyTarget, java.lang.Class proxyInterface) Create proxy entity with given interface.
static java.lang.Object	proxyMany(java.lang.Object proxyTarget, java.lang.Class[] proxyInterface) Create a entity proxy with multiple given interfaces.
static JistAPI.Entity	ref(JistAPI.Entity entity) Get Entity reference for given Entity.
static void	run(int type, java.lang.String name, java.lang.String[] args, java.lang.Object properties) Bootstrap a new program or script.
static void	runAt(java.lang.Runnable r, long time) Call a runnable object at given simulation time.
static void	setLog(JistAPI.Logger logger) Set the simulation logger.
static void	setSimUnits(long ticks, java.lang.String name) Set simulation time units.
static void	sleep(long i) Advance the current simulation time, but do not block the current method.
static void	sleepBlock(long i) Advance the current simulation time, and block current method (using simulation time continuations) until that time.
static java.lang.String	toString(java.lang.Object o) Determine the String representation of an object or entity.

Methods inherited from class java.lang.Object

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

Field Detail

THIS

public static JistAPI.Entity THIS

Entity reference for 'this'.

END

public static long END

Simulation end time constant. Greater than any legal simulation time.

RUN_CLASS

public static final int RUN_CLASS

Java application constant.

See Also:

Constant Field Values

RUN_BSH

public static final int RUN_BSH

Beanshell script constant.

See Also:

Constant Field Values

RUN_JPY

public static final int RUN_JPY

Jython script constant.

See Also:

Constant Field Values

Constructor Detail

JistAPI

public JistAPI()

Method Detail

getTime

public static long getTime()

Return the current simulation time.

Returns:

current simulation time

sleep

public static void sleep(long i)

Advance the current simulation time, but do not block the current method.

Parameters:

i - number of time steps to advance simulation time

sleepBlock

public static void sleepBlock(long i)
                       throws JistAPI.Continuable

Advance the current simulation time, and block current method (using simulation time continuations) until that time. Note that sleep() is far less expensive in the current implementation. SleepBlock requires two events and to store the continuation... a considerable overhead in comparison.

Parameters:

i - number of time steps to advance simulation time

Throws:

JistAPI.Continuable

ref

public static JistAPI.Entity ref(JistAPI.Entity entity)

Get Entity reference for given Entity.

Parameters:

entity - entity to convert into entity reference

Returns:

entity reference of given entity

end

public static void end()

End simulation at current time.

endAt

public static void endAt(long time)

End simulation at given (absolute) time.

Parameters:

time - simulation time at which to end simulation

callStaticAt

public static void callStaticAt(java.lang.reflect.Method meth,
                                java.lang.Object[] params,
                                long time)

Invoke a static method at given simulation time.

Parameters:

meth - method to invoke

params - parameters of invocation

time - simulation invocation time

runAt

public static void runAt(java.lang.Runnable r,
                         long time)

Call a runnable object at given simulation time.

Parameters:

r - runnable object

time - invocation time

proxy

public static java.lang.Object proxy(java.lang.Object proxyTarget,
                                     java.lang.Class proxyInterface)

Create proxy entity with given interface.

Parameters:

proxyTarget - target object of proxy entity

proxyInterface - public interface of proxy entity

Returns:

proxy entity object

proxyMany

public static java.lang.Object proxyMany(java.lang.Object proxyTarget,
                                         java.lang.Class[] proxyInterface)

Create a entity proxy with multiple given interfaces.

Parameters:

proxyTarget - target object of proxy entity

proxyInterface - public interfaces of proxy entity

Returns:

proxy entity object

createChannel

public static Channel createChannel()

Create a new Channel entity.

Returns:

new Channel entity

installRewrite

public static void installRewrite(JistAPI.CustomRewriter rewrite)

Install a new rewriting step at top of chain.

Parameters:

rewrite - rewrite traversal object

run

public static void run(int type,
                       java.lang.String name,
                       java.lang.String[] args,
                       java.lang.Object properties)

Bootstrap a new program or script.

Parameters:

type - bootstrap type

name - script or application name

args - command-line arguments

properties - values passed to the bootstrap agent

setSimUnits

public static void setSimUnits(long ticks,
                               java.lang.String name)

Set simulation time units.

Parameters:

ticks - number of simulation ticks per unit

name - time unit of measure name

getTimeString

public static java.lang.String getTimeString()

Return time string in simulation time units.

Returns:

time string in simulation time units

setLog

public static void setLog(JistAPI.Logger logger)

Set the simulation logger.

Parameters:

logger - logger instance

log

public static void log(java.lang.String s)

Emit string to simulation log.

Parameters:

s - log information

isEntity

public static boolean isEntity(java.lang.Object o)

Determine whether given reference is an entity reference.

Parameters:

o - object reference to test

Returns:

whether given reference is an entity reference

toString

public static java.lang.String toString(java.lang.Object o)

Determine the String representation of an object or entity.

Parameters:

o - object to stringify

Returns:

string representation of given object