Skip to content

Commit

Permalink
apps.interlink: fix documentation bugs
Browse files Browse the repository at this point in the history
  • Loading branch information
eugeneia committed May 3, 2018
1 parent 02bdf78 commit c583ac7
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions src/apps/interlink/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,19 @@ of packets between Snabb processes within the same process group (see
[Multiprocess operation (core.worker)](#multiprocess-operation-core.worker)).

DIAGRAM: Transmitter and Receiver
+----------------------------+ +-------------------------+
| | | |
| | | |
input----* apps.interlink.transmitter | | apps.interlink.reciever *---- output
| | | |
| | | |
+----------------------------+ +-------------------------+
+-------------+ +-------------+
| | | |
input | | | |
----* Transmitter | | Reciever *----
| | | | output
| | | |
+-------------+ +-------------+

To make packets from an output port available to other processes, configure a
transmitter app, and link the appropriate output port to its `input` port.

```lua
local Transmitter = require("apps.interlink.transmitter)
local Transmitter = require("apps.interlink.transmitter")

config.app(c, "interlink", Transmitter)
config.link(c, "myapp.output -> interlink.input")
Expand All @@ -27,7 +27,7 @@ Then, in the process that should receive the packets, configure a receiver app
with the same name, and link its `output` port as suitable.

```lua
local Receiver = require("apps.interlink.receiver)
local Receiver = require("apps.interlink.receiver")

config.app(c, "interlink", Receiver)
config.link(c, "interlink.output -> otherapp.input")
Expand Down

0 comments on commit c583ac7

Please sign in to comment.