diff --git a/doc/design.md b/doc/design.md index 50e502d0..fa4232e6 100644 --- a/doc/design.md +++ b/doc/design.md @@ -3,7 +3,7 @@ Given an interface description of an object with one or more methods, libmultiprocess generates: * A C++ `ProxyClient` class with an implementation of each interface method that sends a request over a socket, waits for a response, and returns the result. -* A C++ `ProxyServer` class that listens for requests over a socket and calls a wrapped C++ object implementating the same interface to actually execute the requests. +* A C++ `ProxyServer` class that listens for requests over a socket and calls a wrapped C++ object implementing the same interface to actually execute the requests. The function call ⇆ request translation supports input and output arguments, standard types like `unique_ptr`, `vector`, `map`, and `optional`, and bidirectional calls between processes through interface pointer and `std::function` arguments. diff --git a/doc/usage.md b/doc/usage.md index 2314f850..9de00ad8 100644 --- a/doc/usage.md +++ b/doc/usage.md @@ -2,7 +2,7 @@ ## Overview -_libmultiprocess_ is a library and code generator that allows calling C++ class interfaces across different processes. For an interface to be available from other processses, it needs two definitions: +_libmultiprocess_ is a library and code generator that allows calling C++ class interfaces across different processes. For an interface to be available from other processes, it needs two definitions: - An **API definition** declaring how the interface is called. Included examples: [calculator.h](https://github.com/chaincodelabs/libmultiprocess/blob/master/example/calculator.h), [printer.h](https://github.com/chaincodelabs/libmultiprocess/blob/master/example/printer.h), [init.h](https://github.com/chaincodelabs/libmultiprocess/blob/master/example/init.h). Bitcoin examples: [node.h](https://github.com/ryanofsky/bitcoin/blob/ipc-export/src/interfaces/node.h), [wallet.h](https://github.com/ryanofsky/bitcoin/blob/ipc-export/src/interfaces/wallet.h), [echo.h](https://github.com/ryanofsky/bitcoin/blob/ipc-export/src/interfaces/echo.h), [init.h](https://github.com/ryanofsky/bitcoin/blob/ipc-export/src/interfaces/init.h). diff --git a/include/mp/proxy.h b/include/mp/proxy.h index 6c0645e7..87416d27 100644 --- a/include/mp/proxy.h +++ b/include/mp/proxy.h @@ -117,7 +117,7 @@ struct ProxyServerCustom : public ProxyServerBase using ProxyServerBase::ProxyServerBase; }; -//! Function traits class used to get method paramater and result types in generated ProxyClient implementations from +//! Function traits class used to get method parameter and result types in generated ProxyClient implementations from //! proxy-codegen.cpp. template struct FunctionTraits;