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]

[src]

A Token identifying this sender within the WebSocket.

[src]

Send a message over the connection.

[src]

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.

[src]

Send a close code to the other endpoint.

[src]

Send a close code and provide a descriptive reason for closing.

[src]

Send a ping to the other endpoint with the given test data.

[src]

Send a pong to the other endpoint responding with the given test data.

[src]

Queue a new connection on this WebSocket to the specified URL.

[src]

Request that all connections terminate and that the WebSocket stop running.

[src]

Schedule a token to be sent to the WebSocket Handler's on_timeout method after ms milliseconds

[src]

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]

[src]

Returns a copy of the value. Read more

1.0.0
[src]

Performs copy-assignment from source. Read more

impl PartialEq for Sender
[src]

[src]

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0
[src]

This method tests for !=.