Struct in_stream::InStreamWss

pub struct InStreamWss<Sub: InStreamStd> { /* fields omitted */ }

websocket stream

Implementations

impl<Sub: InStreamStd> InStreamWss<Sub>

pub fn connect(url: &Url2, config: WssConnectConfig) -> Result<Self>

Trait Implementations

impl<Sub: Debug + InStreamStd> Debug for InStreamWss<Sub>

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

Formats the value using the given formatter.

impl<Sub: InStreamStd, '_> InStream<&'_ mut WsFrame, WsFrame> for InStreamWss<Sub>

const URL_SCHEME: &'static str

your implementation should work with a single url scheme/protocol if you need to support multiple (i.e. ws:// vs wss://) consider using macros/code generation to DRY

fn raw_connect<C: InStreamConfig>(url: &Url2, config: C) -> Result<Self>

create a new connection / stream of this type. this function does the actual work of connecting, but it is recommended your struct provide a wrapper with a concrete config type

fn check_ready(&mut self) -> Result<bool>

process the stream to see if any remaining handshake items can be completed returns true if stream is set-up and ready to send/receive note that you can write before this function returns true but your messages may be buffered / sent later

fn remote_url(&self) -> Url2

access the remote url this connection represents

fn read(&mut self, data: &mut WsFrame) -> Result<usize>

non-blocking read. if R is an array-type, success result is number of elements read otherwise it is 1

fn write(&mut self, data: WsFrame) -> Result<usize>

buffered write. Implementors should buffer data on WouldBlock

fn flush(&mut self) -> Result<()>

blocking flush all pending buffered write data.