build: split into luci and luci-addons packages
[project/luci.git] / libs / lucid-rpc / docs / OVERVIEW
1                                         LuCId JSON-RPC Server Slave
2                                                                                         
3 *** Abstract ***
4 The LuCId JSON-RPC server slave implements the JSON-RPC 1.0 and 2.0 protocol
5 to allow efficient light-weight remote procedure calling.
6 It provides notification support and several unofficial protocol extensions such
7 as:
8         * Close notifications
9         * Raw TCP switching to transfer BLOBs efficiently
10         * Client notification
11
12
13 *** Workflow ***
14 After receiving an incoming connection from LuCId, the slave analyses the
15 request and passes it to the matching handler. The handler will enforce
16 access restriction and deserialize the payload data and invokes the assigned
17 Lua function in a protected way. In case of a success the handler will serialize
18 the response and send it to the client - otherwise a detailed error message
19 will be returned.