Struct workflow_rpc::server::Interface

pub struct Interface<ServerContext, ConnectionContext, Ops>
where
    ServerContext: Clone + Send + Sync + 'static,
    ConnectionContext: Clone + Send + Sync + 'static,
    Ops: OpsT,
{ /* private fields */ }

Interface struct carries a mapping of RPC methods and notifications, used by protocols to dispatch calls to their respective handlers.

Implementations

impl<ServerContext, ConnectionContext, Ops> Interface<ServerContext, ConnectionContext, Ops>

where ServerContext: Clone + Send + Sync + 'static, ConnectionContext: Clone + Send + Sync + 'static, Ops: OpsT,

pub fn new( server_ctx: ServerContext, ) -> Interface<ServerContext, ConnectionContext, Ops>

Create an interface that will contain user-defined RPC message and notification handlers. This method accepts server_ctx argument that will be subsequently passed to each RPC method or notification invocation.

pub fn method<Req, Resp>( &mut self, op: Ops, method: Method<ServerContext, ConnectionContext, Req, Resp>, )

where Ops: Debug + Clone, Req: MsgT, Resp: MsgT,

Declare an RPC method handler. You can use a method!() macro to declare the method as follows:

interface.method(MyOps::Method, method!(
  | connection_ctx: ConnectionCtx,
    server_ctx: ServerContext,
    req: MyReq |
async move {
    // ...
    Ok(MyResp { })
}))

pub fn notification<Msg>( &mut self, op: Ops, method: Notification<ServerContext, ConnectionContext, Msg>, )

where Ops: Debug + Clone, Msg: MsgT,

Declare an RPC notification handler. You can use a notification!() macro to declare the notification as follows:

interface.notification(MyOps::Notify, notification!(
  | connection_ctx: ConnectionCtx,
    server_ctx: ServerContext,
    msg: MyMsg |
async move {
    // ...
    Ok(())
}))