summaryrefslogtreecommitdiff
path: root/doc/man
diff options
context:
space:
mode:
authorDimitri Staessens <[email protected]>2017-12-02 14:01:03 +0100
committerSander Vrijders <[email protected]>2017-12-02 14:56:20 +0100
commit9b8a3e11c558877c09416991ff1ec840fea6d0ab (patch)
treef2faf7a4ab45687782a010fb6e48829e8ee1bdeb /doc/man
parentf43e5e2329fb798047d15dd0748e5eef3359c966 (diff)
downloadouroboros-9b8a3e11c558877c09416991ff1ec840fea6d0ab.tar.gz
ouroboros-9b8a3e11c558877c09416991ff1ec840fea6d0ab.zip
lib, tools: Rename application process and instance
This refactors ouroboros to use "program" instead of "application process" and "process" instead of "application process instance" to align with current naming in current Operating Systems courses instead of the ISO nomenclature adopted by RINA. This change permeates through the entire implementation. Also contains some minor other refactors. Signed-off-by: Dimitri Staessens <[email protected]> Signed-off-by: Sander Vrijders <[email protected]>
Diffstat (limited to 'doc/man')
-rw-r--r--doc/man/flow_alloc.334
-rw-r--r--doc/man/ouroboros-glossary.712
-rw-r--r--doc/man/ouroboros-tutorial.78
-rw-r--r--doc/man/ouroboros.810
4 files changed, 31 insertions, 33 deletions
diff --git a/doc/man/flow_alloc.3 b/doc/man/flow_alloc.3
index cc505df6..1b3c232c 100644
--- a/doc/man/flow_alloc.3
+++ b/doc/man/flow_alloc.3
@@ -2,13 +2,12 @@
.\" Dimitri Staessens <[email protected]>
.\" Sander Vrijders <[email protected]>
-.TH FLOW_ALLOC 3 2017-04-10 Ouroboros "Ouroboros Programmer's Manual"
+.TH FLOW_ALLOC 3 2017-12-02 Ouroboros "Ouroboros Programmer's Manual"
.SH NAME
flow_accept, flow_alloc, flow_dealloc \- allocate and free resources
-to support Inter-Process Communication between application process
-instances
+to support Inter-Process Communication
.SH SYNOPSIS
@@ -31,24 +30,23 @@ to support Inter-Process Communication (IPC). Such a collection of
allocated system and network resources is referred to as a flow. A
flow has a certain Quality of Service (QoS) associated with it.
-The \fBflow_accept\fR() function blocks the calling thread waiting
-for an incoming request to allocate a flow. If \fBqosspec_t * \fIqs\fR
-is not NULL, the value of \fIqs\fR will be updated to reflect the
-actual QoS provided by the IPC facility for the accepted flow. Which
-flows this application will accept is configured outside of the
-program. For an explanation on configuring which flows an application
-should accept, see \fBirm\fR(8).
+The \fBflow_accept\fR() function blocks the calling thread waiting for
+an incoming request to allocate a flow. If \fBqosspec_t * \fIqs\fR is
+not NULL, the value of \fIqs\fR will be updated to reflect the actual
+QoS provided by the IPC facility for the accepted flow. Which flows
+this process will accept is configured through the IRMd. For an
+explanation on configuring which flows an application should accept,
+see \fBirm\fR(8).
The \fBflow_alloc\fR() function requests to allocate system and/or
network resources to support Inter-Process Communication between the
-calling application and one or more application process instances
-accepting flows for \fBchar * \fIdst_name\fR, which cannot be NULL.
-The \fBflow_alloc\fR() call can specify a certain minimum \fBqosspec_t
-* \fIqs\fR that has to be guaranteed by the IPC facility allocating
-the resources. This can be NULL if there is no QoS to be guaranteed
-(best effort service). If \fIqs\fR is not NULL, the value of \fIqs\fR
-will be updated to reflect the actual QoS provided by the IPC
-facility.
+calling application and one or more processes accepting flows for
+\fBchar * \fIdst_name\fR, which cannot be NULL. The
+\fBflow_alloc\fR() call can specify a certain minimum \fBqosspec_t *
+\fIqs\fR that has to be guaranteed by the IPC facility allocating the
+resources. This can be NULL if there is no QoS to be guaranteed (best
+effort service). If \fIqs\fR is not NULL, the value of \fIqs\fR will
+be updated to reflect the actual QoS provided by the IPC facility.
The \fBflow_accept\fR() and \fBflow_alloc\fR() take a \fBconst struct
timespec * \fItimeo\fR to specify a timeout. If \fItimeo\fR is NULL,
diff --git a/doc/man/ouroboros-glossary.7 b/doc/man/ouroboros-glossary.7
index cb397c76..5f9425f6 100644
--- a/doc/man/ouroboros-glossary.7
+++ b/doc/man/ouroboros-glossary.7
@@ -2,7 +2,7 @@
.\" Dimitri Staessens <[email protected]>
.\" Sander Vrijders <[email protected]>
-.TH OUROBOROS-GLOSSARY 7 2017-10-15 Ouroboros "Ouroboros User Manual"
+.TH OUROBOROS-GLOSSARY 7 2017-12-02 Ouroboros "Ouroboros User Manual"
.SH NAME
@@ -65,11 +65,11 @@ that DIF.
.PP
flow
.RS 4
-the system and network resources over which two application processes
-can send information. A flow is an abstraction of the actual
-underlying IPC mechanism and has a quality of service (QoS) associated
-with it, which reflects externally measurable quantities such as
-delay, jitter, bandwidth, loss and bit error rate.
+the system and network resources over which two processes can send
+information. A flow is an abstraction of the actual underlying IPC
+mechanism and has a quality of service (QoS) associated with it, which
+reflects externally measurable quantities such as delay, jitter,
+bandwidth, loss and bit error rate.
.RE
.PP
diff --git a/doc/man/ouroboros-tutorial.7 b/doc/man/ouroboros-tutorial.7
index 792b3056..8e135e23 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-10-15 Ouroboros "Ouroboros User Manual"
+.TH OUROBOROS-TUTORIAL 7 2017-12-02 Ouroboros "Ouroboros User Manual"
.SH NAME
@@ -89,7 +89,7 @@ $ oping -l &
.br
[1] 24063
.br
-$ irm bind api 24063 name my.oping.server
+$ irm bind process 24063 name my.oping.server
.RE
With the server up and running, let's connect a client and send 3
@@ -130,9 +130,9 @@ resources (port_id's 0 and 1) are released.
.br
==23918== irmd(II): Flow on port_id 0 allocated.
.br
-==23918== irmd(II): Completed deallocation of port_id 0 by AP-I 23932.
+==23918== irmd(II): Completed deallocation of port_id 0 by process 23932.
.br
-==23918== irmd(II): Completed deallocation of port_id 1 by AP-I 23932.
+==23918== irmd(II): Completed deallocation of port_id 1 by process 23932.
.RE
.SH TERMINOLOGY
diff --git a/doc/man/ouroboros.8 b/doc/man/ouroboros.8
index 394625fa..634eb3f7 100644
--- a/doc/man/ouroboros.8
+++ b/doc/man/ouroboros.8
@@ -2,7 +2,7 @@
.\" Dimitri Staessens <[email protected]>
.\" Sander Vrijders <[email protected]>
-.TH OUROBOROS 8 2017-10-15 Ouroboros "Ouroboros User Manual"
+.TH OUROBOROS 8 2017-12-02 Ouroboros "Ouroboros User Manual"
.SH NAME
@@ -233,7 +233,7 @@ same DIF.
.SH IRM COMMANDS
.PP
-\fBirm bind\fR ap \fiprogram\fR name \fIname\fR [[\fIauto\fR] -- \
+\fBirm bind\fR program \fiprogram\fR name \fIname\fR [[\fIauto\fR] -- \
[\fIparam\fR] [\fIparam\fR] ... [\fIparam\fR]]
.RS 4
bind a program \fIprogram\fR, referenced by its binary, to a certain
@@ -248,7 +248,7 @@ application when it is started.
.RE
.PP
-\fBirm bind\fR api \fIpid\fR name \fIname\fR
+\fBirm bind\fR process \fIpid\fR name \fIname\fR
.RS 4
bind a process \fIpid\fR to a certain name. If \fIname\fR is registered
in a DIF, the process \fIpid\fR will accept flows for that name.
@@ -263,7 +263,7 @@ shorthand for binding the pid of \fipcp\fR.
.RE
.PP
-\fBirm unbind\fR ap \fIprogram\fR name \fIname\fR
+\fBirm unbind\fR program \fIprogram\fR name \fIname\fR
.RS 4
remove the binding between \fIprogram\fR and \fIname\fR. Instances of
\fIprogram\fR will not accept future flow allocation requests for
@@ -271,7 +271,7 @@ remove the binding between \fIprogram\fR and \fIname\fR. Instances of
.RE
.PP
-\fBirm unbind\fR api \fIpid\fR name \fIname\fR
+\fBirm unbind\fR process \fIpid\fR name \fIname\fR
.RS 4
remove the binding between \fIpid\fR and \fIname\fR. The process
\fIpid\fR will not accept future flow allocation requests for