memQueue (In-memory Queue)

An in-memory queue triggerer executes an orchestration at-least-once, possibly at-most-once (presuming that the orchestration in question has some rollback behaviour) when the given in-memory queue contains at least one message.

It is a transport asynchronous queue, which is not persistent, so all messages in the queues will disappear on server shutdown. The data from the queue message itself is provided to the stream.

The queue is a mandatory field.

class names

scala: code.model.flows.processors.queues.QueueTriggererFactory
javascript: code_model_flows_processors_queues_QueueTriggererFactory

aliases

inMemQueue inMemoryQueue memoryQueue

start type

scala.Nothing

end type

config

{"categories":[{"defaultCollapsed":true,"fields":["poolSize","sharedPoolName","streamType","mutualReentranceKey","nonReentrant","killOnStop","orchestrationTimeout","orchestratorName","env","isRunning","runOnlyOnHosts","runOnlyOnRanks","runOnlyOnRoles","deepDiagnostics","startupPriority"],"name":"Advanced Run Configuration"}],"fieldName":"memQueue","fields":[{"default":true,"fieldName":"memQueue.maintainBatches","hidden":false,"hideLabel":false,"name":"maintainBatches","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"default":null,"fieldName":"memQueue.runOnlyOnRanks","hidden":false,"hideLabel":false,"itemType":{"default":null,"fieldName":"memQueue.runOnlyOnRanks.runOnlyOnRanks","hidden":false,"hideLabel":false,"name":"runOnlyOnRanks","readonly":false,"renderStrategies":[],"type":"I","validators":[]},"name":"runOnlyOnRanks","readonly":false,"renderStrategies":[],"type":"A"},{"default":null,"fieldName":"memQueue.name","hidden":false,"hideLabel":false,"name":"name","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":"memQueue","fieldName":"memQueue.classPath","hidden":false,"hideLabel":false,"name":"classPath","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":null,"fieldName":"memQueue.bundle","hidden":false,"hideLabel":false,"name":"bundle","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":null,"fieldName":"memQueue.mutualReentrancyKey","hidden":false,"hideLabel":false,"name":"mutualReentrancyKey","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":"collecting","fieldName":"memQueue.streamType","hidden":false,"hideLabel":false,"name":"streamType","readonly":false,"renderStrategies":[],"type":"S","validators":[{"choices":["collecting","eager","forgetful"],"displayOverride":{},"rule":"choices","unenforced":false}]},{"default":false,"fieldName":"memQueue.deepDiagnostics","hidden":false,"hideLabel":false,"name":"deepDiagnostics","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"default":null,"fieldName":"memQueue.runOnlyOnRoles","hidden":false,"hideLabel":false,"itemType":{"default":null,"fieldName":"memQueue.runOnlyOnRoles.runOnlyOnRoles","hidden":false,"hideLabel":false,"name":"runOnlyOnRoles","readonly":false,"renderStrategies":[],"type":"S","validators":[{"choices":["frontend","backend","viewer"],"displayOverride":{},"rule":"choices","unenforced":false}]},"name":"runOnlyOnRoles","readonly":false,"renderStrategies":[],"type":"A"},{"default":null,"fieldName":"memQueue.queue","hidden":false,"hideLabel":false,"name":"queue","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":"","fieldName":"memQueue.description","hidden":false,"hideLabel":false,"name":"description","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"bindingHint":"the size of the threadpool. If this is set to a positive number, this trigger will use a dedicated threadpool. If this is set to zero or less, it will use the default shared threadpool.","canReference":true,"default":null,"fieldName":"memQueue.poolSize","hidden":false,"hideLabel":false,"label":"threadpool size","name":"poolSize","readonly":false,"renderStrategies":[],"type":"I","validators":[]},{"default":false,"fieldName":"memQueue.nonReentrant","hidden":false,"hideLabel":false,"name":"nonReentrant","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"default":null,"fieldName":"memQueue.orchestratorName","hidden":false,"hideLabel":false,"name":"orchestratorName","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"bindingHint":"If this trigger is set to use a dedicated threadpool (using the poolSize attribute), then this name will override which threadpool this trigger uses. By default, triggers using dedicated threadpools will use a threadpool each, but if you set multiple triggers with the same name and pool size, they will share that pool.","canReference":true,"default":null,"fieldName":"memQueue.sharedPoolName","hidden":false,"hideLabel":false,"label":"shared threadpool","name":"sharedPoolName","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":"${generatedId}","fieldName":"memQueue.id","hidden":false,"hideLabel":false,"name":"id","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"bindingHint":"This is the order of startup when multiple stateful behaviours are being started at the same time. This is usually when a recipe is being run, or a bundle is being loaded, but is especially relevant when the server is being started.","default":1400,"fieldName":"memQueue.startupPriority","hidden":false,"hideLabel":false,"name":"startupPriority","readonly":false,"renderStrategies":[],"type":"I","validators":[{"max":2048.0,"min":950.0,"rule":"numberRange"}]},{"default":null,"fieldName":"memQueue.runOnlyOnHosts","hidden":false,"hideLabel":false,"itemType":{"default":null,"fieldName":"memQueue.runOnlyOnHosts.runOnlyOnHosts","hidden":false,"hideLabel":false,"name":"runOnlyOnHosts","readonly":false,"renderStrategies":[],"type":"S","validators":[]},"name":"runOnlyOnHosts","readonly":false,"renderStrategies":[],"type":"A"},{"default":false,"fieldName":"memQueue.isRunning","hidden":false,"hideLabel":false,"name":"isRunning","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"default":false,"fieldName":"memQueue.killOnStop","hidden":false,"hideLabel":false,"name":"killOnStop","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"canReference":false,"default":180000,"fieldName":"memQueue.orchestrationTimeout","hidden":false,"hideLabel":false,"label":"Orchestration Timeout","name":"orchestrationTimeout","readonly":false,"renderStrategies":[{"config":{"precision":3,"timeUnit":"ms"},"type":"valueAsTimeSpan"}],"type":"L","validators":[]},{"default":"statefulBehaviour","fieldName":"memQueue.type","hidden":false,"hideLabel":false,"name":"type","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":true,"fieldName":"memQueue.implicitAck","hidden":false,"hideLabel":false,"name":"implicitAck","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"default":1,"fieldName":"memQueue.maximumBatchSize","hidden":false,"hideLabel":false,"name":"maximumBatchSize","readonly":false,"renderStrategies":[],"type":"I","validators":[]},{"default":null,"fieldName":"memQueue.env","hidden":false,"hideLabel":false,"name":"env","readonly":false,"renderStrategies":[],"type":"S","validators":[]}],"hidden":false,"hideLabel":false,"label":"Triggerer Configuration","name":"memQueue","readonly":false,"renderStrategies":[],"type":"O"}