summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* ipcpd: Don't bind from the IPCPDimitri Staessens2017-11-291-3/+6
| | | | | | | | | | The binding of the normal IPCP to its name is moved from the source code to the irm tool introducing the "autobind" option for the bootstrap and enroll commands. With this option, the IPCP will be bound to the IPCP name and the DIF name automatically. Signed-off-by: Dimitri Staessens <dimitri.staessens@ugent.be> Signed-off-by: Sander Vrijders <sander.vrijders@ugent.be>
* dev: Split nonblocking read and writeDimitri Staessens2017-10-301-1/+5
| | | | | | | | | | The FLOWFNONBLOCK flag now has two subflags FLOWFRNOBLOCK and FLOWFWNOBLOCK which allows setting the behavior of read and write independently. The default behavior is unchanged (blocking read and write). Signed-off-by: Dimitri Staessens <dimitri.staessens@ugent.be> Signed-off-by: Sander Vrijders <sander.vrijders@ugent.be>
* doc: Fix documentation issues0.7dimitri staessens2017-10-172-7/+4
| | | | | | | | Removed a self-reference in ouroboros-tutorial. Fixes some style issues in ouroboros(8). Signed-off-by: dimitri staessens <dimitri.staessens@ugent.be> Signed-off-by: Sander Vrijders <sander.vrijders@ugent.be>
* doc: Add general documentationdimitri staessens2017-10-1711-27/+645
| | | | | | | | | This adds user documentation for the Ouroboros User Manual in man sections 7 and 8. It consists of a general man page, a tutorial and a glossary. It also fixes and updates other manpages in the Ouroboros Programmer's Manual.
* lib: Deprecate ouroboros_init and ourboros_finidimitri staessens2017-10-148-79/+6
| | | | | | | | | | | | | | This commit deprecates ouroboros_init and ouroboros_fini and adds them as a constructor or destructor, causing these function to be run automatically when a program that links to the library calls and exits main(). For this to fully work, the library had to be split so that we can avoid the irmd calling these functions (the IRMd has to create the shm structures on which these calls depend). The library is split in 3 parts: libouroboros-dev, libouroboros-irm and libouroboros-common. The latter is linked to the other two so that including libouroboros-dev or libouroboros-irm will also link libouroboros-common.
* doc: man: Update fccntl manpageSander Vrijders2017-09-191-0/+2
| | | | | The option to mark a flow as down was missing from the manpage of fccntl.
* ipcpd, lib: Add flow down eventsSander Vrijders2017-09-191-0/+3
| | | | | | | | This adds the flow down event to Ouroboros. In the shim-eth-llc, a netlink socket is opened which listens to device up/down events. For each event the flow is then adjusted with fccntl to notify the user the flow is down or back up again. In the normal IPCP an event is thrown if a write reports that the flow is down.
* lib: Add fccntl configuration commanddimitri staessens2017-08-313-2/+120
| | | | | | | This replaces the flow_set_* commands with a single fccntl command that can configure flows and the FRCT instance. For more details, see "man 3 fccntl".
* dev: Revise fqueue API and add man pagesdimitri staessens2017-08-2914-1/+234
|
* build: Revise the build systemdimitri staessens2017-08-211-0/+2
| | | | | | | | | | This revises the build system to have configuration per system component. System settings can now be set using cmake. The standard compliance defines were removed from configuration header and are set in the sources where needed. Also some small code refactors, such as moving the data for shims out of the ipcp structure to the respective shims were performed.
* include, lib: Rename ap_init/ap_finidimitri staessens2017-04-136-71/+74
| | | | Fixes #35
* build: Install manpagesSander Vrijders2017-04-122-0/+41
| | | | | | This will install the manpages found in doc/man/ during installation. Fixes #38
* doc: Add man pages for ap_init/ap_finidimitri staessens2017-04-112-0/+68
|
* doc: Add man page for flow_read and flow_writedimitri staessens2017-04-102-0/+75
|
* doc: Add man pages for flow_allocationdimitri staessens2017-04-103-0/+118
| | | | | | | This commit contains only the sources, correct installation requires gzip and copying the files to /usr/local/man/man3/flow_alloc.3.gz. We need to have a look at integrating this in the build system in an efficient way.
* doc: fixed example code in workflow docDimitri Staessens2016-02-261-2/+2
|
* doc: workflow updated for consistencyDimitri Staessens2016-02-261-6/+2
|
* doc: updated workflow and corrected all mallocsDimitri Staessens2016-02-261-3/+11
| | | | lib/du_buff contained casted malloc's.
* workflow: Update guidelines on use of pointersDimitri Staessens2016-02-261-0/+8
| | | | | the void * returned by malloc should not be explicitly cast when checking pointers for validity, only use (ptr == NULL)
* Updated FRCT descriptionDimitri Staessens2016-02-121-10/+9
| | | | Updated the description for the Flow and Retransmission Control Task.
* doc: Remove trailing whitespacesSander Vrijders2016-02-112-8/+6
| | | | | Removes some trailing whitespace from the documentation. My editor was setup incorrectly (new laptop).
* doc: Initial high-level architectureSander Vrijders2016-02-112-0/+329
| | | | | This adds the initial high-level architecture (HLA) document. It outlines the design decisions taken for the Ouroboros prototype.
* doc: Initial workflow documentSander Vrijders2016-02-111-0/+118
This adds the initial workflow document that contains the guidelines on how to contribute to the Ouroboros prototype.
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-01 17:56:17 +0000