JSON-RPC in C 技术文档

1. 安装指南

首先，确保您的系统中已经安装了libev库和cJSON库。这两个库是本项目所依赖的。

接下来，您可以按照以下步骤进行安装：

1. 克隆项目到本地：

   git clone https://github.com/hmngomes/jsonrpc-c.git
   

2. 进入项目目录，并执行以下命令：

   autoreconf -i
   ./configure
   make
   

3. 如果编译成功，您将可以在项目目录中找到生成的库文件。

2. 项目的使用说明

本项目是一个C语言编写的库，用于接收基于TCP套接字的JSON-RPC请求。以下是一个简单的使用示例：

1. 创建一个服务器实例：

   jsonrpc_server *server = jsonrpc_server_new(NULL);
   

2. 绑定服务器到指定的TCP端口：

   jsonrpc_server_bind(server, "localhost", 1234);
   

3. 设置处理函数，用于处理客户端发送的JSON-RPC请求：

   jsonrpc_server_handle_method(server, "sayHello", handle_sayHello);
   

4. 启动服务器，等待客户端请求：

   jsonrpc_server_run(server);
   

5. 处理函数示例：

   void handle_sayHello(jsonrpc_server *server, jsonrpc_request *request) {
       jsonrpc_response *response = jsonrpc_response_new(request);
       json_t *result = json_string("Hello, World!");
       jsonrpc_response_set_result(response, result);
       jsonrpc_server_send_response(server, response);
       jsonrpc_response_free(response);
       json_delete(result);
   }
   

3. 项目API使用文档

以下本项目的主要API列表：

• jsonrpc_server *jsonrpc_server_new(json_t *config): 创建一个新的JSON-RPC服务器实例。
• void jsonrpc_server_bind(jsonrpc_server *server, const char *host, int port): 将服务器绑定到指定的TCP端口。
• void jsonrpc_server_handle_method(jsonrpc_server *server, const char *method, jsonrpc_handler handler): 设置处理函数，用于处理指定的JSON-RPC方法。
• void jsonrpc_server_run(jsonrpc_server *server): 启动服务器，等待客户端请求。
• jsonrpc_response *jsonrpc_response_new(jsonrpc_request *request): 创建一个新的JSON-RPC响应。
• void jsonrpc_response_set_result(jsonrpc_response *response, json_t *result): 设置响应的结果。
• void jsonrpc_server_send_response(jsonrpc_server *server, jsonrpc_response *response): 发送响应给客户端。
• void jsonrpc_response_free(jsonrpc_response *response): 释放响应资源。
• void json_delete(json_t *json): 删除JSON对象。

4. 项目安装方式

本项目使用CMake进行构建。以下是项目的安装方式：

1. 克隆项目到本地：

   git clone https://github.com/hmngomes/jsonrpc-c.git
   

2. 创建一个构建目录，并进入该目录：

   mkdir build && cd build
   

3. 运行CMake以生成构建系统：

   cmake ..
   

4. 构建项目：

   make
   

5. 安装项目：

   make install
   

以上是JSON-RPC in C项目的详细技术文档。希望对您有所帮助。