diff options
author | Daniel Willmann <dwillmann@sysmocom.de> | 2023-06-15 21:59:41 +0200 |
---|---|---|
committer | Daniel Willmann <dwillmann@sysmocom.de> | 2023-06-15 22:07:21 +0200 |
commit | b59825440b1d0882d34d76ff8a82d06c5985e7de (patch) | |
tree | 970c03e1aff15cfcbf0fcd1617c91e3b3af8f286 | |
parent | b08309a89088d605b8add26139a01158b84218b8 (diff) |
stream: Document osmo_stream_cli_create2()
Change-Id: I0c2f46e02d94c3459e4043a9db7fccd906521dd2
-rw-r--r-- | src/stream.c | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/src/stream.c b/src/stream.c index b6ef92f..d46bc78 100644 --- a/src/stream.c +++ b/src/stream.c @@ -616,7 +616,13 @@ static struct osmo_io_ops osmo_stream_cli_ioops = { .segmentation_cb = NULL, }; - +/*! \brief Create an Osmocom stream client + * \param[in] ctx talloc context from which to allocate memory + * This function allocates a new \ref osmo_stream_cli and initializes + * it with default values (5s reconnect timer, TCP protocol) + * \param[in] name a description of the stream client. Will be used in logging + * \return allocated stream client, or NULL in case of error + */ struct osmo_stream_cli *osmo_stream_cli_create2(void *ctx, const char *name) { struct osmo_stream_cli *cli; |