net.sf.appia.protocols.group.leave
Class LeaveEvent

java.lang.Object
  net.sf.appia.core.Event
      net.sf.appia.core.events.SendableEvent
          net.sf.appia.protocols.group.events.GroupSendableEvent
              net.sf.appia.protocols.group.leave.LeaveEvent

All Implemented Interfaces:

java.lang.Cloneable

public class LeaveEvent
extends GroupSendableEvent

Event to request that the member leaves the group.
When a member wishes to leave it should send a LeaveEvent downwards. See LeaveLayer for more details.
If the group is blocked there isn't any guarantee that a leave will succeed.

Version:

0.1

Author:

Alexandre Pinto

See Also:

LeaveLayer

Field Summary

Fields inherited from class net.sf.appia.protocols.group.events.GroupSendableEvent

group, orig, view_id

Fields inherited from class net.sf.appia.core.events.SendableEvent

dest, message, source

Fields inherited from class net.sf.appia.core.Event

DEFAULT_PRIORITY, MAX_PRIORITY, MIN_PRIORITY

Constructor Summary

LeaveEvent()
Constructs an uninitialized LeaveEvent.

LeaveEvent(Channel channel, int dir, Session source, Group group, ViewID view_id)
Constructs an initialized LeaveEvent.

Method Summary

Methods inherited from class net.sf.appia.protocols.group.events.GroupSendableEvent

setObjectsMessage

Methods inherited from class net.sf.appia.core.events.SendableEvent

cloneEvent, detachFromMemory, finalize, getMessage, setChannel, setMessage

Methods inherited from class net.sf.appia.core.Event

asyncGo, currentSession, debug, getChannel, getDir, getPriority, getSchedulerData, getSource, getSourceSession, go, init, isAccepted, popSession, setDir, setPriority, setSchedulerData, setSource, setSourceSession

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LeaveEvent

public LeaveEvent()

Constructs an uninitialized LeaveEvent.

LeaveEvent

public LeaveEvent(Channel channel,
                  int dir,
                  Session source,
                  Group group,
                  ViewID view_id)
           throws AppiaEventException

Constructs an initialized LeaveEvent.

Parameters:

channel - the Channel of the Event

dir - the Direction of the Event

source - the Session that is generating the Event

group - the Group of the Event

view_id - the ViewID of the Event

Throws:

AppiaEventException - as the result of calling SendableEvent(Channel,Direction,Session)