equip.data
Class EventMetadata

java.lang.Object
  equip.runtime.Object
      equip.runtime.ValueBase
          equip.data.EventMetadata

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

EventMetadataImpl

public abstract class EventMetadata

extends ValueBase

metadata for a dataspace Event

Field Summary

boolean	local whether the event should be kept within the local dataspace replica
int	priority Event priority, which may cause reordering in some communications protocols (e.g.
boolean	reliable whether the event should be distributed reliably.
GUID	requestor the GUID of the code fragment generating the event
GUID	source used internally in event routing (the origin dataspace replica)
Time	timestamp the time at which the event was created

Constructor Summary

EventMetadata()
Default no-arg constructor

Method Summary

boolean	_equals_helper(EventMetadata c) Internal IDL-generated equality test helper
boolean	_matches_helper(EventMetadata c) Internal IDL-generated match test helper
boolean	equals(java.lang.Object c) Standard IDL-generated equality test.
java.lang.String	getModuleName() IDL-generated helper routine to get module name (currently unimplemented).
abstract void	init(GUID agentId, boolean local, boolean reliable) initialisation helper, default to priority 0
abstract void	init2(GUID agentId, boolean local, boolean reliable, int priority) initialisation helper
boolean	matches(java.lang.Object c) Standard IDL-generated template match test.
void	readObject(ObjectInputStream in) Internal IDL-generated serialisation helper.
void	writeObject(ObjectOutputStream out) Internal IDL-generated serialisation helper.

Methods inherited from class equip.runtime.ValueBase

_equals_helper, _matches_helper, clone

Methods inherited from class java.lang.Object

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

Field Detail

timestamp

public Time timestamp

the time at which the event was created

requestor

public GUID requestor

the GUID of the code fragment generating the event

source

public GUID source

used internally in event routing (the origin dataspace replica)

local

public boolean local

whether the event should be kept within the local dataspace replica

reliable

public boolean reliable

whether the event should be distributed reliably. An unreliable event might be dropped by a communication protocol or dropped from a dataspace internal queue of similar events ('squashed').

priority

public int priority

Event priority, which may cause reordering in some communications protocols (e.g. JCP). priority defaults to 0; larger value = higher priority

Constructor Detail

EventMetadata

public EventMetadata()

Default no-arg constructor

Method Detail

init2

public abstract void init2(GUID agentId,
                           boolean local,
                           boolean reliable,
                           int priority)

initialisation helper

init

public abstract void init(GUID agentId,
                          boolean local,
                          boolean reliable)

initialisation helper, default to priority 0

getModuleName

public java.lang.String getModuleName()

IDL-generated helper routine to get module name (currently unimplemented).

Overrides:

getModuleName in class Object

Returns:

name of this class's module

equals

public boolean equals(java.lang.Object c)

Standard IDL-generated equality test.

Overrides:

equals in class ValueBase

Parameters:

c - The object to be compared against this.

Returns:

true if this is equal to c

_equals_helper

public boolean _equals_helper(EventMetadata c)

Internal IDL-generated equality test helper

matches

public boolean matches(java.lang.Object c)

Standard IDL-generated template match test.

Overrides:

matches in class ValueBase

Parameters:

c - The object to be checked against this template.

Returns:

true if this (as a template) matches the argument

_matches_helper

public boolean _matches_helper(EventMetadata c)

Internal IDL-generated match test helper

writeObject

public void writeObject(ObjectOutputStream out)
                 throws java.io.IOException

Internal IDL-generated serialisation helper. Used by ObjectInputStream and ObjectOutputStream only.

Overrides:

writeObject in class ValueBase

Throws:

java.io.IOException

readObject

public void readObject(ObjectInputStream in)
                throws java.io.IOException,
                       java.lang.ClassNotFoundException,
                       java.lang.InstantiationException

Internal IDL-generated serialisation helper. Used by ObjectInputStream and ObjectOutputStream only.

Overrides:

readObject in class ValueBase

Throws:

java.io.IOException

java.lang.ClassNotFoundException

java.lang.InstantiationException