Skip to content
This repository has been archived by the owner on Mar 31, 2022. It is now read-only.

Latest commit

 

History

History
68 lines (50 loc) · 2.65 KB

README.md

File metadata and controls

68 lines (50 loc) · 2.65 KB
Raw

Jmix Cloud Queue

This repository contains AWS Queue project of the Jmix framework.

CAUTION: The project is in EXPERIMENTAL status and may be removed or modified in any way without notice. Use at your own risk!

For more information see:

Usage

Add to your project's build.gradle dependencies:

implementation 'io.jmix.cloudqueueui:jmix-cloudqueue-ui-starter'

For AWS Queue:

implementation 'io.jmix.cloudqueueui:jmix-cloudqueue-aws-starter'

For Yandex Queue:

implementation 'io.jmix.cloudqueueui:jmix-cloudqueue-yandex-starter'

Specify AWS credentials and region in application.properties:

jmix.cloudqueue.aws.region = eu-central-1
jmix.cloudqueue.aws.access-key = AWS_ACCESS_KEY
jmix.cloudqueue.aws.secret-key = AWS_SECRET_KEY

Specify Yandex credentials, region and endpoint in application.properties:

jmix.cloudqueue.yandex.region = ru-central1
jmix.cloudqueue.yandex.access-key = YANDEX_ACCESS_KEY
jmix.cloudqueue.yandex.secret-key = YANDEX_SECRET_KEY
jmix.cloudqueue.yandex.endpoint-configuration = https://message-queue.api.cloud.yandex.net

By default, prefix is not defined and application loads every queue and create queues without any prefix

Add Provider family queues prefix to use only queues with the prefix to restrict queues in your application

jmix.cloudqueue.queue-prefix = jmixqueues

After this ADD-on will create and load only 'jmixqueues' queues with the prefix.

Specify next parameters for Simple Queue Listener in application.properties:

  1. long-polling-timeout - the duration (in milliseconds) after that will be sent new request to aws to check new messages.
  2. waiting-time-receive-request - the duration (in seconds) for which the call waits for a message to arrive in the queue before returning. If a message is available, the call returns sooner than WaitTimeSeconds. If no messages are available and the wait time expires, the call returns successfully with an empty list of messages.
  3. max-number-of-messages - the maximum number of messages to return. Queue never returns more messages than this value (however, fewer messages might be returned). Valid values: 1 to 10.
  4. thread-pool-core-size - the number of threads to keep in the pool, even if they are idle. Use in thread pool that serves for handling messages.
jmix.cloudqueue.listener.long-polling-timeout = 10000
jmix.cloudqueue.listener.waiting-time-receive-request = 5
jmix.cloudqueue.listener.max-number-of-messages = 10
jmix.cloudqueue.listener.thread-pool-core-size = 5