[SR-Users] Kamailio KEMI Framework Tutorial

[Daniel-Constantin Mierla]

Likely you spotted it, but for sake of completion and highlighting to
everyone, the rpc commands to list the kemi functions are listed with
kamctl usage example at the end of the section on the web at:


  - http://127.0.0.1:8000/kemi/#kemi-functions


Cheers,
Daniel


On 21.11.17 15:20, Daniel-Constantin Mierla wrote:
>
> Hello,
>
>
> On 21.11.17 10:20, Samuel F. wrote:
>>
>> Hi Daniel,
>>
>>
>> First, I'd just like to say thanks and let you know we are very
>> grateful for the KEMI framework. We have developed three
>> small applications running on python KEMI in production serving calls
>> every day successfully without any issues at all. The development
>> process was very smooth and quick.
>>
>
> thanks for the feedback, really appreciated! It is good to know that
> KEMI is being used in production and also it shows its potential for
> various needs.
>
>>
>> I reviewed the documentation and think it's great that the KEMI
>> framework gets an extensive documentation.
>>
>>
>> One thought I had regarding documenting the exported functions is
>> that I think it's good if they are exported to the docs automatically
>> from the source code. My opinion is that it is better to have
>> documentation that reflects the current state of the source code
>> rather than having stale/out-of-date documentation.
>>
>>
>> Perhaps having a parser that locates all the exported functions,
>> lists them in appropriate modules with the return value and then a
>> link to the actual modules documentation?
>>
>
> There is an RPC command that lists the exported KEMI functions for a
> running Kamailio. It reflects exactly what functions are available
> from the kemi framework internal structure. This is like an auto
> discovery, it is done automatically.
>
> Addition docs can be added in the code using doxygen, however, while
> that is good for short descriptions, I don't find it good to add
> extensive docs and especially usage examples in the code. Also, from
> past experiences, non-developer users tend not to look at the code,
> therefore the improvements to docs in code from general users are very
> low.
>
> Anyhow, this tutorial was started with the initial goal of covering
> the KEMI framework in general, and the special functions. For the
> functions exported by modules I added only the acc as an example
> (which is also a skeleton at this moment).
>
> As I said, I am open for suggestions on how to do the docs for kemi
> functions from modules. Your proposal with using somehow the code is
> not like being dismissed, I just expressed my opinions based.
> Contributions to parse the code and extract prototypes are of course
> welcome.
>
> Cheers,
> Daniel
>
>
>>
>> // Samuel
>>
>> ------------------------------------------------------------------------
>> *From:* sr-users <sr-users-bounces at lists.kamailio.org> on behalf of
>> Daniel-Constantin Mierla <miconda at gmail.com>
>> *Sent:* Monday, November 20, 2017 4:11:54 PM
>> *To:* Kamailio (SER) - Users Mailing List; Kamailio (SER) - Devel
>> Mailing List
>> *Subject:* [SR-Users] Kamailio KEMI Framework Tutorial
>>  
>> Hello,
>>
>> I started a tutorial for Kamailio KEMI Framework written in markdown
>> format targeting use of mkdocs. It is published on github as part of
>> kamailio-docs repository:
>>
>>   *
>> https://nam02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fkamailio%2Fkamailio-docs%2Ftree%2Fmaster%2Fkamailio-kemi-framework&data=02%7C01%7Csamuel_is_kewl%40hotmail.com%7C226fe2242ed4436c13fa08d53029444d%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636467876150276887&sdata=MuTy1ZgjcDEbQdHTGA2LpO1sKUDAxxo%2BupwGr%2BBspCE%3D&reserved=0
>>
>> The mkdocs build (to browse and read) is online at:
>>
>>   *
>> https://nam02.safelinks.protection.outlook.com/?url=http%3A%2F%2Fkamailio.org%2Fdocs%2Ftutorials%2Fdevel%2Fkamailio-kemi-framework%2F&data=02%7C01%7Csamuel_is_kewl%40hotmail.com%7C226fe2242ed4436c13fa08d53029444d%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636467876150276887&sdata=FHJ1zANtLQI6o2%2F1wFPFYfu1B94JlQ%2FHTLDbaVp7dUg%3D&reserved=0
>>
>> It is work in progress and contributions from the community are more
>> than welcome -- doing push requests on github project is the recommended
>> way for contributions:
>>
>>   *
>> https://nam02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fkamailio%2Fkamailio-docs%2F&data=02%7C01%7Csamuel_is_kewl%40hotmail.com%7C226fe2242ed4436c13fa08d53029444d%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636467876150276887&sdata=utRI9tOvpEuyBWFU70KaBaod6URNk0ju4rTSQl%2FhO3I%3D&reserved=0
>>
>> The main goal is document the role of KEMI, its benefits and how it can
>> be used. It addition it should cover the list of functions exported to
>> KEMI by core as well as special KEMI functions.
>>
>> Regarding the functions exported by kamailio modules to KEMI I added as
>> an skeleton the ones exported by acc module. However, I am not sure if
>> we should do it there or add them to the existing docs of the modules.
>> Opinions on this?!?
>>
>> Cheers,
>> Daniel
>>
>> -- 
>> Daniel-Constantin Mierla
>> https://nam02.safelinks.protection.outlook.com/?url=www.twitter.com%2Fmiconda&data=02%7C01%7Csamuel_is_kewl%40hotmail.com%7C226fe2242ed4436c13fa08d53029444d%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636467876150276887&sdata=%2F1Fg1476daehbTE4jVNmQ1%2BQro52j%2Fy6maGN8HZmHjU%3D&reserved=0
>> --
>> https://nam02.safelinks.protection.outlook.com/?url=www.linkedin.com%2Fin%2Fmiconda&data=02%7C01%7Csamuel_is_kewl%40hotmail.com%7C226fe2242ed4436c13fa08d53029444d%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636467876150276887&sdata=WytUIkS%2FT0cdu%2BEMhSLz8TFhkn2PADOVGEjnHF5d2lE%3D&reserved=0
>> Kamailio Advanced Training -
>> https://nam02.safelinks.protection.outlook.com/?url=www.asipto.com&data=02%7C01%7Csamuel_is_kewl%40hotmail.com%7C226fe2242ed4436c13fa08d53029444d%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636467876150276887&sdata=b8D9EWNFf5eocdwbjZDu8nKmFF777nNE5yknicVgDKs%3D&reserved=0
>> Kamailio World Conference - May 14-16, 2018 -
>> https://nam02.safelinks.protection.outlook.com/?url=www.kamailioworld.com&data=02%7C01%7Csamuel_is_kewl%40hotmail.com%7C226fe2242ed4436c13fa08d53029444d%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636467876150276887&sdata=X7KEbj5w3kLSiCPrpgnrdoCITpeBiWPfAeYFyY2yMhk%3D&reserved=0
>>
>>
>> _______________________________________________
>> Kamailio (SER) - Users Mailing List
>> sr-users at lists.kamailio.org
>> https://nam02.safelinks.protection.outlook.com/?url=https%3A%2F%2Flists.kamailio.org%2Fcgi-bin%2Fmailman%2Flistinfo%2Fsr-users&data=02%7C01%7Csamuel_is_kewl%40hotmail.com%7C226fe2242ed4436c13fa08d53029444d%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636467876150276887&sdata=HLJ5knbTzvZ2EFRpdNEPawUUy5ArJVL6HVqitepIM2Q%3D&reserved=0
>
> -- 
> Daniel-Constantin Mierla
> www.twitter.com/miconda -- www.linkedin.com/in/miconda
> Kamailio Advanced Training - www.asipto.com
> Kamailio World Conference - May 14-16, 2018 - www.kamailioworld.com

-- 
Daniel-Constantin Mierla
www.twitter.com/miconda -- www.linkedin.com/in/miconda
Kamailio Advanced Training - www.asipto.com
Kamailio World Conference - May 14-16, 2018 - www.kamailioworld.com

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.kamailio.org/pipermail/sr-users/attachments/20171121/f4190853/attachment.html>