Struct kayrx::jrpc::Server

pub struct Server { /* fields omitted */ }

Server that can be cloned.

Note: This struct is designed to be easy to use, but it works by maintaining a background task running in parallel. If this is not desirable, you are encouraged to use the RawServer struct instead.

Methods

impl Server

pub fn new<R, I>(server: RawServer<R, I>) -> Server where
    R: TransportServer<RequestId = I> + Send + Sync + 'static,
    I: Clone + PartialEq + Eq + Hash + Send + Sync + 'static, 

Initializes a new server based upon this raw server.

pub fn register_notifications(
    &self,
    method_name: String,
    allow_losses: bool
) -> Result<RegisteredNotifications, ()>

Registers a notification method name towards the server.

Clients will then be able to call this method. The returned object allows you to process incoming notifications.

If allow_losses is true, then the server is allowed to drop notifications if the notifications handler (i.e. the code that uses [RegisteredNotifications]) is too slow to process notifications.

Returns an error if the method name was already registered.

pub fn register_method(
    &self,
    method_name: String
) -> Result<RegisteredMethod, ()>

Registers a method towards the server.

Clients will then be able to call this method. The returned object allows you to handle incoming requests.

Contrary to register_notifications, there is no allow_losses parameter here. If the handler is too slow to process requests, then the server automatically returns an "internal error" to the client.

Returns an error if the method name was already registered.

pub fn register_subscription(
    &self,
    subscribe_method_name: String,
    unsubscribe_method_name: String
) -> Result<RegisteredSubscription, ()>

Registers a subscription towards the server.

Clients will then be able to call this method. The returned object allows you to send out notifications.

Returns an error if one of the method names was already registered.

Trait Implementations

impl Clone for Server

fn clone(&self) -> Server

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<R, I> From<RawServer<R, I>> for Server where
    R: TransportServer<RequestId = I> + Send + Sync + 'static,
    I: Clone + PartialEq + Eq + Hash + Send + Sync + 'static, 

Initializes a new server based upon this raw server.

fn from(server: RawServer<R, I>) -> Server

Performs the conversion.