Struct WebSocketManager 

pub struct WebSocketManager { /* private fields */ }

WebSocket manager for Kick.com

Implementations

impl WebSocketManager

pub fn new() -> Self

Create a new WebSocket manager with default options

pub fn with_options(options: KickWebSocketOptions) -> Self

Create a new WebSocket manager with custom options

pub async fn connect(&self, channel_name: &str) -> Result<()>

Connect to a specific channel’s WebSocket

pub async fn disconnect(&self) -> Result<()>

Disconnect from the WebSocket

pub async fn on_chat_message<F>(&self, handler: F)

where F: Fn(ChatMessageEvent) + Send + Sync + 'static,

pub async fn on_message<F>(&self, handler: F)

where F: Fn(SimpleMessage) + Send + Sync + 'static,

pub async fn on_ready<F>(&self, handler: F)

where F: Fn(()) + Send + Sync + 'static,

pub async fn on_disconnected<F>(&self, handler: F)

where F: Fn(()) + Send + Sync + 'static,

pub async fn on_raw_message<F>(&self, handler: F)

where F: Fn(RawMessage) + Send + Sync + 'static,

pub async fn on_error<F>(&self, handler: F)

where F: Fn(KickError) + Send + Sync + 'static,

pub async fn on_message_deleted<F>(&self, handler: F)

where F: Fn(MessageDeletedEvent) + Send + Sync + 'static,

pub async fn on_user_banned<F>(&self, handler: F)

where F: Fn(UserBannedEvent) + Send + Sync + 'static,

pub async fn on_user_unbanned<F>(&self, handler: F)

where F: Fn(UserUnbannedEvent) + Send + Sync + 'static,

pub async fn on_subscription<F>(&self, handler: F)

where F: Fn(SubscriptionEvent) + Send + Sync + 'static,

pub async fn on_gifted_subscriptions<F>(&self, handler: F)

where F: Fn(GiftedSubscriptionsEvent) + Send + Sync + 'static,

pub async fn on_pinned_message_created<F>(&self, handler: F)

where F: Fn(PinnedMessageCreatedEvent) + Send + Sync + 'static,

pub async fn on_stream_host<F>(&self, handler: F)

where F: Fn(StreamHostEvent) + Send + Sync + 'static,

pub async fn on_poll_update<F>(&self, handler: F)

where F: Fn(PollUpdateEvent) + Send + Sync + 'static,

pub async fn on_poll_delete<F>(&self, handler: F)

where F: Fn(PollDeleteEvent) + Send + Sync + 'static,

pub async fn get_connection_state(&self) -> ConnectionState

pub async fn get_channel_name(&self) -> String

pub async fn get_channel_id(&self) -> u64

pub async fn build_websocket_url(&self) -> Result<Url>

Build the WebSocket URL with parameters (public method for testing)

pub async fn set_websocket_url(&self, url: String)

Set a custom WebSocket URL

pub async fn set_websocket_params(&self, params: HashMap<String, String>)

Set custom WebSocket parameters

pub async fn reset_websocket_config(&self)

Reset WebSocket configuration to defaults

pub async fn get_channel_id_from_name(&self, channel_name: &str) -> Result<u64>

Get channel ID from channel name (public method for testing)

pub async fn get_chatroom_id_from_name(&self, channel_name: &str) -> Result<u64>

Get chatroom ID for WebSocket subscription

pub async fn export_raw_messages(&self) -> Vec<String>

Clear the channel ID cache

pub async fn get_buffer_stats(&self) -> BufferStats

pub async fn export_raw_messages_by_event_type( &self, event_type: KickEventType, ) -> Vec<String>

Export raw messages by event type

pub async fn export_raw_messages_in_range( &self, start_index: usize, end_index: Option<usize>, ) -> Vec<String>

Export raw messages in range

pub async fn clear_raw_messages_by_event_type( &self, event_type: KickEventType, ) -> Result<()>

Clear raw messages by event type

pub async fn set_custom_user_agent(&self, user_agent: String)

Set a custom User-Agent for WebSocket connections

pub async fn set_user_agent_rotation(&self, enabled: bool)

Enable or disable User-Agent rotation for WebSocket connections

pub async fn get_user_agent_config(&self) -> (Option<String>, bool)

Get current User-Agent configuration

pub async fn reset_user_agent(&self)

Reset User-Agent to default behavior (rotation enabled)

pub async fn is_connected(&self) -> bool

Check if the client is connected to WebSocket

pub async fn has_handlers(&self) -> bool

Check if any event handlers are registered

pub async fn connect_with_timeout( &self, channel_name: &str, timeout: Duration, ) -> Result<()>

Connect to a channel with timeout

Trait Implementations

impl Clone for WebSocketManager

fn clone(&self) -> WebSocketManager

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for WebSocketManager

fn default() -> Self

Returns the “default value” for a type.