You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tuweni.apache.org by hu...@apache.org on 2021/05/04 10:07:58 UTC

[incubator-tuweni-website] 23/25: Add hobbits-relayer example use

This is an automated email from the ASF dual-hosted git repository.

humbedooh pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-tuweni-website.git

commit f72f1ab408a5270ed47370077d8333896163f928
Author: Antoine Toulme <an...@lunar-ocean.com>
AuthorDate: Mon Jan 4 23:41:15 2021 -0800

    Add hobbits-relayer example use
---
 tutorials/apps/hobbits-relayer.md | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)

diff --git a/tutorials/apps/hobbits-relayer.md b/tutorials/apps/hobbits-relayer.md
new file mode 100644
index 0000000..5a1a908
--- /dev/null
+++ b/tutorials/apps/hobbits-relayer.md
@@ -0,0 +1,37 @@
+---
+layout: tutorial
+title: Hobbits Relayer
+description: Hobbits Relayer
+group: nav-right
+previous: index.md
+categories: [applications]
+---
+
+The `hobbits-relayer` application showcases how to use the Hobbits protocol to pass messages between different networks.
+
+{%highlight bash%}
+hobbits-relayer --help
+Usage: <main class> [-h] [-b=<bind>] [-t=<to>]
+  -b, --bind=<bind>   Endpoint to bind to
+  -h, --help          Prints usage prompt
+  -t, --to=<to>       Endpoint to relay to
+{%endhighlight%}
+
+Example use:
+
+Relay messages over TCP from port 21000 to 22000:
+{%highlight bash%}
+hobbits-relayer -b tcp://localhost:21000 -t tcp://localhost:22000
+{%endhighlight%}
+
+Relay messages over UDP from port 2222 to 4444:
+{%highlight bash%}
+hobbits-relayer -b udp://localhost:2222 -t udp://localhost:4444
+{%endhighlight%}
+
+Relay messages from a Web Socket port 2222 to a TCP server on 4444:
+{%highlight bash%}
+hobbits-relayer -b ws://localhost:2222 -t tcp://localhost:4444
+{%endhighlight%}
+
+

---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@tuweni.apache.org
For additional commands, e-mail: commits-help@tuweni.apache.org