Skip to content

Commit

Permalink
add doc for TelegramBuffer::check_telegram_header_presence
Browse files Browse the repository at this point in the history
  • Loading branch information
w0lek committed Jun 7, 2024
1 parent af9541e commit c445d93
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions vpr/src/server/telegrambuffer.h
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,15 @@ class TelegramBuffer
std::vector<std::string> m_errors;
std::optional<TelegramHeader> m_header_opt;

/**
* @brief Checks for the presence of the telegram header in the buffer.
*
* This function searches for the telegram header signature in the raw buffer.
* If the signature is found, any bytes preceding the header start position
* are discarded from the buffer.
*
* @return true if the telegram header signature is found, false otherwise.
*/
bool check_telegram_header_presence();
};

Expand Down

0 comments on commit c445d93

Please sign in to comment.