configuration queue¶
This is the runtime configuration for a casual domain.
The sections can be splitted in arbitrary ways, and aggregated to one configuration model casual uses.
Same sections can be defined in different files, hence, give more or less unlimited configuration setup.
Most of the sections has a property note for the user to provide descriptions of the documentation.
The examples further down uses this to make it easier to understand the examples by them self. But can of
course be used as a mean to help document actual production configuration.
domain.queue¶
Defines the queue configuration
Duration : string¶
A string representation of a duration. SI units can be used. Example: 30ms, 1h, 3min, 40s. if no SI unit s is used
Retry (structure)¶
property |
description |
default |
|---|---|---|
[count : |
number of rollbacks before move to error queue |
|
[delay : |
delay before message is available for dequeue after rollback |
|
Enable (structure)¶
property |
description |
default |
|---|---|---|
[enqueue : |
if enqueue is enabled for the queue |
|
[dequeue : |
if dequeue is enabled for the queue |
|
domain.queue.default¶
Default properties that will be used if not defined per queue
property |
description |
default |
|---|---|---|
[directory : |
directory for generated storage files |
|
[queue.retry : |
retry semantics |
Bytes : string¶
A string representation of a quantity of bytes. IEC 80000-13 units up to T/Ti can be used. Example: 3B, 24MiB, 15MB. If no unit is specified, B is used.
Capacity (structure)¶
property |
description |
default |
|---|---|---|
[size : |
the maximum total size of messages that the group may store |
domain.queue.groups (list)¶
Defines groups of queues which share the same storage location. Groups has no other meaning.
property |
description |
default |
|---|---|---|
alias : |
the (unique) alias of the group. |
|
[queuebase : |
the path to the storage file. |
|
[queues : |
defines all queues in this group, see below |
|
[capacity : |
limits the storage capacity of the group |
Note: if :memory: is used as queuebase, the storage is non persistent
domain.queue.groups.queues¶
property |
description |
|---|---|
name : |
the (unique) name of the queue. |
[retry : |
retry semantics |
[enable : |
enqueue/dequeue enable/disable |
domain.queue.forward¶
Section to configure queue to service forwards and queue to queue forwards.
domain.queue.forward.default¶
Default properties that will be used if not explicitly configured per forward.
property |
description |
default |
|---|---|---|
[service.instances : |
number of forward instances |
|
[service.reply.delay : |
reply enqueue available delay |
|
[queue.instances : |
number of forward instances |
|
[queue.target.delay : |
enqueue available delay |
|
domain.queue.forward.groups (list)¶
property |
description |
|---|---|
alias : |
the (unique) alias of the group. |
[services : |
queue-to-services forwards |
[queues : |
queue-to-queue forwards |
domain.queue.forward.groups.services¶
property |
description |
default |
|---|---|---|
source : |
the queue to dequeue from |
|
[instances : |
number of multiplexing ‘instances’ |
|
target.service : |
service to call |
|
[reply.queue : |
queue to enqueue reply to |
|
[reply.delay : |
reply enqueue available delay |
examples¶
Below follows examples in yaml and json (casual can also handle ini and xml)
yaml¶
---
domain:
queue:
note: "retry.count - if number of rollbacks is greater, message is moved to error-queue retry.delay - the amount of time before the message is available for consumption, after rollback\n"
default:
queue:
retry:
count: 3
delay: "20s"
directory: "${CASUAL_DOMAIN_HOME}/queue/groups"
groups:
- alias: "A"
note: "will get default queuebase: ${CASUAL_DOMAIN_HOME}/queue/groups/A.qb"
queues:
- name: "a1"
enable:
enqueue: true
dequeue: false
note: "dequeue is disabled -> dequeue will give no_queue error (unless the queue is found elsewhere)"
- name: "a2"
retry:
count: 10
delay: "100ms"
note: "after 10 rollbacked dequeues, message is moved to a2.error"
- name: "a3"
- name: "a4"
- alias: "B"
queuebase: "/some/fast/disk/queue/groupB.qb"
queues:
- name: "b1"
- name: "b2"
retry:
count: 20
note: "after 20 rollbacked dequeues, message is moved to b2.error. retry.delay is 'inherited' from default, if any"
- alias: "C"
queuebase: ":memory:"
note: "group is an in-memory queue, hence no persistence"
queues:
- name: "c1"
- name: "c2"
- alias: "D"
note: "group limited to a total message size of 10KiB, after which further enqueues will give no_queue error"
capacity:
size: "10KiB"
queues:
- name: "d1"
- name: "d2"
forward:
default:
service:
instances: 3
reply:
delay: "2s"
queue:
instances: 1
target:
delay: "500ms"
groups:
- alias: "forward-group-1"
services:
- source: "b1"
instances: 4
target:
service: "casual/example/echo"
reply:
queue: "a3"
delay: "10ms"
queues:
- source: "c1"
target:
queue: "a4"
- alias: "forward-group-2"
services:
- source: "b2"
target:
service: "casual/example/echo"
...
json¶
{
"domain": {
"queue": {
"note": "retry.count - if number of rollbacks is greater, message is moved to error-queue retry.delay - the amount of time before the message is available for consumption, after rollback\n",
"default": {
"queue": {
"retry": {
"count": 3,
"delay": "20s"
}
},
"directory": "${CASUAL_DOMAIN_HOME}/queue/groups"
},
"groups": [
{
"alias": "A",
"note": "will get default queuebase: ${CASUAL_DOMAIN_HOME}/queue/groups/A.qb",
"queues": [
{
"name": "a1",
"enable": {
"enqueue": true,
"dequeue": false
},
"note": "dequeue is disabled -> dequeue will give no_queue error (unless the queue is found elsewhere)"
},
{
"name": "a2",
"retry": {
"count": 10,
"delay": "100ms"
},
"note": "after 10 rollbacked dequeues, message is moved to a2.error"
},
{
"name": "a3"
},
{
"name": "a4"
}
]
},
{
"alias": "B",
"queuebase": "/some/fast/disk/queue/groupB.qb",
"queues": [
{
"name": "b1"
},
{
"name": "b2",
"retry": {
"count": 20
},
"note": "after 20 rollbacked dequeues, message is moved to b2.error. retry.delay is 'inherited' from default, if any"
}
]
},
{
"alias": "C",
"queuebase": ":memory:",
"note": "group is an in-memory queue, hence no persistence",
"queues": [
{
"name": "c1"
},
{
"name": "c2"
}
]
},
{
"alias": "D",
"note": "group limited to a total message size of 10KiB, after which further enqueues will give no_queue error",
"capacity": {
"size": "10KiB"
},
"queues": [
{
"name": "d1"
},
{
"name": "d2"
}
]
}
],
"forward": {
"default": {
"service": {
"instances": 3,
"reply": {
"delay": "2s"
}
},
"queue": {
"instances": 1,
"target": {
"delay": "500ms"
}
}
},
"groups": [
{
"alias": "forward-group-1",
"services": [
{
"source": "b1",
"instances": 4,
"target": {
"service": "casual/example/echo"
},
"reply": {
"queue": "a3",
"delay": "10ms"
}
}
],
"queues": [
{
"source": "c1",
"target": {
"queue": "a4"
}
}
]
},
{
"alias": "forward-group-2",
"services": [
{
"source": "b2",
"target": {
"service": "casual/example/echo"
}
}
]
}
]
}
}
}
}