From 1301757fa9ec4a942d8a5815c7e79d9146a5ffd8 Mon Sep 17 00:00:00 2001 From: Dimitri Staessens Date: Wed, 16 Jan 2019 12:17:13 +0100 Subject: doc: Update man page for broadcast IPCPs The Ouroboros man page will now include broadcast IPCPs and are updated to reflect the latest API. Signed-off-by: Dimitri Staessens Signed-off-by: Sander Vrijders --- doc/man/flow_alloc.3 | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'doc/man/flow_alloc.3') diff --git a/doc/man/flow_alloc.3 b/doc/man/flow_alloc.3 index 8a21eda8..ecebd98f 100644 --- a/doc/man/flow_alloc.3 +++ b/doc/man/flow_alloc.3 @@ -19,6 +19,9 @@ const struct timespec * \fItimeo\fB); int flow_alloc(const char * \fIdst_name\fB, qosspec_t * \fIqs\fB, const struct timespec * \fItimeo\fB); +int flow_join(const char * \fIdst_name\fB, qosspec_t * \fIqs\fB, const +struct timespec * \fItimeo\fB); + \fBint flow_dealloc(int \fIfd\fB);\fR Compile and link with \fI-louroboros-dev\fR. @@ -52,6 +55,9 @@ The \fBflow_accept\fR() and \fBflow_alloc\fR() take a \fBconst struct timespec * \fItimeo\fR to specify a timeout. If \fItimeo\fR is NULL, the call will block indefinitely or until some error condition occurs. +The \fBflow_join\fR() function allows applications to join a broadcast +flow provided by a broadcast layer. The dst is the layer name. + The \fBflow_dealloc\fR() function will release any resources associated with the flow. @@ -102,6 +108,8 @@ _ _ \fBflow_alloc\fR() & Thread safety & MT-Safe _ +\fBflow_join\fR() & Thread safety & MT-Safe +_ \fBflow_dealloc\fR() & Thread safety & MT-Safe .TE -- cgit v1.2.3