Struct jsonrpsee_core::server::rpc_module::RpcModule
source · pub struct RpcModule<Context> { /* private fields */ }
Expand description
Sets of JSON-RPC methods can be organized into a “module“s that are in turn registered on the server or,
alternatively, merged with other modules to construct a cohesive API. RpcModule
wraps an additional context
argument that can be used to access data during call execution.
Implementations§
source§impl<Context: Send + Sync + 'static> RpcModule<Context>
impl<Context: Send + Sync + 'static> RpcModule<Context>
sourcepub fn register_method<R, F>(
&mut self,
method_name: &'static str,
callback: F
) -> Result<MethodResourcesBuilder<'_>, Error>where
Context: Send + Sync + 'static,
R: Serialize,
F: Fn(Params<'_>, &Context) -> Result<R, Error> + Send + Sync + 'static,
pub fn register_method<R, F>( &mut self, method_name: &'static str, callback: F ) -> Result<MethodResourcesBuilder<'_>, Error>where Context: Send + Sync + 'static, R: Serialize, F: Fn(Params<'_>, &Context) -> Result<R, Error> + Send + Sync + 'static,
Register a new synchronous RPC method, which computes the response with the given callback.
sourcepub fn register_async_method<R, Fun, Fut>(
&mut self,
method_name: &'static str,
callback: Fun
) -> Result<MethodResourcesBuilder<'_>, Error>where
R: Serialize + Send + Sync + 'static,
Fut: Future<Output = Result<R, Error>> + Send,
Fun: Fn(Params<'static>, Arc<Context>) -> Fut + Clone + Send + Sync + 'static,
pub fn register_async_method<R, Fun, Fut>( &mut self, method_name: &'static str, callback: Fun ) -> Result<MethodResourcesBuilder<'_>, Error>where R: Serialize + Send + Sync + 'static, Fut: Future<Output = Result<R, Error>> + Send, Fun: Fn(Params<'static>, Arc<Context>) -> Fut + Clone + Send + Sync + 'static,
Register a new asynchronous RPC method, which computes the response with the given callback.
sourcepub fn register_blocking_method<R, F>(
&mut self,
method_name: &'static str,
callback: F
) -> Result<MethodResourcesBuilder<'_>, Error>where
Context: Send + Sync + 'static,
R: Serialize,
F: Fn(Params<'_>, Arc<Context>) -> Result<R, Error> + Clone + Send + Sync + 'static,
pub fn register_blocking_method<R, F>( &mut self, method_name: &'static str, callback: F ) -> Result<MethodResourcesBuilder<'_>, Error>where Context: Send + Sync + 'static, R: Serialize, F: Fn(Params<'_>, Arc<Context>) -> Result<R, Error> + Clone + Send + Sync + 'static,
Register a new blocking synchronous RPC method, which computes the response with the given callback.
Unlike the regular register_method
, this method can block its thread and perform expensive computations.
sourcepub fn register_subscription<F>(
&mut self,
subscribe_method_name: &'static str,
notif_method_name: &'static str,
unsubscribe_method_name: &'static str,
callback: F
) -> Result<MethodResourcesBuilder<'_>, Error>where
Context: Send + Sync + 'static,
F: Fn(Params<'_>, SubscriptionSink, Arc<Context>) -> SubscriptionResult + Send + Sync + 'static,
pub fn register_subscription<F>( &mut self, subscribe_method_name: &'static str, notif_method_name: &'static str, unsubscribe_method_name: &'static str, callback: F ) -> Result<MethodResourcesBuilder<'_>, Error>where Context: Send + Sync + 'static, F: Fn(Params<'_>, SubscriptionSink, Arc<Context>) -> SubscriptionResult + Send + Sync + 'static,
Register a new publish/subscribe interface using JSON-RPC notifications.
It implements the ethereum pubsub specification with an option to choose custom subscription ID generation.
Furthermore, it generates the unsubscribe implementation
where a bool
is used as
the result to indicate whether the subscription was successfully unsubscribed to or not.
For instance an unsubscribe call
may fail if a non-existent subscriptionID is used in the call.
This method ensures that the subscription_method_name
and unsubscription_method_name
are unique.
The notif_method_name
argument sets the content of the method
field in the JSON document that
the server sends back to the client. The uniqueness of this value is not machine checked and it’s up to
the user to ensure it is not used in any other RpcModule
used in the server.
Arguments
subscription_method_name
- name of the method to call to initiate a subscriptionnotif_method_name
- name of method to be used in the subscription payload (technically a JSON-RPC notification)unsubscription_method
- name of the method to call to terminate a subscriptioncallback
- A callback to invoke on each subscription; it takes three parameters:Params
: JSON-RPC parameters in the subscription call.SubscriptionSink
: A sink to send messages to the subscriber.- Context: Any type that can be embedded into the
RpcModule
.
Examples
use jsonrpsee_core::server::rpc_module::{RpcModule, SubscriptionSink};
use jsonrpsee_core::Error;
let mut ctx = RpcModule::new(99_usize);
ctx.register_subscription("sub", "notif_name", "unsub", |params, mut sink, ctx| {
let x = match params.one::<usize>() {
Ok(x) => x,
Err(e) => {
let err: Error = e.into();
sink.reject(err);
return Ok(());
}
};
// Sink is accepted on the first `send` call.
std::thread::spawn(move || {
let sum = x + (*ctx);
let _ = sink.send(&sum);
});
Ok(())
});
Methods from Deref<Target = Methods>§
sourcepub fn merge(&mut self, other: impl Into<Methods>) -> Result<(), Error>
pub fn merge(&mut self, other: impl Into<Methods>) -> Result<(), Error>
Merge two Methods
’s by adding all MethodCallback
s from other
into self
.
Fails if any of the methods in other
is present already.
sourcepub fn method(&self, method_name: &str) -> Option<&MethodCallback>
pub fn method(&self, method_name: &str) -> Option<&MethodCallback>
Returns the method callback.
sourcepub fn method_with_name(
&self,
method_name: &str
) -> Option<(&'static str, &MethodCallback)>
pub fn method_with_name( &self, method_name: &str ) -> Option<(&'static str, &MethodCallback)>
Returns the method callback along with its name. The returned name is same as the
method_name
, but its lifetime bound is 'static
.
sourcepub async fn call<Params: ToRpcParams, T: DeserializeOwned>(
&self,
method: &str,
params: Params
) -> Result<T, Error>
pub async fn call<Params: ToRpcParams, T: DeserializeOwned>( &self, method: &str, params: Params ) -> Result<T, Error>
Helper to call a method on the RPC module
without having to spin up a server.
The params must be serializable as JSON array, see ToRpcParams
for further documentation.
Returns the decoded value of the result field
in JSON-RPC response if successful.
Examples
#[tokio::main]
async fn main() {
use jsonrpsee::RpcModule;
let mut module = RpcModule::new(());
module.register_method("echo_call", |params, _| {
params.one::<u64>().map_err(Into::into)
}).unwrap();
let echo: u64 = module.call("echo_call", [1_u64]).await.unwrap();
assert_eq!(echo, 1);
}
sourcepub async fn raw_json_request(
&self,
request: &str
) -> Result<(MethodResponse, UnboundedReceiver<String>), Error>
pub async fn raw_json_request( &self, request: &str ) -> Result<(MethodResponse, UnboundedReceiver<String>), Error>
Make a request (JSON-RPC method call or subscription) by using raw JSON.
Returns the raw JSON response to the call and a stream to receive notifications if the call was a subscription.
Examples
#[tokio::main]
async fn main() {
use jsonrpsee::RpcModule;
use jsonrpsee::types::Response;
use futures_util::StreamExt;
let mut module = RpcModule::new(());
module.register_subscription("hi", "hi", "goodbye", |_, mut sink, _| {
sink.send(&"one answer").unwrap();
Ok(())
}).unwrap();
let (resp, mut stream) = module.raw_json_request(r#"{"jsonrpc":"2.0","method":"hi","id":0}"#).await.unwrap();
let resp = serde_json::from_str::<Response<u64>>(&resp.result).unwrap();
let sub_resp = stream.next().await.unwrap();
assert_eq!(
format!(r#"{{"jsonrpc":"2.0","method":"hi","params":{{"subscription":{},"result":"one answer"}}}}"#, resp.result),
sub_resp
);
}
sourcepub async fn subscribe(
&self,
sub_method: &str,
params: impl ToRpcParams
) -> Result<Subscription, Error>
pub async fn subscribe( &self, sub_method: &str, params: impl ToRpcParams ) -> Result<Subscription, Error>
Helper to create a subscription on the RPC module
without having to spin up a server.
The params must be serializable as JSON array, see ToRpcParams
for further documentation.
Returns Subscription
on success which can used to get results from the subscriptions.
Examples
#[tokio::main]
async fn main() {
use jsonrpsee::{RpcModule, types::EmptyServerParams};
let mut module = RpcModule::new(());
module.register_subscription("hi", "hi", "goodbye", |_, mut sink, _| {
sink.send(&"one answer").unwrap();
Ok(())
}).unwrap();
let mut sub = module.subscribe("hi", EmptyServerParams::new()).await.unwrap();
// In this case we ignore the subscription ID,
let (sub_resp, _sub_id) = sub.next::<String>().await.unwrap().unwrap();
assert_eq!(&sub_resp, "one answer");
}
sourcepub fn method_names(&self) -> impl Iterator<Item = &'static str> + '_
pub fn method_names(&self) -> impl Iterator<Item = &'static str> + '_
Returns an Iterator
with all the method names registered on this server.