neels has uploaded this change for review.

View Change

api doc: stream.h: hint at how to select modern vs legacy mode

Change-Id: I651fadb1a00e51f347963418b7a6c5d320580d23
---
M include/osmocom/netif/stream.h
1 file changed, 6 insertions(+), 0 deletions(-)

git pull ssh://gerrit.osmocom.org:29418/libosmo-netif refs/changes/09/39309/1

diff --git a/include/osmocom/netif/stream.h b/include/osmocom/netif/stream.h
index a132a27..f63560a 100644
--- a/include/osmocom/netif/stream.h
+++ b/include/osmocom/netif/stream.h
@@ -32,6 +32,9 @@
  *  For any new applications, you definitely should use the modern mode, as it provides you with a higher
  *  layer of abstraction and allows you to perform efficient I/O using the io_uring backend of osmo_io.
  *
+ *  The modern mode is chosen by invoking osmo_stream_srv_create2().
+ *  The legacy mode is chosen by invoking the older osmo_stream_srv_create().
+ *
  *  The two main objects are osmo_stream_srv_link (main server accept()ing incoming connections) and
  *  osmo_stream_srv (a single given connection from a remote client).
  *
@@ -160,6 +163,9 @@
  *  For any new applications, you definitely should use the modern mode, as it provides you with a higher
  *  layer of abstraction and allows you to perform efficient I/O using the io_uring backend of osmo_io.
  *
+ *  The modern mode is chosen by invoking osmo_stream_cli_set_read_cb2().
+ *  The legacy mode is chosen by invoking the older osmo_stream_cli_set_read_cb().
+ *
  *  A typical usage of osmo_stream_cli would look as follows:
  *
  *  * call osmo_stream_cli_create() to create a new osmo_stream_cli

To view, visit change 39309. To unsubscribe, or for help writing mail filters, visit settings.