dev intro

Introduction for Library Developers

The library is split into two parts RPC and API. To get better understanding of the internal mechanism you should understand what RPC is and read the msgpack-rpc specification. Every client is essentially a RPC client and server where the messages are relayed by the splonebox.

API

The API implements the interface for plug-in developers. Calls and responses specified in the Protocol are handles here. The classes defined here make use of the RPC module and only implement high level interfaces.

Tasks

• Implementation of run/register/result calls
• Manage responses and results
• Helper for remote Functions

RPC

The RPC module implements the connection, serialization and handling of incoming messages. The implementation is as minimal as possible the main operations are handled by the API module. The RPC module should never make use of any API functionality. Therefore no includes from Splonecli.API are allowed!

Tasks

• Manage the connection
• Handle incoming messages and call appropriate function API functions (using callbacks and registered functions)
• Handle errors on msgpack-rpc level and make sure received messages are in the correct format