Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/andeya/logimesh
A Rust RPC microservice 2.0 framework inspired by Towards Modern Development of Cloud Applications paper.
https://github.com/andeya/logimesh
microservice rpc
Last synced: 3 months ago
JSON representation
A Rust RPC microservice 2.0 framework inspired by Towards Modern Development of Cloud Applications paper.
- Host: GitHub
- URL: https://github.com/andeya/logimesh
- Owner: andeya
- License: mit
- Created: 2024-07-31T13:28:40.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-09-08T08:39:49.000Z (5 months ago)
- Last Synced: 2024-11-08T16:53:57.327Z (3 months ago)
- Topics: microservice, rpc
- Language: Rust
- Homepage:
- Size: 949 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# logimesh
`logimesh` is a Rust RPC Microservice 2.0 framework inspired by the [_Towards Modern Development of Cloud Applications_](https://dl.acm.org/doi/pdf/10.1145/3593856.3595909 "target=_blank") paper.
_（This is one of my amateur idea and is only developed in leisure-time.）_
[](https://crates.io/crates/logimesh)
[](https://docs.rs/logimesh)
[](https://github.com/andeya/logimesh?tab=MIT-1-ov-file)
## Some features of logimesh:
- The client supports both local calls and remote calls simultaneously, meaning that users can dynamically switch the calling method according to the context.
## Usage
Add to your `Cargo.toml` dependencies:
```toml
logimesh = "0.1"
```
The `logimesh::component` attribute expands to a collection of items that form an component component.
These generated types make it easy and ergonomic to write servers with less boilerplate.
Simply implement the generated component trait, and you're off to the races!
## Example
This example uses [tokio](https://tokio.rs), so add the following dependencies to
your `Cargo.toml`:
```toml
[lib]
name = "service"
path = "src/lib.rs"
...
[dependencies]
logimesh = { version = "0.1" }
anyhow = "1.0"
tokio = { version = "1.0", features = ["macros"] }
```
For a more real-world example, see [logimesh-example](logimesh-example).
First, let's set up the dependencies and component definition.
### `lib.rs` file
```rust
extern crate logimesh;
// This is the component definition. It looks a lot like a trait definition.
// It defines one RPC, hello, which takes one arg, name, and returns a String.
#[logimesh::component]
trait World {
/// Returns a greeting for name.
async fn hello(name: String) -> String;
}
```
This component definition generates a trait called `World`. Next we need to
implement it for our Server struct.
```rust
# extern crate logimesh;
#
# // This is the component definition. It looks a lot like a trait definition.
# // It defines one RPC, hello, which takes one arg, name, and returns a String.
# #[logimesh::component]
# trait World {
# /// Returns a greeting for name.
# async fn hello(name: String) -> String;
# }
use logimesh::context;
use logimesh::transport::codec::Codec;
/// This is the type that implements the generated World trait. It is the business logic
/// and is used to start the server.
#[derive(Clone)]
pub struct CompHello;
impl World for CompHello {
const TRANSPORT_CODEC: Codec = Codec::Json;
async fn hello(self, ctx: context::Context, name: String) -> String {
format!("Hello, {name}! context: {:?}", ctx)
}
}
```
### `server.rs` file
```rust
extern crate logimesh;
extern crate tokio;
extern crate anyhow;
#[tokio::main]
async fn main() -> anyhow::Result<()> {
logimesh::tokio_tcp_listen!(CompHello, logimesh::server::TcpConfig::new("[::1]:8888".parse::().unwrap()));
Ok(())
}
```
### `client.rs` file
```rust
extern crate logimesh;
extern crate tokio;
extern crate anyhow;
use logimesh::client::balance::RandomBalance;
use logimesh::client::discover::FixedDiscover;
use logimesh::client::lrcall::ConfigExt;
use logimesh::component::Endpoint;
use logimesh::context;
use service::{CompHello, World};
#[tokio::main]
async fn main() -> anyhow::Result<()> {
let client = CompHello
.logimesh_lrclient(
Endpoint::new("p.s.m"),
FixedDiscover::from_address(vec!["[::1]:8888".parse::().unwrap()]),
RandomBalance::new(),
ConfigExt::default(),
)
.await?;
// Send the request twice, just to be safe! ;)
let hello = tokio::select! {
hello1 = client.hello(context::current(), format!("{}1", flags.name)) => { hello1 }
hello2 = client.hello(context::current(), format!("{}2", flags.name)) => { hello2 }
};
match hello {
Ok(hello) => println!("{hello:?}"),
Err(e) => println!("{:?}", anyhow::Error::from(e)),
}
Ok(())
}
```
## Paper
Here [Towards Modern Development of Cloud Applications](https://dl.acm.org/doi/pdf/10.1145/3593856.3595909 "target=_blank")