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.


Constructor Index

 o HeartbeatEvent()
Create a void HeartbeatEvent object to be deserialized
 o HeartbeatEvent(Stack, String, iBusURL, long)
Create a heartbeat event to be passed down the stack.

Method Index

 o getCreator()
Get the name of the layer that created the event.
 o getSeqNum()
return the sequence number of this heartbeat.
 o id()
Returns the identifier of this type of event.

Constructors

 o 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
 o HeartbeatEvent
 public HeartbeatEvent()
Create a void HeartbeatEvent object to be deserialized

Methods

 o 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
 o getCreator
 public String getCreator()
Get the name of the layer that created the event.

Returns:
the name of the layer that created the event
 o 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