java.lang.Object
- org.apache.qpid.jms.provider.discovery.multicast.MulticastDiscoveryAgent

All Implemented Interfaces:

Runnable, DiscoveryAgent
```
public class MulticastDiscoveryAgent
extends Object
implements DiscoveryAgent, Runnable
```
Discovery agent that listens on a multicast address for new Broker advisories.

Field Summary

Fields
Modifier and Type Field Description

static String DEFAULT_DISCOVERY_URI_STRING

static String DEFAULT_HOST_IP

static String DEFAULT_HOST_STR

static int DEFAULT_PORT

Constructor Summary

Constructors
Constructor Description

MulticastDiscoveryAgent(URI discoveryURI)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`close()`	Stops the agent after which no new remote peers will be found.
`DiscoveryListener`	`getDiscoveryListener()`
`URI`	`getDiscvoeryURI()`
`String`	`getGroup()`
`long`	`getKeepAliveInterval()`
`PacketParser`	`getParser()`
`String`	`getService()`	Returns the name of the service that is providing the discovery data for this agent such as ActiveMQ.
`int`	`getTimeToLive()`
`boolean`	`isLoopBackMode()`
`boolean`	`isSchedulerRequired()`	Indicates if this DiscoveryAgent requires a ScheduledExecutorService in order to perform its discovery work.
`void`	`resume()`	Resumes discovery by this agent if it was previously suspended.
`void`	`run()`
`void`	`setDiscoveryListener(DiscoveryListener listener)`	Sets the discovery listener
`void`	`setGroup(String group)`	Sets the multicast group this agent is assigned to.
`void`	`setInterface(String mcInterface)`
`void`	`setJoinNetworkInterface(String mcJoinNetwrokInterface)`
`void`	`setKeepAliveInterval(long keepAliveInterval)`
`void`	`setLoopBackMode(boolean loopBackMode)`
`void`	`setNetworkInterface(String mcNetworkInterface)`
`void`	`setParser(PacketParser parser)`	Sets the datagram packet parser used to read the discovery data broadcast by the service being monitored for remote peers.
`void`	`setScheduler(ScheduledExecutorService scheduler)`	Provider a ScheduledExecutorService to the DiscoveryAgent that requires a scheduler to perform its discovery work.
`void`	`setService(String name)`	Sets the name of the service that is providing the remote peer discovery data.
`void`	`setTimeToLive(int timeToLive)`
`void`	`start()`	Starts the agent after which new remote peers can start to be found.
`void`	`suspend()`	Suspends the Agent which suppresses any new attempts to discover remote peers until the agent is resumed.
`String`	`toString()`
`static void`	`trySetNetworkInterface(MulticastSocket mcastSock)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_DISCOVERY_URI_STRING
```
public static final String DEFAULT_DISCOVERY_URI_STRING
```
    See Also:
    
    Constant Field Values
  - DEFAULT_HOST_STR
```
public static final String DEFAULT_HOST_STR
```
    See Also:
    
    Constant Field Values
  - DEFAULT_HOST_IP
```
public static final String DEFAULT_HOST_IP
```
  - DEFAULT_PORT
```
public static final int DEFAULT_PORT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MulticastDiscoveryAgent
```
public MulticastDiscoveryAgent(URI discoveryURI)
```
- Method Detail
  - setDiscoveryListener
```
public void setDiscoveryListener(DiscoveryListener listener)
```
    Description copied from interface: DiscoveryAgent
    
    Sets the discovery listener
    
    Specified by:
    
    setDiscoveryListener in interface DiscoveryAgent
    
    Parameters:
    
    listener - the listener to notify on discovery events, or null to clear.
  - getDiscoveryListener
```
public DiscoveryListener getDiscoveryListener()
```
  - setScheduler
```
public void setScheduler(ScheduledExecutorService scheduler)
```
    Description copied from interface: DiscoveryAgent
    
    Provider a ScheduledExecutorService to the DiscoveryAgent that requires a scheduler to perform its discovery work. If the agent performs long polling style operations such as a socket read then it should not use the provided scheduler as that could block other agents from performing their own work.
    
    Specified by:
    
    setScheduler in interface DiscoveryAgent
    
    Parameters:
    
    scheduler - An initialized Scheduler service that this agent can use for its work.
  - isSchedulerRequired
```
public boolean isSchedulerRequired()
```
    Description copied from interface: DiscoveryAgent
    
    Indicates if this DiscoveryAgent requires a ScheduledExecutorService in order to perform its discovery work.
    
    Specified by:
    
    isSchedulerRequired in interface DiscoveryAgent
    
    Returns:
    
    true if the agent requires that its parent provide it with a scheduler.
  - start
