Struct engineioxide::service::EngineIoService

pub struct EngineIoService<H: EngineIoHandler, S = NotFoundService> { /* private fields */ }

A [Service] that handles EngineIo requests as a middleware. If the request is not an EngineIo request, it forwards it to the inner service. It is agnostic to the TransportType.

By default, it uses a NotFoundService as the inner service so it can be used as a standalone [Service].

Implementations

impl<H: EngineIoHandler> EngineIoService<H, NotFoundService>

pub fn new(handler: H) -> Self

Create a new EngineIoService with a NotFoundService as the inner service. If the request is not an EngineIo request, it will always return a 404 response.

pub fn with_config(handler: H, config: EngineIoConfig) -> Self

Create a new EngineIoService with a custom config

impl<S: Clone, H: EngineIoHandler> EngineIoService<H, S>

pub fn with_inner(inner: S, handler: H) -> Self

Create a new EngineIoService with a custom inner service.

pub fn with_config_inner(inner: S, handler: H, config: EngineIoConfig) -> Self

Create a new EngineIoService with a custom inner service and a custom config.

pub fn into_make_service(self) -> MakeEngineIoService<H, S>

Convert this EngineIoService into a MakeEngineIoService. This is useful when using EngineIoService without layers.

Trait Implementations

impl<S: Clone, H: EngineIoHandler> Clone for EngineIoService<H, S>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<H: EngineIoHandler, S> Debug for EngineIoService<H, S>

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

Formats the value using the given formatter.

impl<ReqBody, ResBody, S, H> Service<Request<ReqBody>> for EngineIoService<H, S>

where ResBody: Body + Send + 'static, ReqBody: Body + Send + Unpin + 'static + Debug, <ReqBody as Body>::Error: Debug, <ReqBody as Body>::Data: Send, S: Service<Request<ReqBody>, Response = Response<ResBody>>, H: EngineIoHandler,

The service implementation for EngineIoService.

fn call(&mut self, req: Request<ReqBody>) -> Self::Future

Handle the request. Each request is parsed to extract the TransportType and the socket id. If the request is an EngineIo request, it is handled by the EngineIo engine. Otherwise, it is forwarded to the inner service.

type Response = Response<ResponseBody<ResBody>>

Responses given by the service.

type Error = <S as Service<Request<ReqBody>>>::Error

Errors produced by the service.

type Future = ResponseFuture<<S as Service<Request<ReqBody>>>::Future, ResBody>

The future response value.

fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

Returns Poll::Ready(Ok(())) when the service is able to process requests.