jadex.micro.examples.messagequeue.replicated

Class ReplicatedMessageQueueAgent

java.lang.Object

jadex.micro.examples.messagequeue.replicated.ReplicatedMessageQueueAgent

All Implemented Interfaces:

IMessageQueueService, IMessageQueueReplicableService, IMessageQueueReplicationService

public class ReplicatedMessageQueueAgent
extends Object
implements IMessageQueueReplicableService, IMessageQueueReplicationService

This agent represents a part of a distributed, replicable message queue. It offers a message queue service that is used by the local clients. Also it offers and uses a remote message queue service where other remote services can subscribe to receive and distribute messages from local clients.

Constructor Summary

Constructors

Constructor and Description
ReplicatedMessageQueueAgent()

Method Summary

Methods

Modifier and Type	Method and Description
void	agentBody()
void	agentCreated() Called on agent creation.
String	getId() Returns the services unique Id.
IFuture<Void>	publish(String topic, Event event) Publish a new event to the queue.
IFuture<Void>	publish(String topic, Event event, Boolean replicate) Publish a new event to the queue.
ISubscriptionIntermediateFuture<Event>	subscribe(String topic) Subscribe to a specific topic.
ISubscriptionIntermediateFuture<Event>	subscribeForReplication(String topic) Subscribe to a specific topic.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReplicatedMessageQueueAgent

public ReplicatedMessageQueueAgent()

Method Detail

agentCreated

public void agentCreated()

Called on agent creation.

agentBody

public void agentBody()

subscribeForReplication

public ISubscriptionIntermediateFuture<Event> subscribeForReplication(String topic)

Subscribe to a specific topic. New events that fit to the topic are forwarded to all replication subscribers as intermediate results. A subscribe can unsubscribe by terminating the future.

Specified by:

subscribeForReplication in interface IMessageQueueReplicationService

Parameters:

topic - The topic.

Returns:

The events.

subscribe

public ISubscriptionIntermediateFuture<Event> subscribe(String topic)

Subscribe to a specific topic. New events that fit to the topic are forwarded to all subscribers as intermediate results. A subscribe can unsubscribe by terminating the future. Every time when someone subscribe for local messages the server also subscribe for the given topic by all the other remote services.

Specified by:

subscribe in interface IMessageQueueService

Parameters:

topic - The topic.

Returns:

The events.

publish

public IFuture<Void> publish(String topic,
                    Event event,
                    Boolean replicate)

Publish a new event to the queue.

Specified by:

publish in interface IMessageQueueReplicableService

Parameters:

topic - The topic.

event - The event to publish.

replicate - Should the event be replicated among all message queues?

publish

public IFuture<Void> publish(String topic,
                    Event event)

Publish a new event to the queue.

Specified by:

publish in interface IMessageQueueService

Parameters:

topic - The topic.

event - The event to publish.

getId

public String getId()

Returns the services unique Id.

Specified by:

getId in interface IMessageQueueReplicationService

Returns:

the service Id.