Struct ResponseStreamEvent 

pub struct ResponseStreamEvent<State: Clone + Send + Sync + 'static = ()> { /* private fields */ }

Available on (crate features clients or servers) and crate feature servers only.

An event that is sent when a new connection is created, or destroyed.

Implementations

impl ResponseStreamEvent<()>

pub const fn new( connection_channel: Sender<ResponseStreamMessage>, source_address: SocketAddr, stream_id: Option<u64>, ) -> Self

pub const fn new_disconnected( source_address: SocketAddr, stream_id: Option<u64>, ) -> Self

impl<State: Clone + Send + Sync + 'static> ResponseStreamEvent<State>

pub const fn new_with_state( connection_channel: Sender<ResponseStreamMessage>, source_address: SocketAddr, stream_id: Option<u64>, state: State, ) -> Self

pub const fn new_disconnected_with_state( source_address: SocketAddr, stream_id: Option<u64>, state: State, ) -> Self

pub fn stream_id(&self) -> u64

A unique identifier for the “stream” or connection of a packet.

In UDP which doesn’t have stream this uses the source address as the core identifier.

pub const fn out_of_band_channel( &self, ) -> Option<&Sender<ResponseStreamMessage>>

Allows retrieving a channel to send out-of-band packets to a connection.

This type is clone-able, and can be used without needing to hold onto this event.

pub const fn state(&self) -> &State

pub fn state_mut(&mut self) -> &mut State

pub const fn extensions(&self) -> &Extensions

pub fn extensions_mut(&mut self) -> &mut Extensions

pub const fn source(&self) -> &SocketAddr

pub fn is_ipv4(&self) -> bool

pub fn is_ipv6(&self) -> bool

Trait Implementations

impl<State: Clone + Send + Sync + 'static> Debug for ResponseStreamEvent<State>

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

Formats the value using the given formatter.

impl<ServiceTy, ExtensionTy, State> Service<ResponseStreamEvent<State>> for AddExtension<ServiceTy, ExtensionTy>

where ServiceTy: Service<ResponseStreamEvent<State>>, ExtensionTy: Clone + Send + Sync + 'static, State: Clone + Send + Sync + 'static,

type Response = <ServiceTy as Service<ResponseStreamEvent<State>>>::Response

Responses given by the service.

type Error = <ServiceTy as Service<ResponseStreamEvent<State>>>::Error

Errors produced by the service.

type Future = <ServiceTy as Service<ResponseStreamEvent<State>>>::Future

The future response value.

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

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

fn call(&mut self, evt: ResponseStreamEvent<State>) -> Self::Future

Process the request and return the response asynchronously.

impl<Layered, State: Clone + Send + Sync + 'static> Service<ResponseStreamEvent<State>> for LayeredBeginWALStream<Layered>

where Layered: Service<ResponseStreamEvent<State>, Response = bool, Error = CatBridgeError> + Clone + Send + 'static, Layered::Future: Send + 'static,

type Response = <Layered as Service<ResponseStreamEvent<State>>>::Response

Responses given by the service.

type Error = <Layered as Service<ResponseStreamEvent<State>>>::Error

Errors produced by the service.

type Future = Pin<Box<dyn Future<Output = Result<<LayeredBeginWALStream<Layered> as Service<ResponseStreamEvent<State>>>::Response, <LayeredBeginWALStream<Layered> as Service<ResponseStreamEvent<State>>>::Error>> + Send>>

The future response value.

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

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

fn call(&mut self, evt: ResponseStreamEvent<State>) -> Self::Future

Process the request and return the response asynchronously.

impl<Layered, State: Clone + Send + Sync + 'static> Service<ResponseStreamEvent<State>> for LayeredEndWALStream<Layered>

where Layered: Service<ResponseStreamEvent<State>, Response = (), Error = CatBridgeError> + Clone + Send + 'static, Layered::Future: Send + 'static,

type Response = <Layered as Service<ResponseStreamEvent<State>>>::Response

Responses given by the service.

type Error = <Layered as Service<ResponseStreamEvent<State>>>::Error

Errors produced by the service.

type Future = Pin<Box<dyn Future<Output = Result<<LayeredEndWALStream<Layered> as Service<ResponseStreamEvent<State>>>::Response, <LayeredEndWALStream<Layered> as Service<ResponseStreamEvent<State>>>::Error>> + Send>>

The future response value.

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

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

fn call(&mut self, evt: ResponseStreamEvent<State>) -> Self::Future

Process the request and return the response asynchronously.

impl<HandlerTy, HandlerParamsTy, State> Service<ResponseStreamEvent<State>> for OnStreamBeginHandlerAsService<HandlerTy, HandlerParamsTy>

where HandlerTy: OnResponseStreamBeginHandler<HandlerParamsTy, State> + Clone + Send + 'static, State: Clone + Send + Sync + 'static,

type Response = bool

Responses given by the service.

type Error = CatBridgeError

Errors produced by the service.

type Future = <HandlerTy as OnResponseStreamBeginHandler<HandlerParamsTy, State>>::Future

The future response value.

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

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

fn call(&mut self, req: ResponseStreamEvent<State>) -> Self::Future

Process the request and return the response asynchronously.

impl<HandlerTy, HandlerParamsTy, State> Service<ResponseStreamEvent<State>> for OnStreamEndHandlerAsService<HandlerTy, HandlerParamsTy>

where HandlerTy: OnResponseStreamEndHandler<HandlerParamsTy, State> + Clone + Send + 'static, State: Clone + Send + Sync + 'static,

type Response = ()

Responses given by the service.

type Error = CatBridgeError

Errors produced by the service.

type Future = <HandlerTy as OnResponseStreamEndHandler<HandlerParamsTy, State>>::Future

The future response value.

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

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

fn call(&mut self, req: ResponseStreamEvent<State>) -> Self::Future

Process the request and return the response asynchronously.

impl<State: Clone + Send + Sync + 'static> Structable for ResponseStreamEvent<State>

fn definition(&self) -> StructDef<'_>

Returns the struct’s definition.

impl<State: Clone + Send + Sync + 'static> Valuable for ResponseStreamEvent<State>

fn as_value(&self) -> Value<'_>

Converts self into a Value instance.

fn visit(&self, visitor: &mut dyn Visit)

Calls the relevant method on Visit to extract data from self.

fn visit_slice(slice: &[Self], visit: &mut dyn Visit)

where Self: Sized,

Calls Visit::visit_primitive_slice() with self.