Struct ws::Sender [−][src]
pub struct Sender { /* fields omitted */ }A representation of the output of the WebSocket connection. Use this to send messages to the other endpoint.
Methods
impl Sender[src]
impl Senderpub fn token(&self) -> Token[src]
pub fn token(&self) -> TokenA Token identifying this sender within the WebSocket.
pub fn connection_id(&self) -> u32[src]
pub fn connection_id(&self) -> u32A connection_id identifying this sender within the WebSocket.
pub fn send<M>(&self, msg: M) -> Result<()> where
M: Into<Message>, [src]
pub fn send<M>(&self, msg: M) -> Result<()> where
M: Into<Message>, Send a message over the connection.
pub fn broadcast<M>(&self, msg: M) -> Result<()> where
M: Into<Message>, [src]
pub fn broadcast<M>(&self, msg: M) -> Result<()> where
M: Into<Message>, Send a message to the endpoints of all connections.
Be careful with this method. It does not discriminate between client and server connections. If your WebSocket is only functioning as a server, then usage is simple, this method will send a copy of the message to each connected client. However, if you have a WebSocket that is listening for connections and is also connected to another WebSocket, this method will broadcast a copy of the message to all the clients connected and to that WebSocket server.
pub fn close(&self, code: CloseCode) -> Result<()>[src]
pub fn close(&self, code: CloseCode) -> Result<()>Send a close code to the other endpoint.
pub fn close_with_reason<S>(&self, code: CloseCode, reason: S) -> Result<()> where
S: Into<Cow<'static, str>>, [src]
pub fn close_with_reason<S>(&self, code: CloseCode, reason: S) -> Result<()> where
S: Into<Cow<'static, str>>, Send a close code and provide a descriptive reason for closing.
pub fn ping(&self, data: Vec<u8>) -> Result<()>[src]
pub fn ping(&self, data: Vec<u8>) -> Result<()>Send a ping to the other endpoint with the given test data.
pub fn pong(&self, data: Vec<u8>) -> Result<()>[src]
pub fn pong(&self, data: Vec<u8>) -> Result<()>Send a pong to the other endpoint responding with the given test data.
pub fn connect(&self, url: Url) -> Result<()>[src]
pub fn connect(&self, url: Url) -> Result<()>Queue a new connection on this WebSocket to the specified URL.
pub fn shutdown(&self) -> Result<()>[src]
pub fn shutdown(&self) -> Result<()>Request that all connections terminate and that the WebSocket stop running.
pub fn timeout(&self, ms: u64, token: Token) -> Result<()>[src]
pub fn timeout(&self, ms: u64, token: Token) -> Result<()>Schedule a token to be sent to the WebSocket Handler's on_timeout method
after ms milliseconds
pub fn cancel(&self, timeout: Timeout) -> Result<()>[src]
pub fn cancel(&self, timeout: Timeout) -> Result<()>Queue the cancellation of a previously scheduled timeout.
This method is not guaranteed to prevent the timeout from occurring, because it is possible to call this method after a timeout has already occurred. It is still necessary to handle spurious timeouts.
Trait Implementations
impl Clone for Sender[src]
impl Clone for Senderfn clone(&self) -> Sender[src]
fn clone(&self) -> SenderReturns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)1.0.0[src]
fn clone_from(&mut self, source: &Self)Performs copy-assignment from source. Read more
impl Debug for Sender[src]
impl Debug for Senderfn fmt(&self, f: &mut Formatter) -> Result[src]
fn fmt(&self, f: &mut Formatter) -> ResultFormats the value using the given formatter. Read more
impl PartialEq for Sender[src]
impl PartialEq for Sender