fulmine.event.system
Class TxEvent

java.lang.Object
  fulmine.event.AbstractEvent
      fulmine.event.system.TxEvent

All Implemented Interfaces:

IEvent, ISystemEvent, IAddressable, IDescriptor, Cloneable

public final class TxEvent
extends AbstractEvent
implements ISystemEvent

A transmission event encapsulates the byte[] that holds the state change in wire form of an IContainer to transmit.

This implementation of an ISystemEvent can be raised by a non- ISystemEventSource. This is so that an IEventListener for an IContainer will not receive these events.

Author:

Ramon Servadei

Constructor Summary

TxEvent(IEventSource source, byte[] buffer, IEventFrameExecution frame, IEventFrameExecution drivingFrame, long bufferCreateTime)
Standard constructor

Method Summary

protected String	getAdditionalToString() Delegate method for subclasses to provide additional toString information.
byte[]	getBuffer() Get the byte[] holding the state in wire form to transmit
long	getBufferCreateTime() The time taken to create the data buffer for the event
String	getTraceString() Provides a trace string the shows the byte level contents of the data buffer.

Methods inherited from class fulmine.event.AbstractEvent

clone, equals, getAddress, getDomain, getDrivingFrame, getFrame, getIdentity, getSource, getTriggerEvent, getType, hashCode, hideSourceFromToString, setAddress, setDrivingFrame, setFrame, setSource, setTriggerEvent, toDetailedString, toIdentityString, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface fulmine.event.IEvent

clone, getDrivingFrame, getFrame, getSource, getTriggerEvent, setTriggerEvent

Methods inherited from interface fulmine.IDescriptor

toDetailedString, toIdentityString

Methods inherited from interface fulmine.IAddressable

getAddress, getDomain, getIdentity, getType

Constructor Detail

TxEvent

public TxEvent(IEventSource source,
               byte[] buffer,
               IEventFrameExecution frame,
               IEventFrameExecution drivingFrame,
               long bufferCreateTime)

Standard constructor

Parameters:

source - the source for this event

buffer - the data buffer to transmit

frame - the frame that the data buffer was created in

drivingFrame - the driving frame of the frame

bufferCreateTime - the time taken to create the buffer itself

Method Detail

getBuffer

public byte[] getBuffer()

Get the byte[] holding the state in wire form to transmit

Returns:

a byte[]

getBufferCreateTime

public long getBufferCreateTime()

The time taken to create the data buffer for the event

Returns:

the time in nanoseconds to create the data buffer

getTraceString

public String getTraceString()

Provides a trace string the shows the byte level contents of the data buffer. Used for fine grain debugging.

Returns:

a trace string

getAdditionalToString

protected String getAdditionalToString()

Description copied from class: AbstractEvent

Delegate method for subclasses to provide additional toString information. This should be a comma separated string, e.g. "one, two, three"

Overrides:

getAdditionalToString in class AbstractEvent

Returns:

the additional toString information in comma separated format