Appia Documentation

net.sf.appia.protocols.udpsimple
Class MulticastInitEvent

java.lang.Object
  extended by net.sf.appia.core.Event
      extended by net.sf.appia.protocols.udpsimple.MulticastInitEvent

public class MulticastInitEvent
extends Event

MulticastInitEvent is the event that must be received by UdpCompleteSession in order to initializa multicast communication. It notifies the UdpCompleteSession of the multicast address to be used and also specifies if local multicast messages are supposed to be forwarded.

Author:
M.Joao Monteiro
See Also:
Event, UdpSimpleSession

Field Summary
 boolean error
          Indicator of error condition.
 boolean fullDuplex
          Indicates whether local multicast messages are supposed to be forwarded.
 java.net.SocketAddress ipMulticast
          The IP multicast address of the group.
 
Fields inherited from class net.sf.appia.core.Event
DEFAULT_PRIORITY, MAX_PRIORITY, MIN_PRIORITY
 
Constructor Summary
MulticastInitEvent(java.net.SocketAddress ipMulticast, boolean fullDuplex, Channel channel, int dir, Session source)
          Creates an initialized MulticastInitEvent.
 
Method Summary
 
Methods inherited from class net.sf.appia.core.Event
asyncGo, cloneEvent, currentSession, debug, getChannel, getDir, getPriority, getSchedulerData, getSource, getSourceSession, go, init, isAccepted, popSession, setChannel, setDir, setPriority, setSchedulerData, setSource, setSourceSession
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ipMulticast

public java.net.SocketAddress ipMulticast
The IP multicast address of the group.


fullDuplex

public boolean fullDuplex
Indicates whether local multicast messages are supposed to be forwarded. (False means that local multicast messages are discarded in UdpCompleteSession.) (True makes UdpCompleteSession forward every messages without distinction.)


error

public boolean error
Indicator of error condition.

Constructor Detail

MulticastInitEvent

public MulticastInitEvent(java.net.SocketAddress ipMulticast,
                          boolean fullDuplex,
                          Channel channel,
                          int dir,
                          Session source)
                   throws AppiaEventException,
                          java.lang.NullPointerException
Creates an initialized MulticastInitEvent.

Parameters:
ipMulticast - the IP multicast address
fullDuplex - indicates whether local multicast messages are supposed to be forwarded
channel - the Channel of the Event
dir - the Direction of the Event
source - the Session that is generating the Event
Throws:
AppiaEventException - as the result of calling
java.lang.NullPointerException

Appia Documentation

COPYRIGHT 2006-2009, University of Lisbon and INESC-ID
For updates and related information please see Appia Home Page
Send questions, sugestions or remarks to the appia-users mailing list