diff options
author | Dimitri Staessens <dimitri@ouroboros.rocks> | 2020-03-08 13:29:21 +0100 |
---|---|---|
committer | Sander Vrijders <sander@ouroboros.rocks> | 2020-03-15 14:20:38 +0100 |
commit | c80c93f11dbfb1b0c07f9a6f8b8d91024e5db507 (patch) | |
tree | c6ac06aa8841bcb4a403507deda4401594d5cdbe /doc/man/ouroboros.8 | |
parent | 8796a612f0600fc973aa908b84ded837f3470512 (diff) | |
download | ouroboros-c80c93f11dbfb1b0c07f9a6f8b8d91024e5db507.tar.gz ouroboros-c80c93f11dbfb1b0c07f9a6f8b8d91024e5db507.zip |
irm: Revise naming API
This revises the naming API to treat names (or reg_name in the source)
as first-class citizens of the architecture. This is more in line with
the way they are described in the article.
Operations have been added to create/destroy names independently of
registering. This was previously done only as part of register, and
there was no way to delete a name from the IRMd. The create call now
allows specifying a policy for load-balancing incoming flows for a
name. The default is the new round-robin load-balancer, the previous
behaviour is still available as a spillover load-balancer.
The register calls will still create a name if it doesn't exist, with
the default round-robin load-balancer.
The tools now have a "name" section, so the format is now
irm name <operation> <name> ...
Signed-off-by: Dimitri Staessens <dimitri@ouroboros.rocks>
Signed-off-by: Sander Vrijders <sander@ouroboros.rocks>
Diffstat (limited to 'doc/man/ouroboros.8')
-rw-r--r-- | doc/man/ouroboros.8 | 30 |
1 files changed, 27 insertions, 3 deletions
diff --git a/doc/man/ouroboros.8 b/doc/man/ouroboros.8 index 88efd15b..0958f615 100644 --- a/doc/man/ouroboros.8 +++ b/doc/man/ouroboros.8 @@ -313,7 +313,7 @@ lists IPCPs in the system. You can filter by type, by name or by layer. .RE .RE -.SH IRM COMMANDS +.SH IRM BIND COMMANDS .PP \fBirm bind\fR program \fiprogram\fR name \fIname\fR [[\fIauto\fR] -- \ [\fIparam\fR] [\fIparam\fR] ... [\fIparam\fR]] @@ -367,20 +367,44 @@ remove the binding between \fIipcp\fR and \fIname\fR. This IPCP will not accept future flow allocation requests for \fIname\fR. .RE +.SH IRM NAME COMMANDS .PP -\fBirm reg\fR name \fIname\fR \fIipcp\fR ipcp [\fIipcp\fR ...] +\fBirm name create \fIname\fR \fIlb\fR policy +.RS 4 +Create a name \fIname\fR with a load-balancing policy +.br +\fIpolicy\fR: round-robin, spillover +.br +.RE + +.PP +\fBirm name destroy \fIname\fR +.RS 4 +Destroy name \fIname\fR. This does not unregister or unbind it. +.RE + +.PP +\fBirm name register \fIname\fR \fIipcp\fR ipcp [\fIipcp\fR ...] layer [layer \fIlayer\fR ...] .RS 4 Register name \fIname\fR in ipcps \fIipcp\fR ipcp and layers \fIlayer\fR. .RE .PP -\fBirm unreg\fR name \fIname\fR \fIipcp\fR ipcp [\fIipcp\fR ...] +\fBirm name unregister \fIname\fR \fIipcp\fR ipcp [\fIipcp\fR ...] layer [layer \fIlayer\fR ...] .RS 4 Unregister name \fIname\fR in ipcps \fIipcp\fR ipcp and layers \fIlayer\fR. .RE +.PP +\fBirm name list \fIname\fR +.RS 4 +List names in the system. \fIname\fR can be used as a prefix to filter +the names. +.RE + + .SH TERMINOLOGY Please see \fBouroboros-glossary\fR(7). |