This function is used to update the configuration of a JetStream consumer.
Context
Windows client
Windows server
Java client
Java server
Adelia Web Client
Adelia Cloud client
Event Adelia client
Parameters
NUM_BIN_4
| Handle | Connection ID |
ALPHA | Stream | Stream name |
ALPHA
| Consumer | Name of consumer (durable or name returned by the NatsCreateConsumer function for an ephemeral consumer). |
ALPHA | Options | Consumer parameters in the form of a list of key/value pairs separated by semi-colons.
The accepted options are:
| description |
Consumer description |
| deliverSubject |
Delivery subject |
| deliverGroup |
Delivery group |
| sampleFrequency |
Sample frequency (string) |
| ackWait |
Acknowledgment wait time in milliseconds (0 by default) |
| idleHeartbeat |
Idle message wait time in milliseconds (0 by default) |
| maxExpires |
Maximum expiration time in milliseconds for a "pull" request (0 by default) |
| inactiveThreshold |
Wait time in milliseconds before the consumer is considered inactive (0 by default) |
| maxDeliver |
Maximum number of messages delivered to the consumer (0 by default) |
| rateLimit |
Rate limit in bits per second (0 by default) |
| maxAckPending |
Maximum number of pending acknowledgments (0 by default) |
| maxBatch |
Maximum size of a batch for a "pull" request (0 by default). |
| maxBytes |
Maximum data size (in bytes) for a "pull" request (0 by default) |
| numReplicas |
Maximum number of replicas (0 by default) |
| flowControl |
Enables flow control and defines the idle heartbeat time (0 by default). |
| headersOnly |
Transmits message headers only. Boolean. By default: false. |
| backoff |
List of times in the form of a list of integer numbers separated by commas. Overloads the ackWait parameter. |
| metadata |
Consumer metadata List of key/value pairs separated by commas. |
| filterSubjects |
List of subjects to filter in the consumer. |
|
NUM_BIN_4
| Rc | Function return code. The possible values are provided in NatsLastError function documentation. Output parameter. |
Example
CALL_DLL 'NatsToolBx' 'NatsUpdateConsumer' Handle 'ORDERS' 'Orders' 'description: order comsumption; durable: Orders; ackPolicy: all' Rc
↑ Top of page
