diff options
Diffstat (limited to 'doc/man')
-rw-r--r-- | doc/man/fccntl.3 | 16 | ||||
-rw-r--r-- | doc/man/flow_alloc.3 | 4 | ||||
-rw-r--r-- | doc/man/ouroboros-tutorial.7 | 20 |
3 files changed, 17 insertions, 23 deletions
diff --git a/doc/man/fccntl.3 b/doc/man/fccntl.3 index 543a6bb6..a738a8f0 100644 --- a/doc/man/fccntl.3 +++ b/doc/man/fccntl.3 @@ -2,7 +2,7 @@ .\" Dimitri Staessens <[email protected]> .\" Sander Vrijders <[email protected]> -.TH FCCNTL 3 2018-02-28 Ouroboros "Ouroboros Programmer's Manual" +.TH FCCNTL 3 2018-10-04 Ouroboros "Ouroboros Programmer's Manual" .SH NAME @@ -73,22 +73,16 @@ buffer. Takes a \fBsize_t \fIqlen\fR as third argument. \fBFLOWGTXQLEN\fR - get the current number of packets in the transmit buffer. Takes a \fBsize_t \fIqlen\fR as third argument. -\fBFRCTSFLAGS\fR - set FRCT flags. Takes FRCT flags as third -argument. Supported flags are: +\fBFRCTGFLAGS\fR - get the current flow flags. Takes an \fBuint16_t +\fIflags\fR as third argument. Supported flags are: .RS 8 -\fIFRCTFRESCNTRL\fR - enable resource control. - -\fIFRCTFRTX\fR - enable retransmission. +\fIFRCTFRESCNTRL\fR - resource control enabled. -\fIFRCTFERRCHCK\fR - enable checksum (CRC32). - -\fIFRCTFPARTIAL\fR - enable partial delivery. +\fIFRCTFRTX\fR - retransmission enabled. .RE -\fBFRCTGFLAGS\fR - get the current flow flags. Takes an \fBuint16_t -\fIflags\fR as third argument. .SH RETURN VALUE diff --git a/doc/man/flow_alloc.3 b/doc/man/flow_alloc.3 index dda0c877..8a21eda8 100644 --- a/doc/man/flow_alloc.3 +++ b/doc/man/flow_alloc.3 @@ -2,7 +2,7 @@ .\" Dimitri Staessens <[email protected]> .\" Sander Vrijders <[email protected]> -.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 @@ -80,7 +80,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. diff --git a/doc/man/ouroboros-tutorial.7 b/doc/man/ouroboros-tutorial.7 index 98e27254..b7a22208 100644 --- a/doc/man/ouroboros-tutorial.7 +++ b/doc/man/ouroboros-tutorial.7 @@ -2,7 +2,7 @@ .\" Dimitri Staessens <[email protected]> .\" Sander Vrijders <[email protected]> -.TH OUROBOROS-TUTORIAL 7 2017-12-02 Ouroboros "Ouroboros User Manual" +.TH OUROBOROS-TUTORIAL 7 2018-10-05 Ouroboros "Ouroboros User Manual" .SH NAME @@ -108,31 +108,31 @@ Pinging my.oping.server with 64 bytes of data: --- my.oping.server ping statistics --- .br -3 SDUs transmitted, 3 received, 0% packet loss, time: 3001.011 ms +3 packets transmitted, 3 received, 0% packet loss, time: 3001.011 ms .br rtt min/avg/max/mdev = 0.304/0.392/0.475/0.086 ms .RE That's all there is to it! The IRMd should log the flow -allocation. There are two endpoints of the flow (port_id's 0 and 1), +allocation. There are two endpoints of the flow (flow_id's 0 and 1), one for the server (1) and one for the client (0). After the flow -request, a new port_id is created at the server side (port_id 1) and -then a previously pending flow (on port_id 0) is allocated following +request, a new flow_id is created at the server side (flow_id 1) and +then a previously pending flow (on flow_id 0) is allocated following the response from the server. When the communication is done, the flow is deallocated and the -resources (port_id's 0 and 1) are released. +resources (flow_id's 0 and 1) are released. .RS 4 ==23918== irmd(II): Flow request arrived for my.oping.server. .br -==23918== irmd(II): Flow on port_id 1 allocated. +==23918== irmd(II): Flow on flow_id 1 allocated. .br -==23918== irmd(II): Flow on port_id 0 allocated. +==23918== irmd(II): Flow on flow_id 0 allocated. .br -==23918== irmd(II): Completed deallocation of port_id 0 by process 23932. +==23918== irmd(II): Completed deallocation of flow_id 0 by process 23932. .br -==23918== irmd(II): Completed deallocation of port_id 1 by process 23932. +==23918== irmd(II): Completed deallocation of flow_id 1 by process 23932. .RE .SH TERMINOLOGY |