hcq/MaxScale
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Rename domain to module

Browse Source 
The module commands now use the module name as the replacement for
domain. The domain itself wasn't any better when compared to the module
name.
This commit is contained in:
Markus Mäkelä
2017-01-27 16:34:06 +02:00
parent 5972d87fba
commit 7dc5698c90
4 changed files with 15 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
Documentation/Reference/Module-Commands.md
View File

@ -6,9 +6,9 @@ module API. Currently, only MaxAdmin implements an interface to the module
commands.
All registered module commands can be shown with `maxadmin list commands` and
they can be executed with `maxadmin call command <domain> <name> ARGS...` where
_<domain>_ is the domain where the module registered the command and _<name>_
is the name of the command. _ARGS_ is a function specific list of arguments.
they can be executed with `maxadmin call command <module> <name> ARGS...` where
_<module>_ is the name of the module and _<name>_ is the name of the
command. _ARGS_ is a command specific list of arguments.
## Developer reference
@ -16,9 +16,7 @@ The module command API is defined in the _modulecmd.h_ header. It consists of
various functions to register and call module commands. Read the function
documentation in the header for more details.
**Note:** The domain should match the name of the module.
The following example registers the module command _my_command_ in the _my_module_ domain.
The following example registers the module command _my_command_ for module _my_module_.
```
#include <maxscale/modulecmd.h>