std::string ALModule::getBrokerName()
Gets the name of the parent broker
- Returns: The name of the parent broker
std::vector<std::string> ALModule::getMethodList()
Retrieves the module’s method list
- Returns: A vector of method names
AL::ALValue ALModule::getMethodHelp(const std::string&
methodName)
Retrieves a method’s description
- Parameters: methodName – The name of the method
- Returns: A structure containing the method’s description
[
std::string methodName,
[ parameter, ...],
std::string returnName,
std::string returnDescription
]
Where parameter is
[
std::string parameterName,
std::string parameterDescription
]
AL::ALValue ALModule::getModuleHelp()
Retrieves a structure containing the module’s description:
- Returns: A structure describing the module
[
std::string moduleDescription,
[ moduleExample, ...]
]
Where moduleExample is
[
std::string language,
std::string example
]
std::string ALModule::getUsage(const std::string&
methodName)
Gets the method usage string. This summarizes how to use the method.
- Parameters: methodName – The name of the method
- Returns: A string that summarizes the usage of the method
bool ALModule::ping()
Just a ping to test connectivity. Always returns true
- Returns: returns true
std::string ALModule::version()
Returns the version of the module
- Returns: The version as a string