com.hivemq.spi.services

Interface PublishService

public interface PublishService

This service allows plugins to publish new MQTT messages programmatically

Since:

1.5

Author:

Lukas Brandl

Method Summary

Methods

Modifier and Type	Method and Description
void	publish(PUBLISH publish) Publishes a new MQTT PUBLISH message.
void	publishtoClient(PUBLISH publish, String clientId) Publishes a new MQTT PUBLISH message.

Method Detail

publish

void publish(@NotNull
           PUBLISH publish)

Publishes a new MQTT PUBLISH message. The standard MQTT topic matching mechanism of HiveMQ will apply.

If the given PUBLISH or any of its information (topic,qos,message) is null, a NullPointerException will be thrown

Parameters:

publish - object with topic, QoS and message, which should be published to all subscribed clients

Throws:

NullPointerException - if the given object is null or any relevant information like topic, qos or message is null

publishtoClient

void publishtoClient(@NotNull
                   PUBLISH publish,
                   @NotNull
                   String clientId)

Publishes a new MQTT PUBLISH message. The PUBLISH will only be delivered to the client with the specified client identifier. Also the client needs to be subscribed on the topic of the PUBLISH in order to receive it.

If the given PUBLISH or any of its information (topic,qos,message) is null, a NullPointerException will be thrown

Parameters:

publish - object with topic, QoS and message, which should be published to all subscribed clients

Throws:

NullPointerException - if the given object is null or any relevant information like topic, qos or message is null