From 3daabd37cd7e6193ca782f34071dfdb292f726a2 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Rafa=C5=82=20Mi=C5=82ecki?= Date: Fri, 1 Jul 2016 15:20:17 +0200 Subject: [PATCH] docs: add page with basic rpcd info MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Rafał Miłecki --- _includes/docs_nav.html | 1 + docs/rpcd.txt | 14 ++++++++++++++ 2 files changed, 15 insertions(+) create mode 100644 docs/rpcd.txt diff --git a/_includes/docs_nav.html b/_includes/docs_nav.html index 6679e87..8967779 100644 --- a/_includes/docs_nav.html +++ b/_includes/docs_nav.html @@ -6,6 +6,7 @@ Configuration uBus Procd + rpcd UCI Document
    DHCP diff --git a/docs/rpcd.txt b/docs/rpcd.txt new file mode 100644 index 0000000..2166661 --- /dev/null +++ b/docs/rpcd.txt @@ -0,0 +1,14 @@ +--- +--- +RPC daemon +======================== + +== RPC daemon + +In 'LEDE' we commonly use 'ubus' for all kinds of communication. It can provide info from various software as well as request various actions. Nevertheless, not every part of 'LEDE' has a deamon that can register itself using 'ubus'. For an example 'uci' and 'opkg' are command-line tools without any background process running all the time. + +It would be not efficient to write a deamon for every software like this and run them independently. This is why 'rpcd' was developed. It's a tiny deamon with support for plugins using trivial 'API'. It loads library `.so` files and calls init function of each of them. + +=== Default plugins + +There are few small plugins distributed with the 'rpcd' sources. Two of them ('session' and 'uci') are built-in, others are optional and have to be build as separated `.so` libraries. Apart from that there are other projects providing their own plugins. -- 2.30.2