You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@activemq.apache.org by jb...@apache.org on 2017/08/17 15:07:01 UTC
[2/2] activemq-artemis git commit: ARTEMIS-1343 Update Configuring
Transports Documentation
ARTEMIS-1343 Update Configuring Transports Documentation
Updated to reflect deprecated properties.
Add a new section to cover native transport support (epoll and kqueue) added over the past few releases.
Project: http://git-wip-us.apache.org/repos/asf/activemq-artemis/repo
Commit: http://git-wip-us.apache.org/repos/asf/activemq-artemis/commit/bfe88c8f
Tree: http://git-wip-us.apache.org/repos/asf/activemq-artemis/tree/bfe88c8f
Diff: http://git-wip-us.apache.org/repos/asf/activemq-artemis/diff/bfe88c8f
Branch: refs/heads/master
Commit: bfe88c8fc31a9ce20e58f628ae164459f920146e
Parents: 133dd43
Author: Michael Andre Pearce <Mi...@me.com>
Authored: Thu Aug 10 08:24:30 2017 +0100
Committer: Justin Bertram <jb...@apache.org>
Committed: Thu Aug 17 10:06:44 2017 -0500
----------------------------------------------------------------------
docs/user-manual/en/configuring-transports.md | 41 +++++++++++++++++++++-
1 file changed, 40 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/bfe88c8f/docs/user-manual/en/configuring-transports.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/configuring-transports.md b/docs/user-manual/en/configuring-transports.md
index ff8f534..e50e7d0 100644
--- a/docs/user-manual/en/configuring-transports.md
+++ b/docs/user-manual/en/configuring-transports.md
@@ -269,7 +269,10 @@ Netty for simple TCP:
willing to take some small extra hit on latency but want the highest
throughput set `directDeliver` to `false`.
-- `nioRemotingThreads`. When configured to use NIO, Apache ActiveMQ Artemis will,
+- `nioRemotingThreads` This is deprecated. It is replaced by `remotingThreads`,
+ if you are using this please update your configuration
+
+- `remotingThreads`. Apache ActiveMQ Artemis will,
by default, use a number of threads equal to three times the number
of cores (or hyper-threads) as reported by
`Runtime.getRuntime().availableProcessors()` for processing incoming
@@ -300,7 +303,43 @@ Netty for simple TCP:
the connection is refused. In the case of a `core` client, it will
result in a `org.apache.activemq.artemis.api.core.ActiveMQConnectionTimedOutException`.
+## Configuring Netty Native Transport
+
+Netty Native Transport support exists for selected OS platforms.
+This allows Apache ActiveMQ Artemis to use native sockets/io instead of Java NIO.
+
+These Native transports add features specific to a particular platform,
+generate less garbage, and generally improve performance when compared to Java NIO based transport.
+
+Both Clients and Server can benefit from this.
+
+Current Supported Platforms.
+- Linux running 64bit JVM
+- MacOS running 64bit JVM
+
+Apache ActiveMQ Artemis will by default enable the corresponding native transport if a supported platform is detected.
+
+If running on an unsupported platform or any issues loading native libs, Apache ActiveMQ Artemis will fallback onto Java NIO.
+
+#### Linux Native Transport
+On supported Linux platforms Epoll is used, @see https://en.wikipedia.org/wiki/Epoll.
+
+The following properties are specific to this native transport:
+
+- `useEpoll` enables the use of epoll if a supported linux platform is running a 64bit JVM is detected.
+ Setting this to `false` will force the use of Java NIO instead of epoll. Default is `true`
+
+#### MacOS Native Transport
+
+On supported MacOS platforms KQueue is used, @see https://en.wikipedia.org/wiki/Kqueue.
+
+The following properties are specific to this native transport:
+
+- `useKQueue` enables the use of kqueue if a supported MacOS platform running a 64bit JVM is detected.
+ Setting this to `false` will force the use of Java NIO instead of kqueue. Default is `true`
+
+
## Configuring Netty SSL
Netty SSL is similar to the Netty TCP transport but it provides