aboutsummaryrefslogtreecommitdiff
path: root/src/net.cpp
diff options
context:
space:
mode:
authorTroy Giorshev <troygiorshev@gmail.com>2020-05-26 16:01:03 -0400
committerTroy Giorshev <troygiorshev@gmail.com>2020-09-22 22:01:14 -0400
commit1ca20c1af8f08f07c407c3183c37b467ddf0f413 (patch)
tree770e717fe9e13eddbcf7579413717ab964db3206 /src/net.cpp
parent890b1d7c2b8312d41d048d2db124586c5dbc8a49 (diff)
Add doxygen comment for ReceiveMsgBytes
Diffstat (limited to 'src/net.cpp')
-rw-r--r--src/net.cpp10
1 files changed, 10 insertions, 0 deletions
diff --git a/src/net.cpp b/src/net.cpp
index 3e015a6810..fdb76d3b83 100644
--- a/src/net.cpp
+++ b/src/net.cpp
@@ -585,6 +585,16 @@ void CNode::copyStats(CNodeStats &stats, const std::vector<bool> &m_asmap)
}
#undef X
+/**
+ * Receive bytes from the buffer and deserialize them into messages.
+ *
+ * @param[in] pch A pointer to the raw data
+ * @param[in] nBytes Size of the data
+ * @param[out] complete Set True if at least one message has been
+ * deserialized and is ready to be processed
+ * @return True if the peer should stay connected,
+ * False if the peer should be disconnected from.
+ */
bool CNode::ReceiveMsgBytes(const char *pch, unsigned int nBytes, bool& complete)
{
complete = false;