neels has submitted this change. ( https://gerrit.osmocom.org/c/libosmo-netif/+/39309?usp=email )

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

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(-)

Approvals: Jenkins Builder: Verified laforge: Looks good to me, but someone else must approve pespin: Looks good to me, but someone else must approve neels: Looks good to me, approved

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