com.hivemq.spi.callback.events

Interface OnPublishReceivedCallback

All Superinterfaces:

Callback, SynchronousCallback

public interface OnPublishReceivedCallback
extends SynchronousCallback

Gets called when a PUBLISH MQTT message arrives.

This callback gets called very often, so make sure you are NOT blocking and you are using proper caching

When throwing a OnPublishReceivedException it's possible to optionally disconnect the publishing client.

This callback is not meant to implement authorization (= Topic Restrictions). You should use the OnAuthorizationCallback for that purpose as this offers more fine grained actions and extension points.

Since:

1.4

Author:

Dominik Obermaier

Method Summary

Methods

Modifier and Type	Method and Description
void	onPublishReceived(PUBLISH publish, ClientData clientData) Called when a PUBLISH MQTT message arrives The publish parameter references the publish object, that is sent to the subscribers, after the onPublishReceived method was called.

Methods inherited from interface com.hivemq.spi.callback.SynchronousCallback

priority

Method Detail

onPublishReceived

void onPublishReceived(PUBLISH publish,
                     ClientData clientData)
                       throws OnPublishReceivedException

Called when a PUBLISH MQTT message arrives

The publish parameter references the publish object, that is sent to the subscribers, after the onPublishReceived method was called. So if you don´t want your plugin to interfere in the regular publishing process, you must copy the PUBLISH object. Use the static copy method of the PUBLISH class for this purpose. Similar to the following code example. PUBLISH copy = PUBLISH.copy(publish);

Parameters:

publish - the PUBLISH message which was sent

clientData - the information of the publishing client

Throws:

OnPublishReceivedException - when the PUBLISH was invalid.