generic-library/poco
1
0
Fork 0
mirror of https://github.com/pocoproject/poco.git synced 2025-10-29 20:59:45 +01:00
Code Issues Projects Releases Wiki Activity

add note regarding receiveFrame with Poco::Buffer

Browse Source
This commit is contained in:
Günter Obiltschnig
2022-07-03 16:02:45 +02:00
parent 2daf323afc
commit 06718f49c1
1 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
Net/include/Poco/Net/WebSocket.h
View File

@@ -278,6 +278,9 @@ public:
/// after any previous content in buffer. /// after any previous content in buffer.
/// The buffer will be grown as necessary. /// The buffer will be grown as necessary.
/// ///
/// See the note below if you want the received data
/// to be stored at the beginning of the buffer.
///
/// The frame's payload size must not exceed the /// The frame's payload size must not exceed the
/// maximum payload size set with setMaxPayloadSize(). /// maximum payload size set with setMaxPayloadSize().
/// If it does, a WebSocketException (WS_ERR_PAYLOAD_TOO_BIG) /// If it does, a WebSocketException (WS_ERR_PAYLOAD_TOO_BIG)
@@ -304,6 +307,13 @@ public:
/// ///
/// The frame flags and opcode (FrameFlags and FrameOpcodes) /// The frame flags and opcode (FrameFlags and FrameOpcodes)
/// is stored in flags. /// is stored in flags.
///
/// Note: Since the data received from the WebSocket is appended
/// to the given Poco::Buffer, the buffer passed to this method
/// should be created with a size of 0, or resize(0) should be
/// called on the buffer beforehand, if the expectation is that
/// the received data is stored starting at the beginning of the
/// buffer.
Mode mode() const; Mode mode() const;
/// Returns WS_SERVER if the WebSocket is a server-side /// Returns WS_SERVER if the WebSocket is a server-side