[Spice-devel] [PATCH spice-server] Add a comment to red_channel_client_init_send_data

[Frediano Ziglio]

Signed-off-by: Frediano Ziglio <fziglio at redhat.com>
---
 server/red-channel-client.h | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/server/red-channel-client.h b/server/red-channel-client.h
index 94b4f58..93d0315 100644
--- a/server/red-channel-client.h
+++ b/server/red-channel-client.h
@@ -89,6 +89,9 @@ void red_channel_client_shutdown(RedChannelClient *rcc);
 int red_channel_client_handle_message(RedChannelClient *rcc, uint32_t size,
                                       uint16_t type, void *message);
 /* when preparing send_data: should call init and then use marshaller */
+/* item is retained as long as the message is sent to the client,
+ * this is used for instance to make sure an attached data referenced
+ * by the marshaller is still valid when data are used */
 void red_channel_client_init_send_data(RedChannelClient *rcc, uint16_t msg_type, RedPipeItem *item);
 
 uint64_t red_channel_client_get_message_serial(RedChannelClient *channel);
-- 
2.9.3