feat: websocket crate #28
Conversation
heilhead
force-pushed
the
feat/websocket
branch
2 times, most recently
from
fb816d2 to
96ae206
Compare
heilhead
force-pushed
the
feat/websocket
branch
from
96ae206 to
461187c
Compare
heilhead
requested review from
chris13524,
geekbrother,
mario-reown and
xDarksome
| /// | ||
| /// The only two useful implementations for consumers are [`BinaryMessage`] | ||
| /// and [`TextMessage`]. | ||
| pub trait MessageCodec { |
There was a problem hiding this comment.
Why do we need both DataCodec and MessageCodec?
There was a problem hiding this comment.
It's not that we need it as a separate trait, but I like having it to simplify consumer implementations, and for composability in general.
There's only two MessageCodec implementations that would ever be used in practice - BinaryMessage and TextMessage.
| /// Set the [`Adapter`] for the WebSocket. | ||
| pub fn adapter<T>(self, adapter: T) -> Builder<T, C, O> | ||
| where | ||
| T: Adapter, |
There was a problem hiding this comment.
websocket::Adapter doesn't seem to represent what it actually is, as it's implemented for different external websocket implementations.
Transport maybe? or Backend?
There was a problem hiding this comment.
I don't like Transport, as it's too generic, and would prefer to leave it for a trait e.g. trait Transport: Sink<...> + Stream<...> {}. As for Backend vs Adapter I'm not really sure if one is better than the other. But I don't mind renaming it to Backend.
Any other options to consider?
Description
Resolves WCN2-110.
Adds
wc_websocketcrate with serialization, heartbeat (keep-alive) support, idle timeout (detect disconnects), and observer support for integrating with metrics etc. Includes adapters forwarp,axumandtungstenite.The
ObserverandDataCodecinterfaces are designed around the primary use case (server side of the Relay) to be able to integrate various inbound, outbound and latency metrics.How Has This Been Tested?
Tests covering serialization, transport disconnect, message codecs, heartbeats and timeouts.
Due Diligence