Added comment about non-blocking behavior

arvidn · May 9, 2020 · 90abe78 · 90abe78
1 parent 351c41d
commit 90abe78
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/include/libtorrent/aux_/utp_stream.hpp b/include/libtorrent/aux_/utp_stream.hpp
@@ -634,7 +634,7 @@ struct utp_socket_impl
 	void do_connect(tcp::endpoint const& ep);
 
 	std::size_t read_some(bool const clear_buffers);
-	std::size_t write_some(bool const clear_buffers);
+	std::size_t write_some(bool const clear_buffers); // Warning: non-blocking
 	int receive_buffer_size() const { return m_receive_buffer_size; }
 
 	bool null_buffers() const { return m_null_buffers; }

diff --git a/src/utp_stream.cpp b/src/utp_stream.cpp
@@ -472,6 +472,8 @@ std::size_t utp_stream::read_some(bool const clear_buffers)
 	return m_impl->read_some(clear_buffers);
 }
 
+// Warning: this is always non-blocking, it only tries to send
+// immediately if there is some space in the congestion window.
 std::size_t utp_stream::write_some(bool const clear_buffers)
 {
 	return m_impl->write_some(clear_buffers);