Struct IpcServer

pub struct IpcServer<HttpMiddleware = Identity, RpcMiddleware = Identity> { /* private fields */ }

Ipc Server implementation

This is an adapted jsonrpsee Server, but for Ipc connections.

Implementations

impl<HttpMiddleware, RpcMiddleware> IpcServer<HttpMiddleware, RpcMiddleware>

pub fn endpoint(&self) -> String

Returns the configured endpoint

impl<HttpMiddleware, RpcMiddleware> IpcServer<HttpMiddleware, RpcMiddleware>

where RpcMiddleware: for<'a> Layer<RpcService, Service: RpcServiceT<'a>> + Clone + Send + 'static, HttpMiddleware: Layer<TowerServiceNoHttp<RpcMiddleware>, Service: Service<String, Response = Option<String>, Error = Box<dyn Error + Send + Sync + 'static>, Future: Send + Unpin> + Send> + Send + 'static,

pub async fn start( self, methods: impl Into<Methods>, ) -> Result<ServerHandle, IpcServerStartError>

Start responding to connections requests.

This will run on the tokio runtime until the server is stopped or the ServerHandle is dropped.

use jsonrpsee::RpcModule;
use reth_ipc::server::Builder;
async fn run_server() -> Result<(), Box<dyn core::error::Error + Send + Sync>> {
    let server = Builder::default().build("/tmp/my-uds".into());
    let mut module = RpcModule::new(());
    module.register_method("say_hello", |_, _, _| "lo")?;
    let handle = server.start(module).await?;

    // In this example we don't care about doing shutdown so let's it run forever.
    // You may use the `ServerHandle` to shut it down or manage it yourself.
    let server = tokio::spawn(handle.stopped());
    server.await.unwrap();
    Ok(())
}

Trait Implementations

impl Debug for IpcServer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.