Struct ServerBuilder 

pub struct ServerBuilder<B, W = JsonCodec> {
    config: ServerConfig,
    byte_codec: B,
    ws_codec: W,
    executor: Option<Executor>,
}

Builder for constructing an RPC Server.

Example

use std::sync::Arc;
use serde_json::Value;
use karyon_jsonrpc::{error::RPCError, rpc_impl, server::ServerBuilder};

struct Ping {}

#[rpc_impl]
impl Ping {
    async fn ping(&self, _params: Value) -> Result<Value, RPCError> {
        Ok(serde_json::json!("pong"))
    }
}

async {
    let server = ServerBuilder::new("tcp://127.0.0.1:60000")
        .expect("create builder")
        .service(Arc::new(Ping {}))
        .build().await
        .expect("build server");

    server.start_block().await.expect("run server");
};

Fields

config: ServerConfig

byte_codec: B

ws_codec: W

executor: Option<Executor>

Implementations

impl<B, W> ServerBuilder<B, W>

where B: JsonRpcCodec, W: WsCodec,

pub fn service(self, service: Arc<dyn RPCService>) -> Self

Add an RPC service.

pub fn pubsub_service(self, service: Arc<dyn PubSubRPCService>) -> Self

Add a PubSub RPC service.

pub fn tcp_config(self, config: TcpConfig) -> Result<Self>

Set TCP config.

pub fn tls_config(self, config: ServerTlsConfig) -> Result<Self>

Set TLS config.

pub fn quic_config(self, config: ServerQuicConfig) -> Result<Self>

Set QUIC config.

pub async fn with_executor(self, ex: Executor) -> Self

Set an executor.

pub fn with_notification_encoder( self, encoder: fn(NewNotification) -> Notification, ) -> Self

Set a custom notification encoder.

pub fn with_ws_codec<W2: WsCodec>(self, ws_codec: W2) -> ServerBuilder<B, W2>

Override the WebSocket codec. Only meaningful for ws:// / wss:// endpoints.

pub async fn build(self) -> Result<Arc<Server>>

Build the server.

impl<B: JsonRpcCodec> ServerBuilder<B, JsonCodec>

pub fn new_with_codec( endpoint: impl ToEndpoint, codec: B, ) -> Result<ServerBuilder<B, JsonCodec>>

Create a builder with a custom byte-stream codec. The default JsonCodec is used for ws:// / wss:// endpoints; override with with_ws_codec.

impl ServerBuilder<JsonCodec, JsonCodec>

pub fn new( endpoint: impl ToEndpoint, ) -> Result<ServerBuilder<JsonCodec, JsonCodec>>

Create a builder with the default JSON codec.