From 97c255e562031d86120416bd7596a48fe106bb5a Mon Sep 17 00:00:00 2001 From: Pawel Date: Tue, 9 Feb 2021 14:23:48 +0100 Subject: Update documentation regarding persistent connection configuration in dmaap-client. Add direct link to gerrit changelog file Issue-ID: DCAEGEN2-1483 Signed-off-by: Pawel Change-Id: I80743e78fc60dcbfc209922eb2c9f022f11604d0 --- docs/sections/sdk/apis.rst | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) (limited to 'docs/sections/sdk/apis.rst') diff --git a/docs/sections/sdk/apis.rst b/docs/sections/sdk/apis.rst index ebd9a6d2..8f20a0ab 100644 --- a/docs/sections/sdk/apis.rst +++ b/docs/sections/sdk/apis.rst @@ -255,6 +255,42 @@ Retry functionality works for: - DMaaP MR HTTP response status codes: 404, 408, 413, 429, 500, 502, 503, 504 - Java Exception classes: ReadTimeoutException, ConnectException +************************************** +Configure custom persistent connection +************************************** + +* publisher: + +.. code-block:: java + + final MessageRouterPublisherConfig connectionPoolConfiguration = ImmutableMessageRouterPublisherConfig.builder() + .connectionPoolConfig(ImmutableDmaapConnectionPoolConfig.builder() + .connectionPool(16) + .maxIdleTime(10) //in seconds + .maxLifeTime(20) //in seconds + .build()) + .build(); + final MessageRouterPublisher publisher = DmaapClientFactory.createMessageRouterPublisher(connectionPoolConfiguration); + +* subscriber: + +.. code-block:: java + + final MessageRouterSubscriberConfig connectionPoolConfiguration = ImmutableMessageRouterSubscriberConfig.builder() + .connectionPoolConfig(ImmutableDmaapConnectionPoolConfig.builder() + .connectionPool(16) + .maxIdleTime(10) //in seconds + .maxLifeTime(20) //in seconds + .build()) + .build(); + final MessageRouterSubscriber subscriber = DmaapClientFactory.createMessageRouterSubscriber(connectionPoolConfiguration); + +The default custom persistent connection configuration (connectionPool=16, maxLifeTime=2147483647, maxIdleTime=2147483647) can be used: + +.. code-block:: java + + ImmutableDmaapConnectionPoolConfig.builder().build() + hvvesclient-producer - a reference Java implementation of High Volume VES Collector client ------------------------------------------------------------------------------------------ This library is used in xNF simulator which helps us test HV VES Collector in CSIT tests. You may use it as a reference when implementing your code in non-JVM language or directly when using Java/Kotlin/etc. -- cgit 1.2.3-korg