Java RetainedMessage类代码示例

import com.hivemq.spi.message.RetainedMessage; //导入依赖的package包/类
@Override
public void onBrokerStart() throws BrokerUnableToStartException {

    log.info("Start callback message: {}", systemMessage.getMessage());

    //Sets a retained message on topic "testtopic" programatically by using HiveMQ's plugin services
    retainedMessageStore.addOrReplace(new RetainedMessage("testtopic", "testpayload".getBytes(), QoS.AT_LEAST_ONCE));
}
 

import com.hivemq.spi.message.RetainedMessage; //导入依赖的package包/类
@Override
public void execute() {
    /*
     * Careful: BlockingRetainedMessageStore.getRetainedMessages() returns all retained messages from all hivemq
     * cluster nodes (may block for a very long time and the result may use a lot of memory)
     */
    final Set<RetainedMessage> retainedMessages = retainedMessageStore.getRetainedMessages();
    for (final RetainedMessage retainedMessage : retainedMessages) {
        if (retainedMessage != null) {
            retainedMessageStore.remove(retainedMessage.getTopic());
        }
    }
    log.info("All retained messages have been cleared!");
}
 

import com.hivemq.spi.message.RetainedMessage; //导入依赖的package包/类
/**
 * @return a {@link com.google.common.util.concurrent.ListenableFuture} which contains all retained messages which are currently stored on this HiveMQ instance.
 */
ListenableFuture<Set<RetainedMessage>> getLocalRetainedMessages();
 

import com.hivemq.spi.message.RetainedMessage; //导入依赖的package包/类
/**
 * @return a {@link com.google.common.util.concurrent.ListenableFuture} which contains all retained messages which are currently stored
 */
ListenableFuture<Set<RetainedMessage>> getRetainedMessages();
 

import com.hivemq.spi.message.RetainedMessage; //导入依赖的package包/类
/**
 * @param topic a topic
 * @return a {@link com.google.common.util.concurrent.ListenableFuture} which contains the retained message for the specific topic or <code>null</code>.
 */
ListenableFuture<RetainedMessage> getRetainedMessage(String topic);
 

import com.hivemq.spi.message.RetainedMessage; //导入依赖的package包/类
/**
 * This method adds or replaces a retained message
 *
 * @param retainedMessage which should be added or replaced
 * @return a {@link com.google.common.util.concurrent.ListenableFuture} which returns after adding or replacing
 */
ListenableFuture<Void> addOrReplace(RetainedMessage retainedMessage);
 

import com.hivemq.spi.message.RetainedMessage; //导入依赖的package包/类
/**
 * @return all retained messages which are currently stored
 */
@Deprecated
Set<RetainedMessage> getRetainedMessages();
 

import com.hivemq.spi.message.RetainedMessage; //导入依赖的package包/类
/**
 * @param topic a topic
 * @return retained message for the specific topic, otherwise an {@link com.google.common.base.Optional}
 * instance with an empty reference
 * @deprecated Use RetainedMessageStoreLocal or RetainedMessageStoreCluster instead.
 */
@Deprecated
Optional<RetainedMessage> getRetainedMessage(String topic);
 

import com.hivemq.spi.message.RetainedMessage; //导入依赖的package包/类
/**
 * Removes a given retained message. <code>null</code> values are ignored.
 * If the given retained message doesn't exist, nothing will happen.
 *
 * @param retainedMessage which should be removed
 * @deprecated Use {@link BlockingRetainedMessageStore} or {@link AsyncRetainedMessageStore} instead.
 */
@Deprecated
void remove(RetainedMessage retainedMessage);
 

import com.hivemq.spi.message.RetainedMessage; //导入依赖的package包/类
/**
 * This method adds or replaces a retained message
 *
 * @param retainedMessage which should be added or replaced
 * @deprecated Use {@link BlockingRetainedMessageStore} or {@link AsyncRetainedMessageStore} instead.
 */
@Deprecated
void addOrReplace(RetainedMessage retainedMessage);
 

import com.hivemq.spi.message.RetainedMessage; //导入依赖的package包/类
/**
 * Checks if the retained message is present in the retained message store.
 * Only the topic is of a retained message is considered for this check, QoS and message are ignored.
 *
 * @param retainedMessage to check if it's already in the message store
 * @return true if there's already a message on the topic of the given retained message
 * @deprecated Use {@link BlockingRetainedMessageStore} or {@link AsyncRetainedMessageStore} instead.
 */
@Deprecated
boolean contains(RetainedMessage retainedMessage);
 

import com.hivemq.spi.message.RetainedMessage; //导入依赖的package包/类
/**
 * @return all retained messages which are currently stored on this HiveMQ instance.
 */
Set<RetainedMessage> getLocalRetainedMessages();
 

import com.hivemq.spi.message.RetainedMessage; //导入依赖的package包/类
/**
 * @return all retained messages which are currently stored
 */
Set<RetainedMessage> getRetainedMessages();
 

import com.hivemq.spi.message.RetainedMessage; //导入依赖的package包/类
/**
 * @param topic a topic
 * @return retained message for the specific topic or <code>null</code>.
 * instance with an empty reference
 */
@Nullable
RetainedMessage getRetainedMessage(String topic);
 

import com.hivemq.spi.message.RetainedMessage; //导入依赖的package包/类
/**
 * This method adds or replaces a retained message
 *
 * @param retainedMessage which should be added or replaced
 */
void addOrReplace(RetainedMessage retainedMessage);