OMGeeky/tarpc
1
0
Fork 0
mirror of https://github.com/OMGeeky/tarpc.git synced 2026-01-06 03:22:47 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #19 from tikue/readme

Browse Source 
Make a note of AsyncClient and `cargo doc` in the readme
This commit is contained in:
shaladdle
2016-02-18 15:35:56 -08:00
parent 75b2c00b54 0968760ef7
commit 00692fe9a3
1 changed files with 13 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@@ -53,13 +53,19 @@ fn main() {
}
```
The `service!` macro expands to a collection of items that collectively form an rpc service. In the
above example, the macro is called within the `hello_service` module. This module will contain a
`Client` type, a `Service` trait, and a `serve` function. `serve` can be used to start a server
listening on a tcp port. A `Client` can connect to such a service. Any type implementing the
`Service` trait can be passed to `serve`. These generated types are specific to the echo service,
and make it easy and ergonomic to write servers without dealing with sockets or serialization
directly. See the tarpc_examples package for more sophisticated examples.
The `service!` macro expands to a collection of items that collectively form an
rpc service. In the above example, the macro is called within the
`hello_service` module. This module will contain a `Client` type, a `Service`
trait, and a `serve` function. `serve` can be used to start a server listening
on a tcp port. A `Client` (or `AsyncClient`) can connect to such a service. Any
type implementing the `Service` trait can be passed to `serve`. These generated
types are specific to the echo service, and make it easy and ergonomic to write
servers without dealing with sockets or serialization directly. See the
tarpc_examples package for more sophisticated examples.
## Documentation
Use `cargo doc` as you normally would to see the documentation created for all
items expanded by a `service!` invocation.
## Additional Features
- Concurrent requests from a single client.