All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class iBus.Event

java.lang.Object
   |
   +----iBus.Event

public abstract class Event
extends Object
implements Serializable
Event is the base class of all event objects that can be passed along to ProtocolObject.upHandleEvent:


Variable Index

 o evAck
 o evError
 o evHeartbeat
 o evLostMessage
 o evMessage
 o evProblem
Event descriptors:
 o evRetransmit
 o evRetransmitReq
 o evView

Constructor Index

 o Event()
Initialize Event object to be passed up the stack.
 o Event(Stack, iBusURL)
Initialize Event object to be passed down the stack.

Method Index

 o getDestination()
Return the URL of the destination of the event.
 o getParam()
Return the parameter assigned to this event.
 o getSender()
Return the URL of the sender of the event.
 o getStack()
Return the stack that created that event.
 o id()
Returns the identifier of this type of event.
 o setDestination(iBusURL)
set the URL of the destination.
 o setParam(Object)
Assign a parameter to this event.
 o setSender(iBusURL)
set the URL of the sender.
 o setStack(Stack)
Set the stack that created the event.

Variables

 o evProblem
 public static final transient int evProblem
Event descriptors:

 o evMessage
 public static final transient int evMessage
 o evError
 public static final transient int evError
 o evHeartbeat
 public static final transient int evHeartbeat
 o evRetransmitReq
 public static final transient int evRetransmitReq
 o evRetransmit
 public static final transient int evRetransmit
 o evLostMessage
 public static final transient int evLostMessage
 o evView
 public static final transient int evView
 o evAck
 public static final transient int evAck

Constructors

 o Event
 public Event(Stack stack,
              iBusURL destination)
Initialize Event object to be passed down the stack.

Parameters:
stack - the creator stack
destination - the destination URL of the event
 o Event
 public Event()
Initialize Event object to be passed up the stack.

Methods

 o id
 public abstract int id()
Returns the identifier of this type of event.

Returns:
the identifier of this type of event
 o getStack
 public Stack getStack()
Return the stack that created that event.

Returns:
the stack that created that event
 o setStack
 protected void setStack(Stack stack)
Set the stack that created the event.

Parameters:
stack - the stack that created the event
 o getDestination
 public iBusURL getDestination()
Return the URL of the destination of the event.

Returns:
the URL of the destination of the event
 o setDestination
 protected void setDestination(iBusURL destination)
set the URL of the destination.

Parameters:
destination - the URL of the destination
 o getSender
 public iBusURL getSender()
Return the URL of the sender of the event.

Returns:
the URL of the sender of the event
 o setSender
 protected void setSender(iBusURL sender)
set the URL of the sender.

Parameters:
sender - the URL of the sender
 o setParam
 public void setParam(Object param)
Assign a parameter to this event.

Parameters:
param - the parameter to piggyback onto this event.
 o getParam
 public Object getParam()
Return the parameter assigned to this event.

Returns:
the parameter assigned to this event

All Packages  Class Hierarchy  This Package  Previous  Next  Index