[pbs-devel] [PATCH proxmox] proxmox-http: websocket: fix comment about callback

[pbs-devel] [PATCH proxmox] proxmox-http: websocket: fix comment about callback

[Dominik Csapak]

this was once a callback in an early version, but it changed to a
channel, but the comment was not updated

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
---
 proxmox-http/src/websocket/mod.rs | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/proxmox-http/src/websocket/mod.rs b/proxmox-http/src/websocket/mod.rs
index 824dc45..551a677 100644
--- a/proxmox-http/src/websocket/mod.rs
+++ b/proxmox-http/src/websocket/mod.rs
@@ -467,7 +467,8 @@ type WebSocketReadResult = Result<(OpCode, Box<[u8]>), WebSocketError>;
 ///
 /// On read, reads the underlying reader and tries to decode the frames and
 /// simply returns the data stream.
-/// When it encounters a control frame, calls the given callback.
+/// When it encounters a control frame, sends it via the given sender
+/// to a channel
 ///
 /// Has an internal Buffer for storing incomplete headers.
 pub struct WebSocketReader<R: AsyncRead> {
@@ -479,7 +480,7 @@ pub struct WebSocketReader<R: AsyncRead> {
 }
 
 impl<R: AsyncRead> WebSocketReader<R> {
-    /// Creates a new WebSocketReader with the given CallBack for control frames
+    /// Creates a new WebSocketReader with the given sender for control frames
     /// and a default buffer size of 4096.
     pub fn new(
         reader: R,
-- 
2.30.2

[pbs-devel] applied: [PATCH proxmox] proxmox-http: websocket: fix comment about callback

[Thomas Lamprecht]

On 04.02.22 10:52, Dominik Csapak wrote:
> this was once a callback in an early version, but it changed to a
> channel, but the comment was not updated
> 
> Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
> ---
>  proxmox-http/src/websocket/mod.rs | 5 +++--
>  1 file changed, 3 insertions(+), 2 deletions(-)
> 
>

applied, thanks! I reworded a few comments in a followup, as some where a bit
hard to grasp, or used the same word relatively often in one sentence.

Also dropped a doc-comment reference of "auto detecing binary/text frame" on
the writer, was probably forgotten when removing that in commit 232d875