From 6aece4e3881037ec9a2300c53e0dcd0becbf4ae9 Mon Sep 17 00:00:00 2001
From: Damian Korczowski <erdroy2@gmail.com>
Date: Mon, 21 Jun 2021 22:00:09 +0200
Subject: [PATCH] Add note about required message recycle after message-event

---
 Source/Engine/Networking/NetworkEvent.h | 1 +
 Source/Engine/Networking/NetworkPeer.h  | 1 +
 2 files changed, 2 insertions(+)

diff --git a/Source/Engine/Networking/NetworkEvent.h b/Source/Engine/Networking/NetworkEvent.h
index d61bd9ae9..5063fcb01 100644
--- a/Source/Engine/Networking/NetworkEvent.h
+++ b/Source/Engine/Networking/NetworkEvent.h
@@ -52,6 +52,7 @@ public:
 
     /// <summary>
     /// The message when this event is an "message" event - not valid in any other cases.
+    /// If this is an message-event, make sure to return the message using RecycleMessage function of the peer after processing it!
     /// </summary>
     API_FIELD();
     NetworkMessage Message;
diff --git a/Source/Engine/Networking/NetworkPeer.h b/Source/Engine/Networking/NetworkPeer.h
index d66aaf5a1..fc8f0c8b2 100644
--- a/Source/Engine/Networking/NetworkPeer.h
+++ b/Source/Engine/Networking/NetworkPeer.h
@@ -76,6 +76,7 @@ public:
     /// </summary>
     /// <param name="eventRef">The reference to event structure.</param>
     /// <returns>True when succeeded and the event can be processed.</returns>
+    /// <remarks>If this returns message event, make sure to recycle the message using <see cref="RecycleMessage"/> function after processing it!</remarks>
     API_FUNCTION()
     bool PopEvent(API_PARAM(out) NetworkEvent& eventRef);