csbase.util.messages

Class MessageStore

java.lang.Object

csbase.util.messages.MessageStore

All Implemented Interfaces:

Serializable

public class MessageStore
extends Object
implements Serializable

Responsável pelo armazenamento das mensagens. Também mantém a informação de quais mensagens foram recebidas por quais consumidores. O MessageStore permite consumir as mensagens de duas maneiras:

• Assíncrona - chamando o método peek(Serializable, IFilter) seguido do Entry#setAcknowledgedBy(Serializable) para marcar cada mensagem como recebida
• Síncrona - através do método receive(Serializable, IFilter) que já marca as mensagens como recebidas antes de devolvê-las.

Para garantir que todas as mensagens tenham chance de serem consumidas, independente de seu tempo de vida, assim que esse termina elas são postas em estado de expirando, ao invés de expirarem imediatamente. Esse estado dura receiveTimeoutms. Os consumidores que estavam ativos no momento em que elas entraram neste estado podem consumi-las, se já não as consumiram, antes que elas expirem. Para evitar que clientes que caíram e voltaram com outro identificador de consumidor recebam uma mensagem duplicada, assim que uma mensagem é marcada como recebida, ela entra em estado de expirando e fica salvo quais consumidores estavam ativos no momento em que ela trocou de estado. a partir daí, apenas esses poderam consumi-la antes que ela entre em estado de expirada. Assim, se um consumidor recebeu aquela mensagem, perdeu a conexão, voltou e obteve um novo identificador de consumidor, ele não tem mais acesso aquela mensagem por que aquele identificador não estava ativo no primeiro momento em que ela foi marcada como recebida. Sempre que chamar um dos métodos para se obter as mensagens, receive(Serializable, IFilter) ou peek(Serializable, IFilter), o consumidor será marcado como ativo e assim permanecerá por receiveTimeoutms. Sendo assim, para ele se manter ativo, basta que faça chamadas consecutivas a esses métodos com um intervalo de tempo menor ou igual a receiveTimeout.

Author:

Tecgraf/PUC-Rio

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	MAX_RECEIVE_TIMEOUT Tempo máximo que um consumidor tem entre cada chamada ao método receive(Serializable, IFilter) ou peek(Serializable, IFilter) para ser considerado ativo.
static long	MIN_RECEIVE_TIMEOUT Tempo mínimo que um consumidor tem entre cada chamada ao método receive(Serializable, IFilter) ou peek(Serializable, IFilter) para ser considerado ativo.

Constructor Summary

Constructors

Constructor and Description
MessageStore(String name, long receiveTimeout) Construtor.

Method Summary

Modifier and Type	Method and Description
csbase.util.messages.MessageStore.Entry	getEntry(UUID messageId) Obtém a entrada que encapsula uma determinada mensagem.
String	getName() Obtém o nome deste tópico.
Message[]	peek(Serializable consumerId, tecgraf.javautils.core.filter.IFilter<Message> filter) Obtém mensagens que ainda não expiradas e não recebidas por um determinado consumidor.
csbase.util.messages.MessageStore.Entry	publish(Message message, long timeToLive) Adiciona uma nova mensagem a esta estrutura.
Message[]	receive(Serializable consumerId, tecgraf.javautils.core.filter.IFilter<Message> filter) Obtém mensagens que ainda não expiradas e não recebidas por um determinado consumidor.
void	setReceiveTimeout(long timeout) Atribui atraso na coleta de mensagens expiradas.

Methods inherited from class java.lang.Object

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

Field Detail

MIN_RECEIVE_TIMEOUT

public static final long MIN_RECEIVE_TIMEOUT

Tempo mínimo que um consumidor tem entre cada chamada ao método receive(Serializable, IFilter) ou peek(Serializable, IFilter) para ser considerado ativo.

See Also:

receiveTimeout

MAX_RECEIVE_TIMEOUT

public static final long MAX_RECEIVE_TIMEOUT

Tempo máximo que um consumidor tem entre cada chamada ao método receive(Serializable, IFilter) ou peek(Serializable, IFilter) para ser considerado ativo.

See Also:

receiveTimeout

Constructor Detail

MessageStore

public MessageStore(String name,
                    long receiveTimeout)

Construtor.

Parameters:

name - Nome deste tópico.

receiveTimeout - Tempo máximo, em milisegundos, que um consumidor tem entre cada chamada ao método receive(Serializable, IFilter) ou peek(Serializable, IFilter) para ser considerado ativo. O valor mínimo para este parâmetro é MIN_RECEIVE_TIMEOUT.

Method Detail

getName

public String getName()

Obtém o nome deste tópico.

Returns:

o nome deste tópico.

setReceiveTimeout

public void setReceiveTimeout(long timeout)

Atribui atraso na coleta de mensagens expiradas.

Parameters:

timeout - Tempo máximo, em milisegundos, que um consumidor tem entre cada chamada ao método receive(Serializable, IFilter) ou peek(Serializable, IFilter) para ser considerado ativo. O valor mínimo para este parâmetro é MIN_RECEIVE_TIMEOUT. O valor máximo para este parâmetro é MAX_RECEIVE_TIMEOUT.

publish

public csbase.util.messages.MessageStore.Entry publish(Message message,
                                                       long timeToLive)

Adiciona uma nova mensagem a esta estrutura.

Parameters:

message - mensagem a ser adicionada.

timeToLive - tempo de vida da mensagem em milisegundos.

Returns:

Entrada representando a mensagem publicada.

receive

public Message[] receive(Serializable consumerId,
                         tecgraf.javautils.core.filter.IFilter<Message> filter)

Obtém mensagens que ainda não expiradas e não recebidas por um determinado consumidor. Essas mensagens serão marcadas como lidas.

Parameters:

consumerId - Identificador do consumidor.

filter - filtro utilizado para obter as mensagens que se tem interesse.

Returns:

Mensagens que ainda não expiradas e não recebidas por um determinado consumidor.

peek

public Message[] peek(Serializable consumerId,
                      tecgraf.javautils.core.filter.IFilter<Message> filter)

Obtém mensagens que ainda não expiradas e não recebidas por um determinado consumidor. Essas mensagens não serão marcadas como lidas.

Parameters:

consumerId - Identificador do consumidor.

filter - filtro utilizado para obter as mensagens que se tem interesse.

Returns:

Mensagens que ainda não expiradas e não recebidas por um determinado consumidor.

getEntry

public csbase.util.messages.MessageStore.Entry getEntry(UUID messageId)

Obtém a entrada que encapsula uma determinada mensagem.

Parameters:

messageId - Identificador único da mensagem.

Returns:

a entrada que encapsula uma determinada mensagem.