1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
//! Integration with yew `0.23.x`.
//!
//! [`Callback`] can be used wherever this crate takes a callback, and the
//! [`ws::Handle`] of a service can be provided to every component in an
//! application.
//!
//! # Providing the handle
//!
//! Build and connect the [`ws::Service`] in the root component and keep it for
//! as long as the application runs. Wrap the component tree in a
//! [`HandleProvider`] with its handle, and the components below it can get the
//! handle without it being passed through their properties:
//!
//! * [`use_handle`] gets the handle in a function component.
//! * [`use_request`] keeps a [`ws::Request`] for as long as the component is
//! mounted, cancelling the previous one when a new one is stored.
//! * [`use_requests`] keeps any number of [`ws::Request`]s in flight at once,
//! and [`use_keyed_requests`] keeps at most one for each key.
//! * [`use_channel`] opens a [`ws::Channel`] for as long as the component is
//! mounted, and renders the component again whenever it opens or closes.
//! * [`use_open`] follows whether the connection is open, so that what a
//! component shows can be fetched again after a reconnect.
//! * [`ContextExt::handle`] gets the handle in a struct component.
//!
//! The hooks and [`ContextExt::handle`] panic with a message naming
//! [`HandleProvider`] if the component is not below one.
//!
//! [`Callback`]: yew023::Callback
//! [`ws::Handle`]: crate::web::Handle
//! [`ws::Service`]: crate::web::Service
//! [`ws::Request`]: crate::web::Request
//! [`ws::Channel`]: crate::web::Channel
//!
//! ```
//! # extern crate yew023 as yew;
//! use yew::prelude::*;
//! use musli_web::web03::prelude::*;
//! use musli_web::yew023::{HandleProvider, use_handle, use_open};
//!
//! #[function_component(App)]
//! fn app() -> Html {
//! // The service is built once and kept for as long as the app runs.
//! let service = use_memo((), |_| {
//! let service = ws::connect(ws::Connect::location("ws"))
//! .on_error(|error| tracing::error!("WebSocket error: {error}"))
//! .build();
//!
//! service.connect();
//! service
//! });
//!
//! html! {
//! <HandleProvider context={service.handle().clone()}>
//! <Status />
//! </HandleProvider>
//! }
//! }
//!
//! #[function_component(Status)]
//! fn status() -> Html {
//! let handle = use_handle();
//! let open = use_open();
//!
//! match open {
//! Some(generation) => html!(<p>{format!("Connection #{generation} uses {:?}", handle.format())}</p>),
//! None => html!(<p>{"Disconnected"}</p>),
//! }
//! }
//! ```
//!
//! # Struct components
//!
//! This example uses [`yew023`] with a struct component which owns the
//! service itself:
//!
//! [`yew023`]: crate::yew023
//!
//! ```
//! # extern crate yew023 as yew;
//! # extern crate web_sys03 as web_sys;
//! use web_sys::HtmlInputElement;
//! use yew::prelude::*;
//! use musli_web::web03::prelude::*;
//!
//! mod api {
//! use musli::{Decode, Encode};
//! use musli_web::api;
//!
//! #[derive(Encode, Decode)]
//! pub struct HelloRequest<'de> {
//! pub message: &'de str,
//! }
//!
//! #[derive(Encode, Decode)]
//! pub struct HelloResponse<'de> {
//! pub message: &'de str,
//! }
//!
//! #[derive(Encode, Decode)]
//! pub struct TickEvent<'de> {
//! pub message: &'de str,
//! pub tick: u32,
//! }
//!
//! api::define! {
//! pub type Hello;
//!
//! impl Endpoint for Hello {
//! impl<'de> Request for HelloRequest<'de>;
//! type Response<'de> = HelloResponse<'de>;
//! }
//!
//! pub type Tick;
//!
//! impl Broadcast for Tick {
//! impl<'de> Event for TickEvent<'de>;
//! }
//! }
//! }
//!
//! enum Msg {
//! Error(ws::Error),
//! Change(String),
//! Send,
//! HelloResponse(Result<ws::Packet<api::Hello>, ws::Error>),
//! Tick(Result<ws::Packet<api::Tick>, ws::Error>),
//! }
//!
//! struct App {
//! service: ws::Service,
//! _listen: ws::Listener,
//! request: ws::Request,
//! text: String,
//! tick: u32,
//! responses: Vec<String>,
//! }
//!
//! impl Component for App {
//! type Message = Msg;
//! type Properties = ();
//!
//! fn create(ctx: &Context<Self>) -> Self {
//! let service = ws::connect(ws::Connect::location("ws"))
//! .on_error(ctx.link().callback(Msg::Error))
//! .build();
//!
//! service.connect();
//!
//! let listen = service.handle().on_broadcast(ctx.link().callback(Msg::Tick));
//!
//! Self {
//! service,
//! _listen: listen,
//! request: ws::Request::new(),
//! text: String::new(),
//! tick: 0,
//! responses: Vec::new(),
//! }
//! }
//!
//! fn update(&mut self, ctx: &Context<Self>, msg: Self::Message) -> bool {
//! match msg {
//! Msg::Error(error) => {
//! tracing::error!("WebSocket error: {:?}", error);
//! false
//! }
//! Msg::Change(text) => {
//! self.text = text;
//! true
//! }
//! Msg::Send => {
//! self.request = self
//! .service
//! .handle()
//! .request()
//! .body(api::HelloRequest {
//! message: self.text.as_str(),
//! })
//! .on_packet(ctx.link().callback(Msg::HelloResponse))
//! .send();
//!
//! self.text.clear();
//! true
//! }
//! Msg::HelloResponse(Err(error)) => {
//! tracing::error!("Request error: {:?}", error);
//! false
//! }
//! Msg::HelloResponse(Ok(packet)) => {
//! tracing::debug!("Got response");
//!
//! while !packet.is_empty() {
//! let Ok(response) = packet.decode() else {
//! break;
//! };
//!
//! self.responses.push(response.message.to_owned());
//! }
//!
//! true
//! }
//! Msg::Tick(Err(error)) => {
//! tracing::error!("Tick error: {error}");
//! false
//! }
//! Msg::Tick(Ok(packet)) => {
//! tracing::debug!("Got tick");
//!
//! if let Ok(tick) = packet.decode_event() {
//! self.tick = tick.tick;
//! }
//!
//! true
//! }
//! }
//! }
//!
//! fn view(&self, ctx: &Context<Self>) -> Html {
//! let oninput = ctx.link().callback(|e: InputEvent| {
//! let input = e.target_unchecked_into::<HtmlInputElement>();
//! Msg::Change(input.value())
//! });
//!
//! let onclick = ctx.link().callback(|_: MouseEvent| {
//! Msg::Send
//! });
//!
//! html! {
//! <div class="container">
//! <input type="text" {oninput} value={self.text.clone()} />
//! <button {onclick}>{"Send Message"}</button>
//! {for self.responses.iter().enumerate().map(|(index, response)| html!(<div>{format!("Response #{index}: {response}")}</div>))}
//! <div>{format!("Global tick: {}", self.tick)}</div>
//! </div>
//! }
//! }
//! }
//! ```
yew_impl!;