Skip to content

Commit

Permalink
feat: update doc and release 2.0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
shuai132 committed Oct 21, 2023
1 parent c90c560 commit b7f8b20
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 11 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Arduino, STM32, ESP32/ESP8266, etc.)
The complete rpc frameworks (such as `gRPC` and `brpc`) have complex functions
and are not practical on embedded platforms.

This project offers a lightweight and user-friendly implementation that is better suited for one-to-one rpc calls.
This project offers a lightweight and user-friendly rpc library that is better suited for one-to-one rpc calls.
It supports all platforms and a wide range of microchips, including Arduino, STM32, ESP32/ESP8266, and more.

Note:
Expand All @@ -21,21 +21,21 @@ For TCP-based implementations: [asio_net](https://github.com/shuai132/asio_net)
## Features

* Header-Only
* No schema
* Support performance-limited platforms, including microchips
* Compatible with any connection type (`tcp socket`, `serial port`, etc.)
* Serialization for primitive types, most STL containers, and user struct/class
* No-Schema
* Support performance-limited platforms including microchips
* Support any connection type (`tcp socket`, `serial port`, etc.)
* High Performance Serialization, support most STL containers and user type
* Serialization plugins implementations for `flatbuffers` and `nlohmann::json`
* RAII-based `dispose` for automatic request cancellation
* Timeout and retry settings
* RAII-based `dispose` for automatic cancel request
* Timeout and Retry API
* Support `std::future` interface

## Requirements

* C++11
* Provide your connection implementation: [connection](include/rpc_core/connection.hpp)
NOTICE: complete data packets are required for data transmission, such as `websocket`.
If using `tcp socket`, `serial port`, etc., message pack and unpack need to be implemented by yourself.
If using `tcp socket`, `serial port`, etc., message pack and unpack need to be implemented.
Or you can use [stream_connection](include/rpc_core/connection.hpp).

## Usage
Expand All @@ -58,7 +58,7 @@ rpc->cmd("cmd")
`msg` and `rsp` support any serializable type, see [Serialization](#Serialization).
Detailed initialization process and unit tests can be found here: [rpc_test.cpp](test/test_rpc.cpp)
Detailed usages and unittests can be found here: [rpc_test.cpp](test/test_rpc.cpp)
## Serialization
Expand Down
2 changes: 1 addition & 1 deletion include/rpc_core/version.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

#define RPC_CORE_VER_MAJOR 2
#define RPC_CORE_VER_MINOR 0
#define RPC_CORE_VER_PATCH 0
#define RPC_CORE_VER_PATCH 1

#define RPC_CORE_TO_VERSION(major, minor, patch) (major * 10000 + minor * 100 + patch)
#define RPC_CORE_VERSION RPC_CORE_TO_VERSION(RPC_CORE_VER_MAJOR, RPC_CORE_VER_MINOR, RPC_CORE_VER_PATCH)
2 changes: 1 addition & 1 deletion library.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"type": "git",
"url": "https://github.com/shuai132/rpc_core.git"
},
"version": "2.0.0",
"version": "2.0.1",
"build": {
"srcDir": "_",
"flags": [
Expand Down

0 comments on commit b7f8b20

Please sign in to comment.