Skip to content

Commit

Permalink
docs: channel_options, default keepalive_time_ms
Browse files Browse the repository at this point in the history
  • Loading branch information
felicijus committed Oct 3, 2024
1 parent 6e89795 commit ecdeb2b
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/channels.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,22 @@ Channels
========

In order to instantiate a ZeebeWorker or ZeebeClient you will need to provide an instance of a `grpc.aio.Channel`.
This Channel can be configured with the parameters `channel_credentials` and `channel_options`.

.. seealso::

`Python Channel Options <https://grpc.github.io/grpc/python/glossary.html#term-channel_arguments>`_
Documentation of the available Python `grpc.aio.Channel` `options` (channel_arguments).


.. note::

By default, channel_options is defined so that the grpc.keepalive_time_ms option is always set to 45_000 (45 seconds).
Reference Camunda Spring Zeebe SDK with predefined `keep-alive <https://docs.camunda.io/docs/apis-tools/spring-zeebe-sdk/configuration/#keep-alive>`_ attribute.

You can override the default `channel_options` by passing
e.g. `channel_options = (("grpc.keepalive_time_ms", 60_000),)` - for a keepalive time of 60 seconds.


Pyzeebe provides a couple standard ways to achieve this:

Expand Down

0 comments on commit ecdeb2b

Please sign in to comment.