All Packages Class Hierarchy This Package Previous Next Index
Class iBus.HeartbeatEvent
java.lang.Object
|
+----iBus.Event
|
+----iBus.HeartbeatEvent
- public class HeartbeatEvent
- extends Event
A HeartbeatEvent contains heartbeat information such as the last sequence
number, a merge request, etc. Typically there is an iBus layer
in charge of producing a periodic hearbeat message and sending it down
the stack. Layers then stream their data on and off the heartbeat message.
-
HeartbeatEvent()
- Create a void HeartbeatEvent object to be deserialized
-
HeartbeatEvent(Stack, String, iBusURL, long)
- Create a heartbeat event to be passed down the stack.
-
getCreator()
- Get the name of the layer that created the event.
-
getSeqNum()
- return the sequence number of this heartbeat.
-
id()
- Returns the identifier of this type of event.
HeartbeatEvent
public HeartbeatEvent(Stack stack,
String creator,
iBusURL destination,
long seqNum)
- Create a heartbeat event to be passed down the stack.
- Parameters:
- stack - the creator stack
- creator - the name of the layer that created that event
- destination - the URL of the channel via which this event
was sent to
- seqNum - the sequence number of this heartbeat
HeartbeatEvent
public HeartbeatEvent()
- Create a void HeartbeatEvent object to be deserialized
id
public int id()
- Returns the identifier of this type of event.
- Returns:
- the identifier of this type of event
- Overrides:
- id in class Event
getCreator
public String getCreator()
- Get the name of the layer that created the event.
- Returns:
- the name of the layer that created the event
getSeqNum
public long getSeqNum()
- return the sequence number of this heartbeat.
- Returns:
- the sequence number of this heartbeat
All Packages Class Hierarchy This Package Previous Next Index