Struct WsService 

pub struct WsService { /* private fields */ }

Implementations

impl WsService

pub fn new(url: Url, access_token: Option<String>) -> Self

pub fn new_with_options( url: Url, access_token: Option<String>, auto_reconnect: Option<bool>, reconnect_interval: Option<Duration>, max_reconnect_times: Option<u32>, ) -> Self

pub fn builder(url: &str) -> Result<WsServiceBuilder, ParseError>

impl WsService

pub fn get_url(&self) -> Url

pub async fn connect( url: impl ToString, ) -> Result<WebSocketStream<MaybeTlsStream<TcpStream>>, Error>

pub async fn send_processor( send_side: SplitSink<WebSocketStream<MaybeTlsStream<TcpStream>>, Message>, api_receiver: InternalAPIReceiver, close_signal: Receiver<()>, connection_close_signal: Receiver<()>, ) -> Result<()>

pub async fn read_processor( read_side: SplitStream<WebSocketStream<MaybeTlsStream<TcpStream>>>, event_sender: InternalEventSender, close_signal: Receiver<()>, connection_close_signal_sender: Sender<()>, ) -> Result<()>

pub async fn spawn_processor(&self) -> ServiceStartResult<()>

pub async fn reconnect(&self, reconnect_times: u32) -> Result<()>

pub async fn reconnect_processor(self) -> Result<()>

Trait Implementations

impl Clone for WsService

fn clone(&self) -> WsService

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommunicationService for WsService

fn install( &mut self, api_receiver: InternalAPIReceiver, event_sender: InternalEventSender, )

安装服务
该方法仅进行服务的依赖注入，并不真正创建任务
应具备幂等性

fn uninstall(&mut self)

卸载服务
服务应回收安装后产生的一切副作用和安装时注入的依赖
应具备幂等性

fn stop(&self)

停止服务
不同于 uninstall 方法 ，stop 方法仅需要回收安装后产生的副作用，并不需要回收安装时注入的依赖
应具备幂等性

fn start<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = ServiceStartResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

开始服务
服务内应保证任务在服务的生命周期内最多存在一个
由于在服务生命周期内最多存在一个任务，所以该方法 应具备幂等性

fn restart<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = ServiceStartResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

重启服务
不具备幂等性

impl Debug for WsService

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

Formats the value using the given formatter.

impl Drop for WsService

fn drop(&mut self)

Executes the destructor for this type.