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]
fn token(&self) -> Token
A Token identifying this sender within the WebSocket.
fn send<M>(&self, msg: M) -> Result<()> where M: Into<Message>
Send a message over the connection.
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.
fn close(&self, code: CloseCode) -> Result<()>
Send a close code to the other endpoint.
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.
fn ping(&self, data: Vec<u8>) -> Result<()>
Send a ping to the other endpoint with the given test data.
fn pong(&self, data: Vec<u8>) -> Result<()>
Send a pong to the other endpoint responding with the given test data.
fn connect(&self, url: Url) -> Result<()>
Queue a new connection on this WebSocket to the specified URL.
fn shutdown(&self) -> Result<()>
Request that all connections terminate and that the WebSocket stop running.
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
fn cancel(&self, timeout: Timeout) -> Result<()>
Queue the cancellation of a previously scheduled timeout.
This method is not guaranteed to prevent the timeout from occuring, because it is possible to call this method after a timeout has already occured. It is still necessary to handle spurious timeouts.
Trait Implementations
impl Clone for Sender
[src]
fn clone(&self) -> Sender
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0
Performs copy-assignment from source
. Read more