mike-jumper commented on a change in pull request #312:
URL: https://github.com/apache/guacamole-server/pull/312#discussion_r518995032
##########
File path: src/protocols/rdp/channels/audio-input/audio-buffer.h
##########
@@ -273,5 +310,10 @@ void guac_rdp_audio_buffer_end(guac_rdp_audio_buffer*
audio_buffer);
*/
void guac_rdp_audio_buffer_free(guac_rdp_audio_buffer* audio_buffer);
+/**
+ * This thread handler sends the audio input stream data to the remote server.
+ */
+void* guac_rdp_audio_send_thread(void* data);
Review comment:
The parameter and return value need to be documented here.
Also, as mentioned in the earlier review regarding code comments, the
documentation describing this function should also capture the high-level use.
In this case, the fact that the thread will flush data at a regular, constant
rate, and that this rate is intended to prevent the remote audio buffer from
running out of space seems like it would be good to note here. Lacking that
information, it is unclear why a timed and threaded approach is needed, and
future changes may well revert this in an attempt to make things more efficient
without realizing the consequences.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
