yuanbiao
/
emqx
1
0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

hooks

This commit is contained in:
Feng 2016-09-09 23:17:49 +08:00
parent 82b31b630e
commit 983f93d639
2 changed files with 32 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/source/design.rst
View File

@ -337,10 +337,12 @@ Hooks defined by the emqttd 1.0 broker:
+------------------------+------------------------------------------------------+ +------------------------+------------------------------------------------------+
| client.subscribe | Run before client subscribes topics | | client.subscribe | Run before client subscribes topics |
+------------------------+------------------------------------------------------+ +------------------------+------------------------------------------------------+
| client.subscribe.after | Run After client subscribed topics |
+------------------------+------------------------------------------------------+
| client.unsubscribe | Run when client unsubscribes topics | | client.unsubscribe | Run when client unsubscribes topics |
+------------------------+------------------------------------------------------+ +------------------------+------------------------------------------------------+
| session.subscribed | Run After client(session) subscribed a topic |
+------------------------+------------------------------------------------------+
| session.unsubscribed | Run After client(session) unsubscribed a topic |
+------------------------+------------------------------------------------------+
| message.publish | Run when a MQTT message is published | | message.publish | Run when a MQTT message is published |
+------------------------+------------------------------------------------------+ +------------------------+------------------------------------------------------+
| message.delivered | Run when a MQTT message is delivered | | message.delivered | Run when a MQTT message is delivered |

54
docs/source/plugins.rst
View File

@ -812,26 +812,28 @@ Register Callbacks for Hooks
The plugin could register callbacks for hooks. The hooks will be run by the broker when a client connected/disconnected, a topic subscribed/unsubscribed or a message published/delivered: The plugin could register callbacks for hooks. The hooks will be run by the broker when a client connected/disconnected, a topic subscribed/unsubscribed or a message published/delivered:
+------------------------+---------------------------------------+ +------------------------+-----------------------------------------+
| Name | Description | | Name | Description |
+------------------------+---------------------------------------+ +------------------------+-----------------------------------------+
| client.connected | Run when a client connected to the | | client.connected | Run when a client connected to the |
| | broker successfully | | | broker successfully |
+------------------------+---------------------------------------+ +------------------------+-----------------------------------------+
| client.subscribe | Run before a client subscribes topics | | client.subscribe | Run before a client subscribes topics |
+------------------------+---------------------------------------+ +------------------------+-----------------------------------------+
| client.subscribe.after | Run after a client subscribed topics | | session.subscribed | Run after a client subscribed a topic |
+------------------------+---------------------------------------+ +------------------------+-----------------------------------------+
| client.unsubscribe | Run when a client unsubscribes topics | | client.unsubscribe | Run when a client unsubscribes topics |
+------------------------+---------------------------------------+ +------------------------+-----------------------------------------+
| message.publish | Run when a message is published | | session.unsubscribed | Run after a client unsubscribed a topic |
+------------------------+---------------------------------------+ +------------------------+-----------------------------------------+
| message.delivered | Run when a message is delivered | | message.publish | Run when a message is published |
+------------------------+---------------------------------------+ +------------------------+-----------------------------------------+
| message.acked | Run when a message(qos1/2) is acked | | message.delivered | Run when a message is delivered |
+------------------------+---------------------------------------+ +------------------------+-----------------------------------------+
| client.disconnected | Run when a client is disconnnected | | message.acked | Run when a message(qos1/2) is acked |
+------------------------+---------------------------------------+ +------------------------+-----------------------------------------+
| client.disconnected | Run when a client is disconnnected |
+------------------------+-----------------------------------------+
emqttd_plugin_template.erl for example: emqttd_plugin_template.erl for example:
@ -841,13 +843,13 @@ emqttd_plugin_template.erl for example:
load(Env) -> load(Env) ->
emqttd:hook('client.connected', fun ?MODULE:on_client_connected/3, [Env]), emqttd:hook('client.connected', fun ?MODULE:on_client_connected/3, [Env]),
emqttd:hook('client.disconnected', fun ?MODULE:on_client_disconnected/3, [Env]), emqttd:hook('client.disconnected', fun ?MODULE:on_client_disconnected/3, [Env]),
emqttd:hook('client.subscribe', fun ?MODULE:on_client_subscribe/3, [Env]), emqttd:hook('client.subscribe', fun ?MODULE:on_client_subscribe/4, [Env]),
emqttd:hook('client.subscribe.after', fun ?MODULE:on_client_subscribe_after/3, [Env]), emqttd:hook('session.subscribed', fun ?MODULE:on_session_subscribed/4, [Env]),
emqttd:hook('client.unsubscribe', fun ?MODULE:on_client_unsubscribe/3, [Env]), emqttd:hook('client.unsubscribe', fun ?MODULE:on_client_unsubscribe/4, [Env]),
emqttd:hook('session.unsubscribed', fun ?MODULE:on_session_unsubscribed/4, [Env]),
emqttd:hook('message.publish', fun ?MODULE:on_message_publish/2, [Env]), emqttd:hook('message.publish', fun ?MODULE:on_message_publish/2, [Env]),
emqttd:hook('message.delivered', fun ?MODULE:on_message_delivered/3, [Env]), emqttd:hook('message.delivered', fun ?MODULE:on_message_delivered/4, [Env]),
emqttd:hook('message.acked', fun ?MODULE:on_message_acked/3, [Env]). emqttd:hook('message.acked', fun ?MODULE:on_message_acked/4, [Env]).
Register CLI Modules Register CLI Modules
-------------------- --------------------