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:
-
evAck
-
-
evError
-
-
evHeartbeat
-
-
evLostMessage
-
-
evMessage
-
-
evProblem
- Event descriptors:
-
evRetransmit
-
-
evRetransmitReq
-
-
evView
-
-
Event()
- Initialize Event object to be passed up the stack.
-
Event(Stack, iBusURL)
- Initialize Event object to be passed down the stack.
-
getDestination()
- Return the URL of the destination of the event.
-
getParam()
- Return the parameter assigned to this event.
-
getSender()
- Return the URL of the sender of the event.
-
getStack()
- Return the stack that created that event.
-
id()
- Returns the identifier of this type of event.
-
setDestination(iBusURL)
- set the URL of the destination.
-
setParam(Object)
- Assign a parameter to this event.
-
setSender(iBusURL)
- set the URL of the sender.
-
setStack(Stack)
- Set the stack that created the event.
evProblem
public static final transient int evProblem
- Event descriptors:
evMessage
public static final transient int evMessage
evError
public static final transient int evError
evHeartbeat
public static final transient int evHeartbeat
evRetransmitReq
public static final transient int evRetransmitReq
evRetransmit
public static final transient int evRetransmit
evLostMessage
public static final transient int evLostMessage
evView
public static final transient int evView
evAck
public static final transient int evAck
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
Event
public Event()
- Initialize Event object to be passed up the stack.
id
public abstract int id()
- Returns the identifier of this type of event.
- Returns:
- the identifier of this type of event
getStack
public Stack getStack()
- Return the stack that created that event.
- Returns:
- the stack that created that event
setStack
protected void setStack(Stack stack)
- Set the stack that created the event.
- Parameters:
- stack - the stack that created the event
getDestination
public iBusURL getDestination()
- Return the URL of the destination of the event.
- Returns:
- the URL of the destination of the event
setDestination
protected void setDestination(iBusURL destination)
- set the URL of the destination.
- Parameters:
- destination - the URL of the destination
getSender
public iBusURL getSender()
- Return the URL of the sender of the event.
- Returns:
- the URL of the sender of the event
setSender
protected void setSender(iBusURL sender)
- set the URL of the sender.
- Parameters:
- sender - the URL of the sender
setParam
public void setParam(Object param)
- Assign a parameter to this event.
- Parameters:
- param - the parameter to piggyback onto this event.
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