raboof/pekko
1
0
Fork 0
Code Issues Pull requests Projects Releases 6 Packages Wiki Activity Actions 11

Merge pull request #27844 from akka/wip-doc-minor1-patriknw

Browse source 
doc: minor fix of remoting-artery.md
This commit is contained in:
Patrik Nordwall 2019-10-01 19:11:27 +02:00 • committed by GitHub
commit 619f821e8d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

9
akka-docs/src/main/paradox/remoting-artery.md
View file

@ -115,9 +115,11 @@ acts as a "server" to which arbitrary systems on the same network can connect to
There are three alternatives of which underlying transport to use. It is configured by property There are three alternatives of which underlying transport to use. It is configured by property
`akka.remote.artery.transport` with the possible values: `akka.remote.artery.transport` with the possible values:
* `aeron-udp` - Based on [Aeron (UDP)](https://github.com/real-logic/aeron) * `tcp` - Based on @ref:[Akka Streams TCP](stream/stream-io.md#streaming-tcp) (default if other not configured)
* `tcp` - Based on @ref:[Akka Streams TCP](stream/stream-io.md#streaming-tcp)
* `tls-tcp` - Same as `tcp` with encryption using @ref:[Akka Streams TLS](stream/stream-io.md#tls) * `tls-tcp` - Same as `tcp` with encryption using @ref:[Akka Streams TLS](stream/stream-io.md#tls)
* `aeron-udp` - Based on [Aeron (UDP)](https://github.com/real-logic/aeron)
If you are uncertain of what to select a good choice is to use the default, which is `tcp`.
The Aeron (UDP) transport is a high performance transport and should be used for systems The Aeron (UDP) transport is a high performance transport and should be used for systems
that require high throughput and low latency. It uses more CPU than TCP when the system that require high throughput and low latency. It uses more CPU than TCP when the system
@ -128,8 +130,7 @@ when encryption is needed, but it can also be used with plain TCP without TLS. I
the obvious choice when UDP can't be used. the obvious choice when UDP can't be used.
It has very good performance (high throughput and low latency) but latency at high throughput It has very good performance (high throughput and low latency) but latency at high throughput
might not be as good as the Aeron transport. It has less operational complexity than the might not be as good as the Aeron transport. It has less operational complexity than the
Aeron transport and less risk of trouble in container environments. Artery TCP will be Aeron transport and less risk of trouble in container environments.
the default transport in Akka 2.6.0.
@@@ note @@@ note