diff options
Diffstat (limited to 'doc/man/flow_alloc.3')
| -rw-r--r-- | doc/man/flow_alloc.3 | 26 |
1 files changed, 19 insertions, 7 deletions
diff --git a/doc/man/flow_alloc.3 b/doc/man/flow_alloc.3 index dda0c877..dbe5323c 100644 --- a/doc/man/flow_alloc.3 +++ b/doc/man/flow_alloc.3 @@ -1,8 +1,8 @@ -.\" Ouroboros man pages CC-BY 2017 - 2018 -.\" Dimitri Staessens <dimitri.staessens@ugent.be> -.\" Sander Vrijders <sander.vrijders@ugent.be> +.\" Ouroboros man pages CC-BY 2017 - 2024 +.\" Dimitri Staessens <dimitri@ouroboros.rocks> +.\" Sander Vrijders <sander@ouroboros.rocks> -.TH FLOW_ALLOC 3 2017-12-02 Ouroboros "Ouroboros Programmer's Manual" +.TH FLOW_ALLOC 3 2018-10-05 Ouroboros "Ouroboros Programmer's Manual" .SH NAME @@ -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,8 +55,12 @@ 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. +associated with the flow. This call may block and keep reliable flows +active until all packets are acknowledged. A \fBqosspec_t\fR specifies the following QoS characteristics of a flow: @@ -80,7 +87,7 @@ Failed to contact an IRMd instance. \fBflow_accept\fR() and \fBflow_alloc\fR() can also return .B -EBADF -No more flow desciptors or port_ids available. +No more flow desciptors or flow_ids available. .B -ENOMEM Not enough system memory resources available to allocate the flow. @@ -88,6 +95,9 @@ Not enough system memory resources available to allocate the flow. .B -ETIMEDOUT Flow allocation timed out. +.B -ECRYPT +The requested encryption is not supported. + .SH ATTRIBUTES For an explanation of the terms used in this section, see \fBattributes\fR(7). @@ -102,6 +112,8 @@ _ _ \fBflow_alloc\fR() & Thread safety & MT-Safe _ +\fBflow_join\fR() & Thread safety & MT-Safe +_ \fBflow_dealloc\fR() & Thread safety & MT-Safe .TE @@ -115,7 +127,7 @@ ouroboros (8) .SH COLOPHON This page is part of the Ouroboros project, found at -http://ouroboros.ilabt.imec.be +http://ouroboros.rocks These man pages are licensed under the Creative Commons Attribution 4.0 International License. To view a copy of this license, visit |