Proxmox/proxmox
5
0
Fork 1
Code Issues Pull Requests Releases Activity

proxmox-http: websocket: fix comment about callback

Browse Source 
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>
This commit is contained in:
Dominik Csapak 2022-02-04 10:52:40 +01:00 committed by Thomas Lamprecht
parent 138f32e360
commit 4826ff99d8
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
proxmox-http/src/websocket/mod.rs
View File

@ -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,