stream: Document osmo_stream_cli_create2()

Change-Id: I0c2f46e02d94c3459e4043a9db7fccd906521dd2
This commit is contained in:
Daniel Willmann 2023-06-15 21:59:41 +02:00
parent b08309a890
commit b59825440b
1 changed files with 7 additions and 1 deletions

View File

@ -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;