kvWatchOptions Struct Reference

#include <nats.h>

Public Attributes
bool	IgnoreDeletes
	Do not receive delete markers.
bool	IncludeHistory
	Receive all history per subject, not just the last one.
bool	MetaOnly
	Only receive the meta data of the entry.
int64_t	Timeout
	How long to wait for some operations to complete.
bool	UpdatesOnly
	Only receive updates, no initial snapshot.
int64_t	Heartbeat
	Heartbeat used by the internal ordered consumer.
uint64_t	ResumeFromRevision
	Resume from this specific revision.
kvWatchCb	Callback
	This callback is invoked when an entry is available.
void *	Closure
	An optional pointer to user provided data to be passed to the Callback.

Detailed Description

KeyValue watcher options object.

Initialize the object with kvWatchOptions_Init

Member Data Documentation

IgnoreDeletes

bool kvWatchOptions::IgnoreDeletes

If this is set to true, the watcher will not receive delete markers.

IncludeHistory

bool kvWatchOptions::IncludeHistory

If not set, only the latest value per key is delivered as the initial snapshot.

Warning

This option is ignored if ResumeFromRevision is set.

MetaOnly

bool kvWatchOptions::MetaOnly

The entry will not contain the actual content of entry.

Timeout

int64_t kvWatchOptions::Timeout

Expressed in milliseconds.

UpdatesOnly

bool kvWatchOptions::UpdatesOnly

If set to true, the initial snapshot will not be received. Only new updates after the watcher is created will be received.

Note

If this is set, IncludeHistory option is ignored.

Warning

This option is ignored if ResumeFromRevision is set.

Heartbeat

int64_t kvWatchOptions::Heartbeat

Expressed in nanoseconds, similar to jsConsumerConfig.Heartbeat.

Note

If not specified, a default value of 5 seconds is used.

ResumeFromRevision

uint64_t kvWatchOptions::ResumeFromRevision

If this is set to a positive value, the watcher will resume from this specific revision.

Note

This is intended for watchers that have restarted watching and have maintained some state of where they were in the watch.

Warning

IncludeHistory and UpdatesOnly options will be ignored.

Callback

kvWatchCb kvWatchOptions::Callback

If this is set, the watcher becomes asynchronous, that is, the user cannot call kvWatcher_Next, instead the callback will automatically be invoked when an entry is available.

Closure

void* kvWatchOptions::Closure

If this is non NULL, it will be passed to the Callback on each callback invocation.

---

The documentation for this struct was generated from the following file:

• nats.h