Skip to main content

WebSocketRuntime

Struct WebSocketRuntime 

Source
pub struct WebSocketRuntime { /* private fields */ }
Expand description

WebSocket 运行时

封装 sz_orm_websocket::WsServer,提供服务端 lifecycle 管理。

§设计

  • 默认使用 DefaultWebSocketHandler(echo 模式),可替换为自定义 handler
  • start 方法 spawn 后台任务,返回 JoinHandle<()>
  • stop 方法调用 WsServer::stop(),触发 oneshot shutdown
  • 监听 CancellationToken:收到信号后自动调用 WsServer::stop()

§用法

use sz_rust_core::runtime::websocket::{WebSocketRuntime, WebSocketRuntimeConfig};
use tokio_util::sync::CancellationToken;

let runtime = WebSocketRuntime::new(WebSocketRuntimeConfig::new("0.0.0.0:2346"));
let token = CancellationToken::new();
let handle = runtime.start(token.clone());
// ... 业务运行 ...
token.cancel();
let _ = handle.await;

Implementations§

Source§

impl WebSocketRuntime

Source

pub fn new(config: WebSocketRuntimeConfig) -> Self

创建 WebSocket 运行时,使用默认 handler

Source

pub fn start(&self, token: CancellationToken) -> JoinHandle<Result<(), WsError>>

启动 WebSocket 服务(返回 JoinHandle,调用方持有)

  • 使用 DefaultWebSocketHandler 处理连接
  • 监听 token.cancelled(),收到信号后调用 server.stop()
Source

pub fn start_with_handler( &self, handler: Arc<dyn WebSocketHandler>, token: CancellationToken, ) -> JoinHandle<Result<(), WsError>>

使用自定义 handler 启动 WebSocket 服务

Source

pub async fn stop(&self) -> Result<(), WsError>

手动停止服务

Source

pub async fn connection_count(&self) -> usize

获取当前连接数

Source

pub async fn broadcast_to_all(&self, data: Vec<u8>) -> Result<usize, WsError>

广播消息到所有连接

Source

pub async fn is_running(&self) -> bool

是否仍在运行

Source

pub fn config(&self) -> &WebSocketRuntimeConfig

获取配置

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more