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

emq_

This commit is contained in:
Feng 2016-10-19 21:48:10 +08:00
parent 41b2643704
commit 726cd2f7f9
3 changed files with 41 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/source/design.rst
View File

@ -382,7 +382,7 @@ The callback function for a hook should return:
| {stop, NewAcc} | Return Acc and Break | | {stop, NewAcc} | Return Acc and Break |
+-----------------+------------------------+ +-----------------+------------------------+
The input arguments for a callback function are depending on the types of hook. Clone the `emqttd_plugin_template`_ project to check the argument in detail. The input arguments for a callback function are depending on the types of hook. Clone the `emq_plugin_template`_ project to check the argument in detail.
Hook Implementation Hook Implementation
------------------- -------------------
@ -425,11 +425,11 @@ And implemented in emqttd_hook module:
Hook Usage Hook Usage
---------- ----------
The `emqttd_plugin_template`_ project provides the examples for hook usage: The `emq_plugin_template`_ project provides the examples for hook usage:
.. code-block:: erlang .. code-block:: erlang
-module(emqttd_plugin_template). -module(emq_plugin_template).
-export([load/1, unload/0]). -export([load/1, unload/0]).
@ -498,7 +498,7 @@ http://github.com/emqtt/emqttd_plugin_template
.. _eSockd: https://github.com/emqtt/esockd .. _eSockd: https://github.com/emqtt/esockd
.. _Chain-of-responsibility_pattern: https://en.wikipedia.org/wiki/Chain-of-responsibility_pattern .. _Chain-of-responsibility_pattern: https://en.wikipedia.org/wiki/Chain-of-responsibility_pattern
.. _emqttd_plugin_template: https://github.com/emqtt/emqttd_plugin_template/blob/master/src/emqttd_plugin_template.erl .. _emq_plugin_template: https://github.com/emqtt/emq_plugin_template/blob/master/src/emq_plugin_template.erl
----------------- -----------------
Mnesia/ETS Tables Mnesia/ETS Tables

38
docs/source/getstarted.rst
View File

@ -151,41 +151,41 @@ Plugins
A plugin is an Erlang application to extend the *EMQ* broker. A plugin is an Erlang application to extend the *EMQ* broker.
+----------------------------+--------------------------------------------+ +-------------------------+--------------------------------------------+
| `emq_auth_clientid`_ | Authentication with ClientId | | `emq_auth_clientid`_ | Authentication with ClientId |
+----------------------------+--------------------------------------------+ +-------------------------+--------------------------------------------+
| `emq_auth_username`_ | Authentication with Username and Password | | `emq_auth_username`_ | Authentication with Username and Password |
+----------------------------+--------------------------------------------+ +-------------------------+--------------------------------------------+
| `emq_plugin_template`_ | Plugin template and demo | | `emq_plugin_template`_ | Plugin template and demo |
+----------------------------+--------------------------------------------+ +-------------------------+--------------------------------------------+
| `emq_dashboard`_ | Web Dashboard | | `emq_dashboard`_ | Web Dashboard |
+----------------------------+--------------------------------------------+ +-------------------------+--------------------------------------------+
| `emq_auth_ldap`_ | LDAP Auth Plugin | | `emq_auth_ldap`_ | LDAP Auth Plugin |
+----------------------------+--------------------------------------------+ +-------------------------+--------------------------------------------+
| `emq_auth_http`_ | Authentication/ACL with HTTP API | | `emq_auth_http`_ | Authentication/ACL with HTTP API |
+----------------------------+--------------------------------------------+ +-------------------------+--------------------------------------------+
| `emq_auth_mysql` _ | Authentication with MySQL | | `emq_auth_mysql` _ | Authentication with MySQL |
+----------------------------+--------------------------------------------+ +-------------------------+--------------------------------------------+
| `emq_auth_pgsql`_ | Authentication with PostgreSQL | | `emq_auth_pgsql`_ | Authentication with PostgreSQL |
+----------------------------+--------------------------------------------+ +-------------------------+--------------------------------------------+
| `emq_auth_redis`_ | Authentication with Redis | | `emq_auth_redis`_ | Authentication with Redis |
+----------------------------+--------------------------------------------+ +-------------------------+--------------------------------------------+
| `emq_mod_rewrite`_ | Topics rewrite like HTTP rewrite module | | `emq_mod_rewrite`_ | Topics rewrite like HTTP rewrite module |
+----------------------------+--------------------------------------------+ +-------------------------+--------------------------------------------+
| `emq_plugin_mongo`_ | Authentication with MongoDB | | `emq_mod_mongo`_ | Authentication with MongoDB |
+----------------------------+--------------------------------------------+ +-------------------------+--------------------------------------------+
| `emq_sn`_ | MQTT-SN Protocol Plugin | | `emq_sn`_ | MQTT-SN Protocol Plugin |
+----------------------------+--------------------------------------------+ +-------------------------+--------------------------------------------+
| `emq_coap`_ | CoAP Protocol Plugin | | `emq_coap`_ | CoAP Protocol Plugin |
+----------------------------+--------------------------------------------+ +-------------------------+--------------------------------------------+
| `emq_stomp`_ | STOMP Protocol Plugin | | `emq_stomp`_ | STOMP Protocol Plugin |
+----------------------------+--------------------------------------------+ +-------------------------+--------------------------------------------+
| `emq_sockjs`_ | SockJS(Stomp) Plugin | | `emq_sockjs`_ | SockJS(Stomp) Plugin |
+----------------------------+--------------------------------------------+ +-------------------------+--------------------------------------------+
| `emq_recon`_ | Recon Plugin | | `emq_recon`_ | Recon Plugin |
+----------------------------+--------------------------------------------+ +-------------------------+--------------------------------------------+
| `emq_reloader`_ | Reloader Plugin | | `emq_reloader`_ | Reloader Plugin |
+----------------------------+--------------------------------------------+ +-------------------------+--------------------------------------------+
A plugin could be enabled by 'bin/emqttd_ctl plugins load' command. A plugin could be enabled by 'bin/emqttd_ctl plugins load' command.

4
docs/source/plugins.rst
View File

@ -846,7 +846,7 @@ Create a Plugin Project
Clone emq_plugin_template source from github.com:: Clone emq_plugin_template source from github.com::
git clone https://github.com/emqtt/emqttd_plugin_template.git git clone https://github.com/emqtt/emq_plugin_template.git
Create a plugin project with erlang.mk and depends on 'emqttd' application, the 'Makefile':: Create a plugin project with erlang.mk and depends on 'emqttd' application, the 'Makefile'::
@ -861,7 +861,7 @@ Create a plugin project with erlang.mk and depends on 'emqttd' application, the
include erlang.mk include erlang.mk
Template Plugin: https://github.com/emqtt/emqttd_plugin_template Template Plugin: https://github.com/emqtt/emq_plugin_template
Register Auth/ACL Modules Register Auth/ACL Modules
------------------------- -------------------------