```
public void start()
           throws ProviderException,
                  IllegalStateException
```
    Description copied from interface: DiscoveryAgent
    
    Starts the agent after which new remote peers can start to be found.
    
    Specified by:
    
    start in interface DiscoveryAgent
    
    Throws:
    
    ProviderException - if an IO error occurs while starting the agent.
    
    IllegalStateException - if the agent is not properly configured.
  - close
```
public void close()
```
    Description copied from interface: DiscoveryAgent
    
    Stops the agent after which no new remote peers will be found. This method should attempt to close any agent resources and if an error occurs it should handle it and not re-throw to the calling entity.
    
    Specified by:
    
    close in interface DiscoveryAgent
  - suspend
```
public void suspend()
```
    Description copied from interface: DiscoveryAgent
    
    Suspends the Agent which suppresses any new attempts to discover remote peers until the agent is resumed. If the service is not able to be suspended then this method should not throw an Exception, simply return as if successful.
    
    Specified by:
    
    suspend in interface DiscoveryAgent
  - resume
```
public void resume()
```
    Description copied from interface: DiscoveryAgent
    
    Resumes discovery by this agent if it was previously suspended. If the agent does not support being suspended or is closed this method should simply return without throwing any exceptions.
    
    Specified by:
    
    resume in interface DiscoveryAgent
  - run
```
public void run()
```
    Specified by:
    
    run in interface Runnable
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getDiscvoeryURI
```
public URI getDiscvoeryURI()
```
    Returns:
    
    the original URI used to create the Discovery Agent.
  - isLoopBackMode
```
public boolean isLoopBackMode()
```
    Returns:
    
    Returns the loopBackMode.
  - setLoopBackMode
```
public void setLoopBackMode(boolean loopBackMode)
```
    Parameters:
    
    loopBackMode - The loopBackMode to set.
  - getTimeToLive
```
public int getTimeToLive()
```
    Returns:
    
    Returns the timeToLive.
  - setTimeToLive
```
public void setTimeToLive(int timeToLive)
```
    Parameters:
    
    timeToLive - The timeToLive to set.
  - getKeepAliveInterval
```
public long getKeepAliveInterval()
```
  - setKeepAliveInterval
```
public void setKeepAliveInterval(long keepAliveInterval)
```
  - setInterface
```
public void setInterface(String mcInterface)
```
  - setNetworkInterface
```
public void setNetworkInterface(String mcNetworkInterface)
```
  - setJoinNetworkInterface
```
public void setJoinNetworkInterface(String mcJoinNetwrokInterface)
```
  - getGroup
```
public String getGroup()
```
    Returns:
    
    the multicast group this agent is assigned to.
  - setGroup
```
public void setGroup(String group)
```
    Sets the multicast group this agent is assigned to. The group can only be set prior to starting the agent, once started the group change will never take effect.
    
    Parameters:
    
    group - the multicast group the agent is assigned to.
  - getService
```
public String getService()
```
    Returns the name of the service that is providing the discovery data for this agent such as ActiveMQ.
    
    Returns:
    
    the name of the service that is advertising remote peer data.
  - setService
```
public void setService(String name)
```
    Sets the name of the service that is providing the remote peer discovery data.
    
    Parameters:
    
    name - the name of the service that provides this agent with remote peer data.
  - getParser
```
public PacketParser getParser()
```
    Returns:
    
    the currently configured datagram packet parser for this agent.
  - setParser
```
public void setParser(PacketParser parser)
```
    Sets the datagram packet parser used to read the discovery data broadcast by the service being monitored for remote peers.
    
    Parameters:
    
    parser - the datagram packet parser to use.
  - trySetNetworkInterface
```
public static void trySetNetworkInterface(MulticastSocket mcastSock)
                                   throws SocketException
```
    Throws:
    
    SocketException

Modifier and Type	Field	Description
`static String`	`DEFAULT_DISCOVERY_URI_STRING`
`static String`	`DEFAULT_HOST_IP`
`static String`	`DEFAULT_HOST_STR`
`static int`	`DEFAULT_PORT`

Class MulticastDiscoveryAgent

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_DISCOVERY_URI_STRING

DEFAULT_HOST_STR

DEFAULT_HOST_IP

DEFAULT_PORT

Constructor Detail

MulticastDiscoveryAgent

Method Detail

setDiscoveryListener

getDiscoveryListener

setScheduler

isSchedulerRequired

start

close

suspend

resume

run

toString

getDiscvoeryURI

isLoopBackMode

setLoopBackMode

getTimeToLive

setTimeToLive

getKeepAliveInterval

setKeepAliveInterval

setInterface

setNetworkInterface

setJoinNetworkInterface

getGroup

setGroup

getService

setService

getParser

setParser

trySetNetworkInterface