org.activemq.transport.multicast
Class MulticastDiscoveryAgent

java.lang.Object
  org.activemq.transport.DiscoveryAgentSupport
      org.activemq.transport.multicast.MulticastDiscoveryAgent

All Implemented Interfaces:

Runnable, PacketListener, Service, DiscoveryAgent

public class MulticastDiscoveryAgent
extends DiscoveryAgentSupport
implements PacketListener, Runnable

An agent used to discover other instances of a service

Version:

$Revision: 1.1.1.1 $

Field Summary

static String

DEFAULT_DISCOVERY_URI default URI used for discovery

Fields inherited from class org.activemq.transport.DiscoveryAgentSupport

listeners

Constructor Summary

MulticastDiscoveryAgent(String channelName)
Construct a discovery agent that uses multicast

MulticastDiscoveryAgent(URI uri)

Method Summary

void	consume(Packet packet) Consume multicast packets
String	getChannelName()
long	getKeepAliveTimeout()
String	getLocalId()
int	getServicesCount()
int	getTimeoutCount()
int	getTimeToLive()
URI	getUri()
void	registerService(String name, Map details) Register a service for other discover nodes
void	run() send a keep alive message
void	setChannelName(String channelName)
void	setKeepAliveTimeout(long keepAliveTimeout)
void	setLocalId(String localId)
void	setTimeoutCount(int timeoutCount)
void	setTimeToLive(int timeToLive)
void	setUri(URI uri)
void	start() start this discovery agent
void	stop() stop this discovery agent
String	toString()

Methods inherited from class org.activemq.transport.DiscoveryAgentSupport

addDiscoveryListener, fireAddService, fireRemoveService, removeDiscoveryListener

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DISCOVERY_URI

public static final String DEFAULT_DISCOVERY_URI

default URI used for discovery

See Also:

Constant Field Values

Constructor Detail

MulticastDiscoveryAgent

public MulticastDiscoveryAgent(String channelName)
                        throws JMSException

Construct a discovery agent that uses multicast

Parameters:

channelName -

Throws:

JMSException

MulticastDiscoveryAgent

public MulticastDiscoveryAgent(URI uri)

Method Detail

getKeepAliveTimeout

public long getKeepAliveTimeout()

Returns:

Returns the keepAliveTimeout.

setKeepAliveTimeout

public void setKeepAliveTimeout(long keepAliveTimeout)

Parameters:

keepAliveTimeout - The keepAliveTimeout to set.

getTimeoutCount

public int getTimeoutCount()

Returns:

Returns the timeoutCount.

setTimeoutCount

public void setTimeoutCount(int timeoutCount)

Parameters:

timeoutCount - The timeoutCount to set.

getLocalId

public String getLocalId()

Returns:

Returns the localId.

setLocalId

public void setLocalId(String localId)

Parameters:

localId - The localId to set.

getUri

public URI getUri()

Returns:

Returns the uri.

setUri

public void setUri(URI uri)

Parameters:

uri - The uri to set.

getTimeToLive

public int getTimeToLive()

Returns:

the timeToLive of multicast packets used for discovery

setTimeToLive

public void setTimeToLive(int timeToLive)
                   throws IOException

Parameters:

timeToLive - The timeToLive for multicast packets used in discovery.

Throws:

IOException

getChannelName

public String getChannelName()

Returns:

Returns the channelName.

setChannelName

public void setChannelName(String channelName)

Parameters:

channelName - The channelName to set.

toString

public String toString()

Overrides:

toString in class Object

Returns:

a pretty print of this instance

getServicesCount

public int getServicesCount()

Returns:

the number of active services, including self

registerService

public void registerService(String name,
                            Map details)
                     throws JMSException

Register a service for other discover nodes

Specified by:

registerService in interface DiscoveryAgent

Parameters:

name -

details -

Throws:

JMSException

start

public void start()
           throws JMSException

start this discovery agent

Specified by:

start in interface Service

Throws:

JMSException

stop

public void stop()
          throws JMSException

stop this discovery agent

Specified by:

stop in interface Service

Throws:

JMSException

run

public void run()

send a keep alive message

Specified by:

run in interface Runnable

consume

public void consume(Packet packet)

Consume multicast packets

Specified by:

consume in interface PacketListener

Parameters:

packet -