Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[docs] Add documentation on the network extension of Janus.
Signed-off-by: Stéphane Galland <galland@arakhne.org>
- Loading branch information
1 parent
f7ae018
commit 072cf83
Showing
3 changed files
with
620 additions
and
0 deletions.
There are no files selected for viewing
66 changes: 66 additions & 0 deletions
66
docs/io.sarl.docs.markdown/src/main/documentation/tools/JanusNetworkExtension.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
# Extending the Janus SRE with Network Connection | ||
|
||
[:Outline:] | ||
|
||
[:Include:](./janus.inc) | ||
|
||
By default, Janus does not provide a support for exchanging events over a computer | ||
network. For enabling this communication feature, a specific Janus extension is needed. | ||
|
||
This documentation page describes the extension [:networkextensionname:] that adds the communication | ||
among Janus nodes over a computer network. | ||
|
||
The extension described on this page was defined according to the [standard method for extending Janus](../tutorials/SreExtension.md). | ||
|
||
## General Principles of the Extension | ||
|
||
[:Include:](./hazelcast.inc) | ||
|
||
## Maven Inclusion | ||
|
||
In order to include the networking extension into your project, you could add the following Maven dependency. | ||
|
||
```xml | ||
<project> | ||
... | ||
<properties> | ||
... | ||
<janus.version>[:janus.version2!]</janus.version> | ||
</properties> | ||
... | ||
<dependencies> | ||
... | ||
<dependency> | ||
<groupId>io.janusproject</groupId> | ||
<artifactId>[:networkextensionname](io.janusproject.kernel.network)</artifactId> | ||
<version>${janus.version}</version> | ||
</dependency> | ||
... | ||
</dependencies> | ||
... | ||
</project> | ||
``` | ||
|
||
The [:networkextensionname:] maven module provides the network extension **AND** all the libraries related to the Janus SRE. | ||
|
||
|
||
## Configuration of the plugin | ||
|
||
The following table provides a short description of the configuration parameters that are related to this networking | ||
extension. | ||
More details could be obtain by calling your Janus-based software with the command-line option `-H` for example. | ||
|
||
|
||
| Section | Property | Type | Description | | ||
| ------- | -------- | ---- | ----------- | | ||
[:Dynamic:]{ | ||
runShellSilently( | ||
makeExecName("..", "..", "..", "..", "..", "..", "sre", "io.janusproject", "io.janusproject.kernel.network", "target", "janusnode"), | ||
"generatemarkdownconfighelp".makeCliOption, | ||
"generatemarkdownconfighelp.root".makeCliDefinition("srenetwork")) | ||
|
||
} | ||
|
||
|
||
[:Include:](../legal.inc) | ||
|
Oops, something went wrong.