-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
-
+
-
+
-
+
+
+
+
+
-
-
-
-
-
-
-
-
+
+
+
+
-
+
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
2012#if defined(NATS_HAS_STREAMING)
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
2103 natsSock *fd,
char *host,
int port,
void *closure);
-
-
-
-
+
+
+
+
+
2022#if defined(NATS_HAS_STREAMING)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
2113 natsSock *fd,
char *host,
int port,
void *closure);
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
2193 char **customErrTxt,
-
-
-
-
-
2223 char **customErrTxt,
-
2224 unsigned char **signature,
-
2225 int *signatureLength,
-
-
-
-
2237typedef const char* (*natsTokenHandler)(
void *closure);
+
+
+
+
+
+
2203 char **customErrTxt,
+
+
+
+
+
2233 char **customErrTxt,
+
2234 unsigned char **signature,
+
2235 int *signatureLength,
+
+
-
-
+
2247typedef const char* (*natsTokenHandler)(
void *closure);
-
-
-
-
-
2296#ifdef BUILD_IN_DOXYGEN
-
-
-
-
-
-
2376#if defined(NATS_HAS_STREAMING)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
2477#ifdef BUILD_IN_DOXYGEN
-
-
-
-
-
2496#define nats_CheckCompatibility() nats_CheckCompatibilityImpl(NATS_VERSION_REQUIRED_NUMBER, \
-
2497 NATS_VERSION_NUMBER, \
-
2498 NATS_VERSION_STRING)
-
-
-
2501nats_CheckCompatibilityImpl(uint32_t reqVerNumber, uint32_t verNumber,
const char *verString);
-
-
-
-
-
+
+
+
+
+
+
+
+
2306#ifdef BUILD_IN_DOXYGEN
+
+
+
+
+
+
+
+
2428#if defined(NATS_HAS_STREAMING)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
2529#ifdef BUILD_IN_DOXYGEN
+
+
+
+
+
2548#define nats_CheckCompatibility() nats_CheckCompatibilityImpl(NATS_VERSION_REQUIRED_NUMBER, \
+
2549 NATS_VERSION_NUMBER, \
+
2550 NATS_VERSION_STRING)
+
+
+
2553nats_CheckCompatibilityImpl(uint32_t reqVerNumber, uint32_t verNumber,
const char *verString);
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
2663 unsigned char **signature,
-
2664 int *signatureLength);
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
2797 uint64_t *inMsgs, uint64_t *inBytes,
-
2798 uint64_t *outMsgs, uint64_t *outBytes,
-
2799 uint64_t *reconnects);
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
3165 const char *certsFileName,
-
3166 const char *keyFileName);
-
-
-
-
3185 const char *certsFileName,
-
3186 const char *keyFileName);
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
2715 unsigned char **signature,
+
2716 int *signatureLength);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
2849 uint64_t *inMsgs, uint64_t *inBytes,
+
2850 uint64_t *outMsgs, uint64_t *outBytes,
+
2851 uint64_t *reconnects);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
3217 const char *certsFileName,
+
3218 const char *keyFileName);
+
+
+
+
3237 const char *certsFileName,
+
3238 const char *keyFileName);
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-
+
-
-
-
-
-
-
+
+
+
+
+
+
-
+
-
-
-
+
+
+
+
+
+
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
3925 const char *userOrChainedFile,
-
3926 const char *seedFile);
-
-
-
-
3942 const char *jwtAndSeedContent);
-
-
-
-
-
-
-
-
-
-
-
4000 const char *seedFile);
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
4101#if defined(NATS_HAS_STREAMING)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
3977 const char *userOrChainedFile,
+
3978 const char *seedFile);
+
+
+
+
3994 const char *jwtAndSeedContent);
+
+
+
+
+
+
+
+
+
+
+
4052 const char *seedFile);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
4153#if defined(NATS_HAS_STREAMING)
+
+
+
+
+
+
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
-
+
-
-
-
-
-
+
+
+
+
+
+
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
4696 const char *data,
int dataLen);
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
4928#if defined(NATS_HAS_STREAMING)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
4748 const char *data,
int dataLen);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
4980#if defined(NATS_HAS_STREAMING)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
+
+
+
+
+
-
-
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
5416 const unsigned char *message,
int messageLen,
-
5417 unsigned char sig[64]);
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
5527 const void *data,
int dataLen);
-
-
-
-
-
-
-
-
-
-
-
5574 const char *reply,
const void *data,
int dataLen);
-
-
-
-
5594 const char *reply,
const char *str);
-
-
-
-
5615 const void *data,
int dataLen, int64_t timeout);
-
-
-
-
5640 const char *subj,
const char *str,
-
-
-
-
-
5659 natsMsg *requestMsg, int64_t timeout);
-
-
-
-
-
-
-
-
-
-
5720 const char *subject, int64_t timeout,
-
-
-
-
-
5735 const char *subject);
-
-
-
-
5756 const char *subject,
const char *queueGroup,
-
-
-
-
-
5793 const char *subject,
const char *queueGroup,
-
-
-
-
-
5809 const char *subject,
const char *queueGroup);
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
5468 const unsigned char *message,
int messageLen,
+
5469 unsigned char sig[64]);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
5595 const void *data,
int dataLen);
+
+
+
+
+
+
+
+
+
+
+
5642 const char *reply,
const void *data,
int dataLen);
+
+
+
+
5662 const char *reply,
const char *str);
+
+
+
+
5683 const void *data,
int dataLen, int64_t timeout);
+
+
+
+
5708 const char *subj,
const char *str,
+
+
+
+
+
5727 natsMsg *requestMsg, int64_t timeout);
+
+
+
+
+
+
+
+
+
+
5788 const char *subject, int64_t timeout,
+
+
+
+
+
5803 const char *subject);
+
+
+
+
5824 const char *subject,
const char *queueGroup,
+
+
+
+
+
5861 const char *subject,
const char *queueGroup,
+
+
+
+
+
5877 const char *subject,
const char *queueGroup);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
6068 int *maxPendingMsgs,
-
6069 int *maxPendingBytes,
-
6070 int64_t *deliveredMsgs,
-
6071 int64_t *droppedMsgs);
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
6253#if defined(NATS_HAS_STREAMING)
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
6150 int *maxPendingMsgs,
+
6151 int *maxPendingBytes,
+
6152 int64_t *deliveredMsgs,
+
6153 int64_t *droppedMsgs);
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
6393 const void *data,
int dataLen);
-
-
-
-
6420 const void *data,
int dataLen,
-
-
-
-
-
-
-
-
-
-
-
6473 const char *channel,
const char *queueGroup,
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
6335#if defined(NATS_HAS_STREAMING)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
6475 const void *data,
int dataLen);
+
+
+
+
6502 const void *data,
int dataLen,
+
+
+
+
+
+
+
+
+
+
+
6555 const char *channel,
const char *queueGroup,
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
7028 const char *stream,
const char *consumer,
-
-
-
-
-
-
-
-
-
7062 const char *stream,
const char *consumer,
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
7110 const char *stream,
const char *consumer,
+
+
+
+
+
+
+
+
+
7144 const char *stream,
const char *consumer,
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
9937#define MICRO_API_PREFIX "$SRV"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
9942#define MICRO_INFO_RESPONSE_TYPE "io.nats.micro.v1.info_response"
+
-
9947#define MICRO_INFO_VERB "INFO"
+
-
9952#define MICRO_PING_RESPONSE_TYPE "io.nats.micro.v1.ping_response"
+
-
9957#define MICRO_PING_VERB "PING"
+
-
9962#define MICRO_STATS_RESPONSE_TYPE "io.nats.micro.v1.stats_response"
-
-
9967#define MICRO_STATS_VERB "STATS"
-
-
9973#define MICRO_STATUS_HDR "Nats-Status"
+
+
+
+
+
+
+
+
-
9979#define MICRO_ERROR_HDR "Nats-Service-Error"
-
-
9985#define MICRO_ERROR_CODE_HDR "Nats-Service-Error-Code"
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
10019#define MICRO_API_PREFIX "$SRV"
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
10024#define MICRO_INFO_RESPONSE_TYPE "io.nats.micro.v1.info_response"
+
+
10029#define MICRO_INFO_VERB "INFO"
+
+
10034#define MICRO_PING_RESPONSE_TYPE "io.nats.micro.v1.ping_response"
+
+
10039#define MICRO_PING_VERB "PING"
+
+
10044#define MICRO_STATS_RESPONSE_TYPE "io.nats.micro.v1.stats_response"
+
+
10049#define MICRO_STATS_VERB "STATS"
+
+
10055#define MICRO_STATUS_HDR "Nats-Status"
+
+
10061#define MICRO_ERROR_HDR "Nats-Service-Error"
+
+
10067#define MICRO_ERROR_CODE_HDR "Nats-Service-Error-Code"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
-
-
-
-
-
-
-
-
-
-
-
-
-
10544#define microError_Ignore(__err) microError_Destroy(__err)
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
10626#define microError_Ignore(__err) microError_Destroy(__err)
-
-
-
-
-
-
+
+
+
+
+
-
-
-
-
-
-
-
-
-
void(* natsOnCompleteCB)(void *closure)
Callback used to notify that an object lifecycle is complete.
Definition nats.h:2247
-
natsStatus(* natsEvLoop_Attach)(void **userData, void *loop, natsConnection *nc, natsSock socket)
Attach this connection to the external event loop.
Definition nats.h:2128
-
natsStatus(* natsUserJWTHandler)(char **userJWT, char **customErrTxt, void *closure)
Callback used to fetch and return account signed user JWT.
Definition nats.h:2191
-
natsStatus(* natsEvLoop_WriteAddRemove)(void *userData, bool add)
Write event needs to be added or removed.
Definition nats.h:2156
-
int64_t(* natsCustomReconnectDelayHandler)(natsConnection *nc, int attempts, void *closure)
Callback used to specify how long to wait between reconnects.
Definition nats.h:2269
-
const char *(* natsTokenHandler)(void *closure)
Callback used to build a token on connections and reconnections.
Definition nats.h:2237
-
void(* jsPubAckHandler)(jsCtx *js, natsMsg *msg, jsPubAck *pa, jsPubAckErr *pae, void *closure)
Callback used to process asynchronous publish responses from JetStream.
Definition nats.h:2373
-
void(* jsPubAckErrHandler)(jsCtx *js, jsPubAckErr *pae, void *closure)
Callback used to process asynchronous publish errors from JetStream.
Definition nats.h:2330
-
void(* natsErrHandler)(natsConnection *nc, natsSubscription *subscription, natsStatus err, void *closure)
Callback used to notify the user of errors encountered while processing inbound messages.
Definition nats.h:2111
-
natsStatus(* natsEvLoop_Detach)(void *userData)
Detach from the event loop.
Definition nats.h:2167
-
natsStatus(* natsSignatureHandler)(char **customErrTxt, unsigned char **signature, int *signatureLength, const char *nonce, void *closure)
Callback used to sign a nonce sent by the server.
Definition nats.h:2222
-
void(* stanConnectionLostHandler)(stanConnection *sc, const char *errorTxt, void *closure)
Callback used to notify the user of the permanent loss of the connection.
Definition nats.h:2405
-
int(* natsSSLVerifyCb)(int preverifyOk, void *ctx)
SSL certificate verification callback.
Definition nats.h:2294
-
void(* natsConnectionHandler)(natsConnection *nc, void *closure)
Callback used to notify the user of asynchronous connection events.
Definition nats.h:2088
-
void(* natsMsgHandler)(natsConnection *nc, natsSubscription *sub, natsMsg *msg, void *closure)
Callback used to deliver messages to the application.
Definition nats.h:2072
-
void(* stanPubAckHandler)(const char *guid, const char *error, void *closure)
Callback used to notify of an asynchronous publish result.
Definition nats.h:2385
-
natsStatus(* natsProxyConnHandler)(natsSock *fd, char *host, int port, void *closure)
Callback used to handle connections via proxy.
Definition nats.h:2102
-
natsStatus(* natsEvLoop_ReadAddRemove)(void *userData, bool add)
Read event needs to be added or removed.
Definition nats.h:2143
-
void(* stanMsgHandler)(stanConnection *sc, stanSubscription *sub, const char *channel, stanMsg *msg, void *closure)
Callback used to deliver messages to the application.
Definition nats.h:2396
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
void(* natsOnCompleteCB)(void *closure)
Callback used to notify that an object lifecycle is complete.
Definition nats.h:2257
+
natsStatus(* natsEvLoop_Attach)(void **userData, void *loop, natsConnection *nc, natsSock socket)
Attach this connection to the external event loop.
Definition nats.h:2138
+
natsStatus(* natsUserJWTHandler)(char **userJWT, char **customErrTxt, void *closure)
Callback used to fetch and return account signed user JWT.
Definition nats.h:2201
+
natsStatus(* natsEvLoop_WriteAddRemove)(void *userData, bool add)
Write event needs to be added or removed.
Definition nats.h:2166
+
int64_t(* natsCustomReconnectDelayHandler)(natsConnection *nc, int attempts, void *closure)
Callback used to specify how long to wait between reconnects.
Definition nats.h:2279
+
const char *(* natsTokenHandler)(void *closure)
Callback used to build a token on connections and reconnections.
Definition nats.h:2247
+
void(* jsPubAckHandler)(jsCtx *js, natsMsg *msg, jsPubAck *pa, jsPubAckErr *pae, void *closure)
Callback used to process asynchronous publish responses from JetStream.
Definition nats.h:2383
+
void(* jsPubAckErrHandler)(jsCtx *js, jsPubAckErr *pae, void *closure)
Callback used to process asynchronous publish errors from JetStream.
Definition nats.h:2340
+
void(* natsErrHandler)(natsConnection *nc, natsSubscription *subscription, natsStatus err, void *closure)
Callback used to notify the user of errors encountered while processing inbound messages.
Definition nats.h:2121
+
natsStatus(* natsEvLoop_Detach)(void *userData)
Detach from the event loop.
Definition nats.h:2177
+
natsStatus(* natsSignatureHandler)(char **customErrTxt, unsigned char **signature, int *signatureLength, const char *nonce, void *closure)
Callback used to sign a nonce sent by the server.
Definition nats.h:2232
+
void(* stanConnectionLostHandler)(stanConnection *sc, const char *errorTxt, void *closure)
Callback used to notify the user of the permanent loss of the connection.
Definition nats.h:2457
+
int(* natsSSLVerifyCb)(int preverifyOk, void *ctx)
SSL certificate verification callback.
Definition nats.h:2304
+
void(* natsConnectionHandler)(natsConnection *nc, void *closure)
Callback used to notify the user of asynchronous connection events.
Definition nats.h:2098
+
void(* natsMsgHandler)(natsConnection *nc, natsSubscription *sub, natsMsg *msg, void *closure)
Callback used to deliver messages to the application.
Definition nats.h:2082
+
void(* stanPubAckHandler)(const char *guid, const char *error, void *closure)
Callback used to notify of an asynchronous publish result.
Definition nats.h:2437
+
void(* natsThreadStartedHandler)(void *closure)
Callback invoked when a thread created by the library starts.
Definition nats.h:2425
+
natsStatus(* natsProxyConnHandler)(natsSock *fd, char *host, int port, void *closure)
Callback used to handle connections via proxy.
Definition nats.h:2112
+
natsStatus(* natsEvLoop_ReadAddRemove)(void *userData, bool add)
Read event needs to be added or removed.
Definition nats.h:2153
+
void(* stanMsgHandler)(stanConnection *sc, stanSubscription *sub, const char *channel, stanMsg *msg, void *closure)
Callback used to deliver messages to the application.
Definition nats.h:2448
NATS_EXTERN int natsConnection_Buffered(natsConnection *nc)
Returns the number of bytes to be sent to the server.
NATS_EXTERN natsStatus natsConnection_ReadLastError(natsConnection *nc, char *buf, size_t n)
Read the last connection error into a user provided buffer.
NATS_EXTERN void natsConnection_Close(natsConnection *nc)
Closes the connection.
@@ -2944,6 +2963,7 @@
NATS_EXTERN natsStatus natsConnection_GetStats(natsConnection *nc, natsStatistics *stats)
Gets the connection statistics.
NATS_EXTERN int64_t natsConnection_GetMaxPayload(natsConnection *nc)
Returns the maximum message payload.
NATS_EXTERN natsStatus natsConnection_Sign(natsConnection *nc, const unsigned char *message, int messageLen, unsigned char sig[64])
Signs any 'message' using the connection's user credentials.
+
NATS_EXTERN const char * natsConnection_GetName(natsConnection *nc)
Returns the name of this connection.
NATS_EXTERN natsStatus natsConnection_Connect(natsConnection **nc, natsOptions *options)
Connects to a NATS Server using the provided options.
NATS_EXTERN natsStatus natsConnection_GetClientID(natsConnection *nc, uint64_t *cid)
Gets the current client ID assigned by the server.
NATS_EXTERN natsStatus natsConnection_FlushTimeout(natsConnection *nc, int64_t timeout)
Flushes the connection with a given timeout.
@@ -2970,7 +2990,7 @@
NATS_EXTERN natsStatus natsConnection_Publish(natsConnection *nc, const char *subj, const void *data, int dataLen)
Publishes data on a subject.
NATS_EXTERN natsStatus natsConnection_PublishString(natsConnection *nc, const char *subj, const char *str)
Publishes a string on a subject.
NATS_EXTERN natsStatus natsConnection_Request(natsMsg **replyMsg, natsConnection *nc, const char *subj, const void *data, int dataLen, int64_t timeout)
Sends a request and waits for a reply.
-
NATS_EXTERN natsStatus natsConnection_SubscribeSync(natsSubscription **sub, natsConnection *nc, const char *subject)
Creates a synchronous subcription.
+
NATS_EXTERN natsStatus natsConnection_SubscribeSync(natsSubscription **sub, natsConnection *nc, const char *subject)
Creates a synchronous subscription.
NATS_EXTERN natsStatus natsConnection_QueueSubscribe(natsSubscription **sub, natsConnection *nc, const char *subject, const char *queueGroup, natsMsgHandler cb, void *cbClosure)
Creates an asynchronous queue subscriber.
NATS_EXTERN natsStatus natsConnection_QueueSubscribeSync(natsSubscription **sub, natsConnection *nc, const char *subject, const char *queueGroup)
Creates a synchronous queue subscriber.
NATS_EXTERN natsStatus natsConnection_QueueSubscribeTimeout(natsSubscription **sub, natsConnection *nc, const char *subject, const char *queueGroup, int64_t timeout, natsMsgHandler cb, void *cbClosure)
Creates an asynchronous queue subscriber with a timeout.
@@ -3010,7 +3030,7 @@
NATS_EXTERN natsStatus jsExternalStream_Init(jsExternalStream *external)
Initializes an external stream configuration structure.
NATS_EXTERN natsStatus jsDirectGetMsgOptions_Init(jsDirectGetMsgOptions *opts)
Initializes a direct get message options structure.
NATS_EXTERN void jsStreamInfo_Destroy(jsStreamInfo *si)
Destroys the stream information object.
-
NATS_EXTERN natsStatus js_GetStreamInfo(jsStreamInfo **si, jsCtx *js, const char *stream, jsOptions *opts, jsErrCode *errCode)
Retreives information from a stream.
+
NATS_EXTERN natsStatus js_GetStreamInfo(jsStreamInfo **si, jsCtx *js, const char *stream, jsOptions *opts, jsErrCode *errCode)
Retrieves information from a stream.
NATS_EXTERN void jsConsumerInfo_Destroy(jsConsumerInfo *ci)
Destroys the consumer information object.
NATS_EXTERN natsStatus js_GetMsg(natsMsg **msg, jsCtx *js, const char *stream, uint64_t seq, jsOptions *opts, jsErrCode *errCode)
Retrieves a JetStream message from the stream by sequence.
NATS_EXTERN natsStatus js_PauseConsumer(jsConsumerPauseResponse **new_cpr, jsCtx *js, const char *stream, const char *consumer, uint64_t pauseUntil, jsOptions *opts, jsErrCode *errCode)
Pauses a consumer.
@@ -3121,9 +3141,9 @@
NATS_EXTERN natsStatus nats_CloseAndWait(int64_t timeout)
Tear down the library and wait for all resources to be released.
NATS_EXTERN natsStatus nats_Sign(const char *encodedSeed, const char *input, unsigned char **signature, int *signatureLength)
Signs a given text using the provided private key.
NATS_EXTERN void nats_ReleaseThreadMemory(void)
Release thread-local memory possibly allocated by the library.
-
void(* microErrorHandler)(microService *m, microEndpoint *ep, natsStatus s)
Callback type for async error notifications.
Definition nats.h:9579
-
microError *(* microRequestHandler)(microRequest *req)
Callback type for request processing.
Definition nats.h:9555
-
void(* microDoneHandler)(microService *m)
Callback type for Done (service stopped) notifications.
Definition nats.h:9592
+
void(* microErrorHandler)(microService *m, microEndpoint *ep, natsStatus s)
Callback type for async error notifications.
Definition nats.h:9661
+
microError *(* microRequestHandler)(microRequest *req)
Callback type for request processing.
Definition nats.h:9637
+
void(* microDoneHandler)(microService *m)
Callback type for Done (service stopped) notifications.
Definition nats.h:9674
NATS_EXTERN void microServiceInfo_Destroy(microServiceInfo *info)
Destroys a microServiceInfo object.
NATS_EXTERN void microServiceStats_Destroy(microServiceStats *stats)
Destroys a microServiceStats object.
NATS_EXTERN microError * micro_NewClient(microClient **new_client, natsConnection *nc, microClientConfig *cfg)
Creates a new microservice client.
@@ -3136,7 +3156,7 @@
NATS_EXTERN microError * micro_ErrorfCode(int code, const char *format,...)
creates a new microError, with a code and a printf-like formatted message.
NATS_EXTERN const char * microError_String(microError *err, char *buf, size_t len)
Returns a printable string with the error message.
NATS_EXTERN microError * micro_ErrorFromStatus(natsStatus s)
Wraps a NATS status into a microError, if not a NATS_OK.
-
NATS_EXTERN microError * microError_Wrapf(microError *err, const char *format,...)
Wraps an exising microError with a higher printf-like formatted message.
+
NATS_EXTERN microError * microError_Wrapf(microError *err, const char *format,...)
Wraps an existing microError with a higher printf-like formatted message.
NATS_EXTERN microError * microGroup_AddEndpoint(microGroup *g, microEndpointConfig *config)
Adds an endpoint to a microGroup and starts listening for messages.
NATS_EXTERN microError * microGroup_AddGroup(microGroup **new_group, microGroup *parent, microGroupConfig *config)
Adds a sub-group to microGroup.
NATS_EXTERN microService * microRequest_GetService(microRequest *req)
Returns the pointer to the microservice associated with the request.
@@ -3168,15 +3188,15 @@
NATS_EXTERN microError * microService_GetInfo(microServiceInfo **new_info, microService *m)
Returns a microServiceInfo for a microservice.
NATS_EXTERN microError * microService_Run(microService *m)
Waits for a microservice to stop.
NATS_EXTERN void * microService_GetState(microService *m)
Returns the pointer to state data (closure). It is originally provided in microServiceConfig....
-
struct micro_client_s microClient
The Microservice client.
Definition nats.h:9402
-
struct micro_group_s microGroup
a collection of endpoints and other groups, with a common prefix to their subjects and names.
Definition nats.h:9471
-
struct micro_request_s microRequest
a request received by a microservice endpoint.
Definition nats.h:9486
-
struct micro_error_s microError
the Microservice error object.
Definition nats.h:9462
-
struct __for_forward_compatibility_only microClientConfig
The Microservice configuration object. For forward compatibility only.
Definition nats.h:9407
+
struct micro_client_s microClient
The Microservice client.
Definition nats.h:9484
+
struct micro_group_s microGroup
a collection of endpoints and other groups, with a common prefix to their subjects and names.
Definition nats.h:9553
+
struct micro_request_s microRequest
a request received by a microservice endpoint.
Definition nats.h:9568
+
struct micro_error_s microError
the Microservice error object.
Definition nats.h:9544
+
struct __for_forward_compatibility_only microClientConfig
The Microservice configuration object. For forward compatibility only.
Definition nats.h:9489
NATS_EXTERN microError * micro_ErrorInvalidArg
NATS_EXTERN microError * micro_ErrorOutOfMemory
-
struct micro_endpoint_s microEndpoint
microEndpoint represents a microservice endpoint.
Definition nats.h:9418
-
struct micro_service_s microService
the main object for a configured microservice.
Definition nats.h:9499
+
struct micro_endpoint_s microEndpoint
microEndpoint represents a microservice endpoint.
Definition nats.h:9500
+
struct micro_service_s microService
the main object for a configured microservice.
Definition nats.h:9581
NATS_EXTERN natsStatus natsMsg_Create(natsMsg **newMsg, const char *subj, const char *reply, const char *data, int dataLen)
Creates a natsMsg object.
NATS_EXTERN void natsMsgList_Destroy(natsMsgList *list)
Destroys this list of messages.
NATS_EXTERN int natsMsg_GetDataLength(const natsMsg *msg)
Returns the message length.
@@ -3219,7 +3239,7 @@
NATS_EXTERN void objStoreInfo_Destroy(objStoreInfo *info)
Destroys the ObjectStore information object.
NATS_EXTERN natsStatus objStoreWatchOptions_Init(objStoreWatchOptions *opts)
Initializes the object store watcher options object.
NATS_EXTERN void objStoreWatcher_Destroy(objStoreWatcher *watcher)
Destroys the object store's watcher object.
-
NATS_EXTERN natsStatus objStore_Status(objStoreStatus **new_status, objStore *obs)
Retreive the status and configuration of the bucket.
+
NATS_EXTERN natsStatus objStore_Status(objStoreStatus **new_status, objStore *obs)
Retrieve the status and configuration of the bucket.
NATS_EXTERN void objStore_Destroy(objStore *obs)
Destroys an object store object.
NATS_EXTERN natsStatus objStore_AddBucketLink(objStoreInfo **new_info, objStore *obs, const char *name, objStore *bucket)
Adds a link to another object store.
NATS_EXTERN natsStatus objStoreOptions_Init(objStoreOptions *opts)
Initializes an Object Store options structure.
@@ -3231,7 +3251,7 @@
NATS_EXTERN natsStatus objStore_UpdateMeta(objStore *obs, const char *name, objStoreMeta *meta)
Updates the metadata for the object.
NATS_EXTERN natsStatus objStore_Watch(objStoreWatcher **new_watcher, objStore *obs, objStoreWatchOptions *opts)
Watches for updates to objects in the store.
NATS_EXTERN natsStatus objStoreWatcher_Next(objStoreInfo **new_info, objStoreWatcher *watcher, int64_t timeout)
Returns the next object store information for this object store watcher.
-
NATS_EXTERN void objStoreInfoList_Destroy(objStoreInfoList *list)
Destroys the list of object informations.
+
NATS_EXTERN void objStoreInfoList_Destroy(objStoreInfoList *list)
Destroys the list of object information.
NATS_EXTERN natsStatus objStore_Seal(objStore *obs)
Seals the object store.
NATS_EXTERN natsStatus objStore_List(objStoreInfoList **new_list, objStore *obs, objStoreOptions *opts)
Lists information about objects in the object store.
NATS_EXTERN natsStatus natsOptions_SetNKey(natsOptions *opts, const char *pubKey, natsSignatureHandler sigCB, void *sigClosure)
Sets the NKey public key and signature callback.
@@ -3354,6 +3374,7 @@
NATS_EXTERN bool natsSubscription_IsValid(natsSubscription *sub)
Checks the validity of the subscription.
NATS_EXTERN natsStatus natsSubscription_NextMsg(natsMsg **nextMsg, natsSubscription *sub, int64_t timeout)
Returns the next available message.
NATS_EXTERN natsStatus natsSubscription_SetPendingLimits(natsSubscription *sub, int msgLimit, int bytesLimit)
Sets the limit for pending messages and bytes.
+
NATS_EXTERN natsConnection * natsSubscription_GetConnection(natsSubscription *sub)
Returns the connection that created this subscription.
NATS_EXTERN natsStatus natsSubscription_GetPendingLimits(natsSubscription *sub, int *msgLimit, int *bytesLimit)
Returns the current limit for pending messages and bytes.
NATS_EXTERN natsStatus natsSubscription_QueuedMsgs(natsSubscription *sub, uint64_t *queuedMsgs)
Gets the number of pending messages.
NATS_EXTERN natsStatus natsSubscription_DrainCompletionStatus(natsSubscription *sub)
Returns the status of the drain after completion.
@@ -3363,542 +3384,544 @@
NATS_EXTERN natsStatus natsSubscription_SetOnCompleteCB(natsSubscription *sub, natsOnCompleteCB cb, void *closure)
Sets a completion callback.
NATS_EXTERN natsStatus natsSubscription_Unsubscribe(natsSubscription *sub)
Unsubscribes.
NATS_EXTERN natsStatus natsSubscription_ClearMaxPending(natsSubscription *sub)
Clears the statistics regarding the maximum pending values.
-
struct __objStorePut objStorePut
Definition nats.h:1612
-
struct __stanSubOptions stanSubOptions
Way to configure a stanSubscription.
Definition nats.h:2041
-
struct __kvStore kvStore
Definition nats.h:1459
-
struct __objStore objStore
Definition nats.h:1598
-
jsStorageCompression
Definition nats.h:336
-
jsDeliverPolicy
Definition nats.h:345
-
struct __stanConnOptions stanConnOptions
Way to configure a stanConnection.
Definition nats.h:2035
-
jsStorageType
Definition nats.h:326
+
struct __objStorePut objStorePut
Definition nats.h:1622
+
struct __stanSubOptions stanSubOptions
Way to configure a stanSubscription.
Definition nats.h:2051
+
struct __kvStore kvStore
Definition nats.h:1469
+
struct __objStore objStore
Definition nats.h:1608
+
jsStorageCompression
Definition nats.h:346
+
jsDeliverPolicy
Definition nats.h:355
+
struct __stanConnOptions stanConnOptions
Way to configure a stanConnection.
Definition nats.h:2045
+
jsStorageType
Definition nats.h:336
char natsInbox
Unique subject often used for point-to-point communication.
Definition nats.h:187
-
struct __stanMsg stanMsg
The Streaming message.
Definition nats.h:2029
-
jsRetentionPolicy
Definition nats.h:305
-
struct __kvWatcher kvWatcher
Definition nats.h:1474
+
struct __stanMsg stanMsg
The Streaming message.
Definition nats.h:2039
+
jsRetentionPolicy
Definition nats.h:315
+
struct __kvWatcher kvWatcher
Definition nats.h:1484
struct __natsStatistics natsStatistics
Statistics of a natsConnection.
Definition nats.h:159
-
bool(* jsFetchNextHandler)(int *messages, int64_t *maxBytes, natsSubscription *sub, void *closure)
Callback used to customize flow control for js_PullSubscribeAsync.
Definition nats.h:1297
-
jsDiscardPolicy
Definition nats.h:316
-
jsReplayPolicy
Definition nats.h:371
+
bool(* jsFetchNextHandler)(int *messages, int64_t *maxBytes, natsSubscription *sub, void *closure)
Callback used to customize flow control for js_PullSubscribeAsync.
Definition nats.h:1307
+
jsDiscardPolicy
Definition nats.h:326
+
jsReplayPolicy
Definition nats.h:381
struct __natsSubscription natsSubscription
Interest on a given subject.
Definition nats.h:165
-
kvOperation
Definition nats.h:1480
-
jsAckPolicy
Definition nats.h:359
-
struct __stanConnection stanConnection
A connection to a NATS Streaming Server.
Definition nats.h:2017
-
void(* jsFetchCompleteHandler)(natsConnection *nc, natsSubscription *sub, natsStatus s, void *closure)
Callback used to indicate that the work of js_PullSubscribeAsync is done.
Definition nats.h:1285
-
struct __jsCtx jsCtx
Definition nats.h:271
+
kvOperation
Definition nats.h:1490
+
jsAckPolicy
Definition nats.h:369
+
struct __stanConnection stanConnection
A connection to a NATS Streaming Server.
Definition nats.h:2027
+
void(* jsFetchCompleteHandler)(natsConnection *nc, natsSubscription *sub, natsStatus s, void *closure)
Callback used to indicate that the work of js_PullSubscribeAsync is done.
Definition nats.h:1295
+
struct __jsCtx jsCtx
Definition nats.h:281
struct __natsOptions natsOptions
Way to configure a natsConnection.
Definition nats.h:178
struct __natsHeader natsHeader
Map with key being a string and value being an array of strings.
Definition nats.h:193
-
struct __objStoreGet objStoreGet
Definition nats.h:1619
+
struct __objStoreGet objStoreGet
Definition nats.h:1629
struct __natsClientConfig natsClientConfig
An initial configuration for NATS client. Provides control over the threading model,...
-
struct __kvStatus kvStatus
Definition nats.h:1469
-
struct __kvEntry kvEntry
Definition nats.h:1464
+
struct __kvStatus kvStatus
Definition nats.h:1479
+
struct __kvEntry kvEntry
Definition nats.h:1474
struct __natsMsg natsMsg
A structure holding a subject, optional reply and payload.
Definition nats.h:172
-
struct __objStoreWatcher objStoreWatcher
Definition nats.h:1624
-
struct __stanSubscription stanSubscription
Interest on a given channel.
Definition nats.h:2023
+
struct __objStoreWatcher objStoreWatcher
Definition nats.h:1634
+
struct __stanSubscription stanSubscription
Interest on a given channel.
Definition nats.h:2033
struct __natsConnection natsConnection
A connection to a NATS Server.
Definition nats.h:152
-
@ js_StorageCompressionNone
Specifies no compression. It's the default.
Definition nats.h:337
-
@ js_StorageCompressionS2
Specifies S2.
Definition nats.h:338
-
@ js_DeliverByStartSequence
Starts from a given sequence.
Definition nats.h:349
-
@ js_DeliverByStartTime
Starts from a given UTC time (number of nanoseconds since epoch)
Definition nats.h:350
-
@ js_DeliverNew
Starts with messages sent after the consumer is created.
Definition nats.h:348
-
@ js_DeliverLastPerSubject
Starts with the last message for all subjects received.
Definition nats.h:351
-
@ js_DeliverLast
Starts with the last sequence received.
Definition nats.h:347
-
@ js_DeliverAll
Starts from the very beginning of a stream. This is the default.
Definition nats.h:346
-
@ js_FileStorage
Specifies on disk storage. It's the default.
Definition nats.h:327
-
@ js_MemoryStorage
Specifies in memory only.
Definition nats.h:328
-
@ js_LimitsPolicy
Specifies that messages are retained until any given limit is reached, which could be one of MaxMsgs,...
Definition nats.h:306
-
@ js_InterestPolicy
Specifies that when all known observables have acknowledged a message it can be removed.
Definition nats.h:307
-
@ js_WorkQueuePolicy
Specifies that when the first worker or subscriber acknowledges the message it can be removed.
Definition nats.h:308
-
@ js_DiscardNew
Will fail to store new messages.
Definition nats.h:318
-
@ js_DiscardOld
Will remove older messages to return to the limits. This is the default.
Definition nats.h:317
-
@ js_ReplayInstant
Replays messages as fast as possible.
Definition nats.h:372
-
@ js_ReplayOriginal
Maintains the same timing as the messages were received.
Definition nats.h:373
-
@ kvOp_Unknown
Definition nats.h:1481
-
@ kvOp_Delete
Definition nats.h:1483
-
@ kvOp_Put
Definition nats.h:1482
-
@ kvOp_Purge
Definition nats.h:1484
-
@ js_AckExplicit
Requires ack or nack for all messages.
Definition nats.h:360
-
@ js_AckAll
When acking a sequence number, this implicitly acks all sequences below this one as well.
Definition nats.h:362
-
@ js_AckNone
Requires no acks for delivered messages.
Definition nats.h:361
+
@ js_StorageCompressionNone
Specifies no compression. It's the default.
Definition nats.h:347
+
@ js_StorageCompressionS2
Specifies S2.
Definition nats.h:348
+
@ js_DeliverByStartSequence
Starts from a given sequence.
Definition nats.h:359
+
@ js_DeliverByStartTime
Starts from a given UTC time (number of nanoseconds since epoch)
Definition nats.h:360
+
@ js_DeliverNew
Starts with messages sent after the consumer is created.
Definition nats.h:358
+
@ js_DeliverLastPerSubject
Starts with the last message for all subjects received.
Definition nats.h:361
+
@ js_DeliverLast
Starts with the last sequence received.
Definition nats.h:357
+
@ js_DeliverAll
Starts from the very beginning of a stream. This is the default.
Definition nats.h:356
+
@ js_FileStorage
Specifies on disk storage. It's the default.
Definition nats.h:337
+
@ js_MemoryStorage
Specifies in memory only.
Definition nats.h:338
+
@ js_LimitsPolicy
Specifies that messages are retained until any given limit is reached, which could be one of MaxMsgs,...
Definition nats.h:316
+
@ js_InterestPolicy
Specifies that when all known observables have acknowledged a message it can be removed.
Definition nats.h:317
+
@ js_WorkQueuePolicy
Specifies that when the first worker or subscriber acknowledges the message it can be removed.
Definition nats.h:318
+
@ js_DiscardNew
Will fail to store new messages.
Definition nats.h:328
+
@ js_DiscardOld
Will remove older messages to return to the limits. This is the default.
Definition nats.h:327
+
@ js_ReplayInstant
Replays messages as fast as possible.
Definition nats.h:382
+
@ js_ReplayOriginal
Maintains the same timing as the messages were received.
Definition nats.h:383
+
@ kvOp_Unknown
Definition nats.h:1491
+
@ kvOp_Delete
Definition nats.h:1493
+
@ kvOp_Put
Definition nats.h:1492
+
@ kvOp_Purge
Definition nats.h:1494
+
@ js_AckExplicit
Requires ack or nack for all messages.
Definition nats.h:370
+
@ js_AckAll
When acking a sequence number, this implicitly acks all sequences below this one as well.
Definition nats.h:372
+
@ js_AckNone
Requires no acks for delivered messages.
Definition nats.h:371
#define NATS_EXTERN
Needed for shared library.
Definition nats.h:49
int natsSock
Definition nats.h:50
jsErrCode
Definition status.h:143
natsStatus
Status returned by most of the APIs.
Definition status.h:50
natsConnStatus
The connection state.
Definition status.h:24
-
An initial configuration for NATS client. Provides control over the threading model,...
Definition nats.h:201
-
bool DefaultRepliesToThreadPool
Definition nats.h:211
-
bool UseSeparatePoolForReplies
Definition nats.h:212
-
int ReplyThreadPoolMax
Definition nats.h:213
-
int ThreadPoolMax
Definition nats.h:208
-
int64_t DefaultWriteDeadline
Definition nats.h:202
-
bool DefaultToThreadPool
Definition nats.h:207
-
int64_t LockSpinCount
Definition nats.h:204
-
-
uint64_t Total
Definition nats.h:1126
-
uint64_t Errors
Definition nats.h:1127
-
-
int64_t Consumers
Definition nats.h:1166
-
int64_t Streams
Definition nats.h:1165
-
int TiersLen
Definition nats.h:1171
-
uint64_t Memory
Definition nats.h:1163
-
jsAPIStats API
Definition nats.h:1168
-
jsAccountLimits Limits
Definition nats.h:1169
-
jsTier ** Tiers
Definition nats.h:1170
-
char * Domain
Definition nats.h:1167
-
uint64_t Store
Definition nats.h:1164
-
-
int64_t MemoryMaxStreamBytes
Definition nats.h:1141
-
int64_t MaxStreams
Definition nats.h:1138
-
int64_t MaxAckPending
Definition nats.h:1140
-
int64_t MaxConsumers
Definition nats.h:1139
-
int64_t MaxStore
Definition nats.h:1137
-
int64_t MaxMemory
Definition nats.h:1136
-
bool MaxBytesRequired
Definition nats.h:1143
-
int64_t StoreMaxStreamBytes
Definition nats.h:1142
-
-
int ReplicasLen
Definition nats.h:732
-
char * Name
Definition nats.h:729
-
jsPeerInfo ** Replicas
Definition nats.h:731
-
char * Leader
Definition nats.h:730
-
-
int PriorityGroupsLen
Definition nats.h:919
-
bool MemoryStorage
Definition nats.h:891
-
const char * PriorityPolicy
Represents he priority policy the consumer is set to. Must be "pinned_client" or "overflow"....
Definition nats.h:909
-
const char * Name
Definition nats.h:855
-
int FilterSubjectsLen
Definition nats.h:896
-
uint64_t OptStartSeq
Definition nats.h:859
-
bool HeadersOnly
Definition nats.h:874
-
uint64_t RateLimit
Definition nats.h:868
-
jsDeliverPolicy DeliverPolicy
Definition nats.h:858
-
const char * Description
Definition nats.h:857
-
const char * Durable
Definition nats.h:856
-
const char * SampleFrequency
Definition nats.h:869
-
bool FlowControl
Definition nats.h:872
-
int64_t MaxRequestBatch
Maximum Pull Consumer request batch size.
Definition nats.h:877
-
int64_t AckWait
Definition nats.h:862
-
int64_t MaxRequestMaxBytes
Maximum Pull Consumer request maximum bytes.
Definition nats.h:879
-
int64_t OptStartTime
UTC time expressed as number of nanoseconds since epoch.
Definition nats.h:860
-
int64_t MaxWaiting
Definition nats.h:870
-
jsAckPolicy AckPolicy
Definition nats.h:861
-
natsMetadata Metadata
User-provided metadata for the consumer, encoded as an array of {"key", "value",.....
Definition nats.h:897
-
const char * DeliverSubject
Definition nats.h:882
-
const char ** PriorityGroups
The list of priority groups this consumer supports.
Definition nats.h:918
-
int64_t PinnedTTL
PinnedTTL represents the time after which the client will be unpinned if no new pull requests are sen...
Definition nats.h:915
-
int64_t * BackOff
Redelivery durations expressed in nanoseconds.
Definition nats.h:864
-
int64_t MaxRequestExpires
Maximum Pull Consumer request expiration, expressed in number of nanoseconds.
Definition nats.h:878
-
int64_t Heartbeat
Heartbeat interval expressed in number of nanoseconds.
Definition nats.h:873
-
int64_t PauseUntil
Suspends the consumer until this deadline, represented as number of nanoseconds since epoch....
Definition nats.h:904
-
int64_t Replicas
Definition nats.h:889
-
int BackOffLen
Definition nats.h:865
-
int64_t MaxDeliver
Definition nats.h:863
-
const char ** FilterSubjects
Multiple filter subjects.
Definition nats.h:895
-
jsReplayPolicy ReplayPolicy
Definition nats.h:867
-
const char * DeliverGroup
Definition nats.h:883
-
int64_t MaxAckPending
Definition nats.h:871
-
const char * FilterSubject
Definition nats.h:866
-
int64_t InactiveThreshold
How long the server keeps an ephemeral after detecting loss of interest, expressed in number of nanos...
Definition nats.h:886
-
-
bool Paused
Definition nats.h:1075
-
jsSequenceInfo Delivered
Definition nats.h:1067
-
jsPriorityGroupState * PriorityGroups
Priority groups for the (pull) consumer.
Definition nats.h:1077
-
jsConsumerConfig * Config
Definition nats.h:1066
-
bool PushBound
Definition nats.h:1074
-
int64_t NumWaiting
Definition nats.h:1071
-
int PriorityGroupsLen
Number of priority groups.
Definition nats.h:1078
-
int64_t Created
UTC time expressed as number of nanoseconds since epoch.
Definition nats.h:1065
-
jsClusterInfo * Cluster
Definition nats.h:1073
-
int64_t PauseRemaining
Remaining time in nanoseconds.
Definition nats.h:1076
-
int64_t NumAckPending
Definition nats.h:1069
-
char * Stream
Definition nats.h:1063
-
int64_t NumRedelivered
Definition nats.h:1070
-
char * Name
Definition nats.h:1064
-
jsSequenceInfo AckFloor
Definition nats.h:1068
-
uint64_t NumPending
Definition nats.h:1072
-
-
jsConsumerInfo ** List
Definition nats.h:1090
-
int Count
Definition nats.h:1091
-
-
int Count
Definition nats.h:1105
-
char ** List
Definition nats.h:1104
-
-
int64_t PauseRemaining
Remaining time in nanoseconds.
Definition nats.h:1118
-
bool Paused
Definition nats.h:1116
-
int64_t PauseUntil
UTC time expressed as number of nanoseconds since epoch.
Definition nats.h:1117
-
-
uint64_t Stream
This is the stream sequence that the application should resume from.
Definition nats.h:941
-
uint64_t ConsumerServer
This is the consumer sequence last sent by the server.
Definition nats.h:943
-
uint64_t ConsumerClient
This is the consumer sequence that was last received by the library.
Definition nats.h:942
-
-
const char * NextBySubject
Get the next message (based on sequence) for that subject.
Definition nats.h:1237
-
uint64_t Sequence
Get the message at this sequence.
Definition nats.h:1236
-
const char * LastBySubject
Get the last message on that subject.
Definition nats.h:1238
-
-
const char * DeliverPrefix
Definition nats.h:409
-
const char * APIPrefix
Definition nats.h:408
-
-
const char * ID
Definition nats.h:1258
-
const char * Group
Definition nats.h:1260
-
int64_t MaxBytes
Maximum bytes for the request (request complete based on whichever Batch or MaxBytes comes first)
Definition nats.h:1251
-
int64_t MinPending
Definition nats.h:1256
-
int Batch
Maximum number of messages to be received (see MaxBytes)
Definition nats.h:1250
-
int64_t MinAckPending
Definition nats.h:1257
-
int64_t Expires
Expiration of the request, expressed in nanoseconds.
Definition nats.h:1249
-
bool NoWait
Will not wait if the request cannot be completed.
Definition nats.h:1252
-
int64_t Heartbeat
Have server sends heartbeats to help detect communication failures.
Definition nats.h:1253
-
-
uint64_t * Msgs
Definition nats.h:631
-
uint64_t Bytes
Definition nats.h:633
-
int MsgsLen
Definition nats.h:632
-
-
-
-
-
-
-
-
-
-
jsOptionsPullSubscribeAsync PullSubscribeAsync
extra options for js_PullSubscribeAsync
Definition nats.h:1451
-
int64_t Wait
Amount of time (in milliseconds) to wait for various JetStream API requests, default is 5000 ms (5 se...
Definition nats.h:1449
-
jsOptionsPublishAsync PublishAsync
extra options for js_PublishAsync
Definition nats.h:1450
-
const char * Prefix
JetStream prefix, default is "$JS.API".
Definition nats.h:1447
-
jsOptionsStream Stream
Optional stream options.
Definition nats.h:1452
-
const char * Domain
Domain changes the domain part of JetSteam API prefix.
Definition nats.h:1448
-
-
int64_t MaxPending
Maximum outstanding asynchronous publishes that can be inflight at one time.
Definition nats.h:1379
-
void * AckHandlerClosure
Closure (or user data) passed to jsPubAckHandler callback.
Definition nats.h:1387
-
jsPubAckHandler AckHandler
Callback invoked for each asynchronous published message.
Definition nats.h:1386
-
jsPubAckErrHandler ErrHandler
Callback invoked when error encountered publishing a given message.
Definition nats.h:1393
-
void * ErrHandlerClosure
Closure (or user data) passed to jsPubAckErrHandler callback.
Definition nats.h:1394
-
int64_t StallWait
Amount of time (in milliseconds) to wait in a PublishAsync call when there is MaxPending inflight mes...
Definition nats.h:1396
-
-
int64_t MaxBytes
Auto-unsubscribe after receiving this many bytes.
Definition nats.h:1308
-
int FetchSize
When using the automatic Fetch flow control (default NextHandler), this is the number of messages to ...
Definition nats.h:1352
-
void * NextHandlerClosure
Definition nats.h:1368
-
int MaxMessages
Auto-unsubscribed after receiving this many messages.
Definition nats.h:1307
-
int64_t Timeout
Auto-unsubsribe after this many milliseconds.
Definition nats.h:1306
-
jsFetchNextHandler NextHandler
If set, switches to manual fetch flow control.
Definition nats.h:1367
-
int64_t MinAckPending
When specified, this Pull request will only receive messages when the consumer has at least this many...
Definition nats.h:1347
-
jsFetchCompleteHandler CompleteHandler
Fetch complete handler that receives the exit status code, the subscription's Complete handler is als...
Definition nats.h:1322
-
int64_t Heartbeat
Have server sends heartbeats at this interval (in milliseconds) to help detect communication failures...
Definition nats.h:1327
-
bool NoWait
If NoWait is set, the subscription will receive the messages already stored on the server subject to ...
Definition nats.h:1317
-
void * CompleteHandlerClosure
Definition nats.h:1323
-
int64_t MinPending
When specified, this subscription will only receive messages when the consumer has at least this many...
Definition nats.h:1340
-
const char * Group
The name of consumer priority group.
Definition nats.h:1333
-
int KeepAhead
When using the automatic Fetch flow control (default NextHandler), initiate the next fetch request (t...
Definition nats.h:1360
-
-
jsOptionsStreamInfo Info
Optional stream information retrieval options.
Definition nats.h:1436
-
jsOptionsStreamPurge Purge
Optional stream purge options.
Definition nats.h:1435
-
-
bool DeletedDetails
Get the list of deleted message sequences.
Definition nats.h:1422
-
const char * SubjectsFilter
Get the list of subjects in this stream.
Definition nats.h:1423
-
-
uint64_t Keep
Number of messages to keep.
Definition nats.h:1413
-
const char * Subject
This is the subject to match against messages for the purge command.
Definition nats.h:1411
-
uint64_t Sequence
Purge up to but not including sequence.
Definition nats.h:1412
-
-
bool Offline
Definition nats.h:717
-
uint64_t Lag
Definition nats.h:719
-
int64_t Active
Definition nats.h:718
-
char * Name
Definition nats.h:715
-
bool Current
Definition nats.h:716
-
-
int TagsLen
Definition nats.h:393
-
const char * Cluster
Definition nats.h:391
-
const char ** Tags
Definition nats.h:392
-
-
char * Group
Definition nats.h:1050
-
char * PinnedClientID
Definition nats.h:1051
-
int64_t PinnedTS
Definition nats.h:1052
-
-
natsMsg * Msg
Definition nats.h:1212
-
natsStatus Err
Definition nats.h:1213
-
jsErrCode ErrCode
Definition nats.h:1214
-
const char * ErrText
Definition nats.h:1215
-
-
uint64_t Sequence
Definition nats.h:1200
-
bool Duplicate
Definition nats.h:1202
-
char * Domain
Definition nats.h:1201
-
char * Stream
Definition nats.h:1199
-
-
int64_t MsgTTL
Message time to live (TTL) in milliseconds, used by the server to expire the message....
Definition nats.h:297
-
const char * ExpectLastMsgId
Expected last message ID in the stream.
Definition nats.h:293
-
int64_t MaxWait
Amount of time (in milliseconds) to wait for a publish response, default will the context's Wait valu...
Definition nats.h:290
-
uint64_t ExpectLastSeq
Expected last message sequence in the stream.
Definition nats.h:294
-
bool ExpectNoMessage
Expected no message (that is, sequence == 0) for the subject in the stream.
Definition nats.h:296
-
const char * ExpectStream
Expected stream to respond from the publish call.
Definition nats.h:292
-
const char * MsgId
Message ID used for de-duplication.
Definition nats.h:291
-
uint64_t ExpectLastSubjectSeq
Expected last message sequence for the subject in the stream.
Definition nats.h:295
-
-
bool HeadersOnly
Definition nats.h:446
-
const char * Source
Definition nats.h:444
-
const char * Destination
Definition nats.h:445
-
-
int64_t Last
UTC time expressed as number of nanoseconds since epoch.
Definition nats.h:1041
-
uint64_t Stream
Definition nats.h:1040
-
uint64_t Consumer
Definition nats.h:1039
-
-
uint64_t Consumer
Definition nats.h:1029
-
uint64_t Stream
Definition nats.h:1030
-
-
const char * Name
Definition nats.h:756
-
const char * Cluster
Definition nats.h:758
-
const char * Domain
Definition nats.h:757
-
-
jsDiscardPolicy Discard
Definition nats.h:561
-
const char ** Subjects
Definition nats.h:552
-
jsSubjectTransformConfig SubjectTransform
Applies a subject transform (to matching messages) before doing anything else when a new message is r...
Definition nats.h:609
-
bool AllowDirect
Allow higher performance, direct access to get individual messages. E.g. KeyValue.
Definition nats.h:585
-
int SourcesLen
Definition nats.h:570
-
bool DiscardNewPerSubject
Allow KV like semantics to also discard new on a per subject basis.
Definition nats.h:593
-
jsStorageCompression Compression
js_StorageCompressionNone (default) or js_StorageCompressionS2.
Definition nats.h:602
-
const char * Description
Definition nats.h:551
-
const char * Template
Definition nats.h:565
-
bool AllowMsgTTL
Allow the message to be sent with a time to live (TTL) value. Requires nats-server v2....
Definition nats.h:617
-
bool DenyPurge
Restrict the ability to purge messages.
Definition nats.h:573
-
jsStorageType Storage
Definition nats.h:562
-
jsStreamConsumerLimits ConsumerLimits
Sets the limits on certain options on all consumers of the stream.
Definition nats.h:613
-
jsRetentionPolicy Retention
Definition nats.h:554
-
int64_t MaxMsgs
Definition nats.h:556
-
int64_t MaxConsumers
Definition nats.h:555
-
natsMetadata Metadata
A user-provided array of key/value pairs, encoded as a string array [n1, v1, n2, v2,...
Definition nats.h:598
-
uint64_t FirstSeq
the starting sequence number for the stream.
Definition nats.h:605
-
const char * Name
Definition nats.h:550
-
bool NoAck
Definition nats.h:564
-
jsStreamSource ** Sources
Definition nats.h:569
-
int32_t MaxMsgSize
Definition nats.h:560
-
jsRePublish * RePublish
Allow republish of the message after being sequenced and stored.
Definition nats.h:581
-
bool MirrorDirect
Allow higher performance and unified direct access for mirrors as well.
Definition nats.h:589
-
int64_t Duplicates
Definition nats.h:566
-
int64_t MaxMsgsPerSubject
Definition nats.h:559
-
int64_t SubjectDeleteMarkerTTL
Enables and sets a duration for adding server markers for delete, purge and max age limits....
Definition nats.h:622
-
int64_t MaxAge
Max age of messages in nanoseconds.
Definition nats.h:558
-
int SubjectsLen
Definition nats.h:553
-
bool AllowRollup
Allow messages to be placed into the system and purge all older messages using a special message head...
Definition nats.h:577
-
jsStreamSource * Mirror
Definition nats.h:568
-
jsPlacement * Placement
Definition nats.h:567
-
int64_t MaxBytes
Definition nats.h:557
-
int64_t Replicas
Definition nats.h:563
-
bool Sealed
Seal a stream so no messages can get our or in.
Definition nats.h:571
-
bool DenyDelete
Restrict the ability to delete messages.
Definition nats.h:572
-
-
int MaxAckPending
Definition nats.h:467
-
int64_t InactiveThreshold
Definition nats.h:466
-
-
jsStreamSourceInfo ** Sources
Definition nats.h:775
-
int64_t Created
UTC time expressed as number of nanoseconds since epoch.
Definition nats.h:771
-
jsStreamAlternate ** Alternates
Definition nats.h:777
-
jsStreamState State
Definition nats.h:772
-
jsClusterInfo * Cluster
Definition nats.h:773
-
jsStreamSourceInfo * Mirror
Definition nats.h:774
-
int AlternatesLen
Definition nats.h:778
-
jsStreamConfig * Config
Definition nats.h:770
-
int SourcesLen
Definition nats.h:776
-
-
jsStreamInfo ** List
Definition nats.h:791
-
int Count
Definition nats.h:792
-
-
char ** List
Definition nats.h:805
-
int Count
Definition nats.h:806
-
-
jsExternalStream * External
Definition nats.h:431
-
int64_t OptStartTime
UTC time expressed as number of nanoseconds since epoch.
Definition nats.h:429
-
const char * Name
Definition nats.h:427
-
const char * Domain
Definition nats.h:435
-
uint64_t OptStartSeq
Definition nats.h:428
-
const char * FilterSubject
Definition nats.h:430
-
-
const char * FilterSubject
Definition nats.h:745
-
int64_t Active
Definition nats.h:744
-
int SubjectTransformsLen
Definition nats.h:747
-
char * Name
Definition nats.h:741
-
jsExternalStream * External
Definition nats.h:742
-
uint64_t Lag
Definition nats.h:743
-
jsSubjectTransformConfig * SubjectTransforms
Definition nats.h:746
-
-
jsLostStreamData * Lost
Definition nats.h:704
-
uint64_t LastSeq
Definition nats.h:697
-
int64_t Consumers
Definition nats.h:705
-
int DeletedLen
Definition nats.h:703
-
uint64_t Msgs
Definition nats.h:693
-
jsStreamStateSubjects * Subjects
Definition nats.h:700
-
uint64_t FirstSeq
Definition nats.h:695
-
int64_t LastTime
UTC time expressed as number of nanoseconds since epoch.
Definition nats.h:698
-
int64_t NumSubjects
Definition nats.h:699
-
uint64_t * Deleted
Definition nats.h:702
-
uint64_t NumDeleted
Definition nats.h:701
-
uint64_t Bytes
Definition nats.h:694
-
int64_t FirstTime
UTC time expressed as number of nanoseconds since epoch.
Definition nats.h:696
-
-
uint64_t Msgs
Definition nats.h:645
-
const char * Subject
Definition nats.h:644
-
-
int Count
Definition nats.h:681
-
jsStreamStateSubject * List
Definition nats.h:680
-
-
bool ManualAck
If true, the user will have to acknowledge the messages.
Definition nats.h:1008
-
const char * Consumer
If specified, the subscription will be bound to an existing consumer from the Stream without attempti...
Definition nats.h:980
-
const char * Stream
If specified, the consumer will be bound to this stream name.
Definition nats.h:970
-
bool Ordered
If true, this will be an ordered consumer.
Definition nats.h:1020
-
const char * Queue
Queue name for queue subscriptions.
Definition nats.h:995
-
jsConsumerConfig Config
Consumer configuration.
Definition nats.h:1013
-
-
-
-
-
const char * Name
Definition nats.h:1149
-
int64_t Streams
Definition nats.h:1152
-
uint64_t Store
Definition nats.h:1151
-
int64_t Consumers
Definition nats.h:1153
-
uint64_t Memory
Definition nats.h:1150
-
jsAccountLimits Limits
Definition nats.h:1154
-
-
uint8_t History
Definition nats.h:1498
-
const char * Bucket
Definition nats.h:1495
-
int64_t MaxBytes
Definition nats.h:1500
-
int32_t MaxValueSize
Definition nats.h:1497
-
int Replicas
Definition nats.h:1502
-
const char * Description
Definition nats.h:1496
-
jsStreamSource * Mirror
Definition nats.h:1504
-
int64_t TTL
Definition nats.h:1499
-
jsStorageType StorageType
Definition nats.h:1501
-
jsRePublish * RePublish
Definition nats.h:1503
-
int SourcesLen
Definition nats.h:1506
-
jsStreamSource ** Sources
Definition nats.h:1505
-
A list of KeyValue store entries.
Definition nats.h:1565
-
kvEntry ** Entries
Definition nats.h:1566
-
int Count
Definition nats.h:1567
-
A list of KeyValue store keys.
Definition nats.h:1589
-
int Count
Definition nats.h:1591
-
char ** Keys
Definition nats.h:1590
-
-
int64_t Timeout
Definition nats.h:1533
-
int64_t DeleteMarkersOlderThan
Definition nats.h:1543
-
-
bool IgnoreDeletes
Definition nats.h:1517
-
bool IncludeHistory
Definition nats.h:1518
-
int64_t Timeout
How long to wait (in milliseconds) for some operations to complete.
Definition nats.h:1520
-
bool UpdatesOnly
Only receive updates, no initial snapshot.
Definition nats.h:1521
-
bool MetaOnly
Definition nats.h:1519
-
-
const char * Name
The name of the endpoint.
Definition nats.h:9613
-
microRequestHandler Handler
The request handler for the endpoint.
Definition nats.h:9647
-
const char * Subject
The NATS subject the endpoint will listen on.
Definition nats.h:9624
-
natsMetadata Metadata
Metadata for the endpoint, a JSON-encoded user-provided object, e.g. {"key":"value"}
Definition nats.h:9642
-
bool NoQueueGroup
Disables the use of a queue group for the service.
Definition nats.h:9636
-
const char * QueueGroup
Overrides the default queue group for the service.
Definition nats.h:9630
-
void * State
A user-provided pointer to store with the endpoint (state/closure).
Definition nats.h:9653
-
-
const char * Subject
The semantic version of the service.
Definition nats.h:9669
-
const char * Name
The name of the service.
Definition nats.h:9664
-
const char * QueueGroup
Endpoint's actual queue group (the default "q", or one explicitly set by the user),...
Definition nats.h:9675
-
natsMetadata Metadata
Metadata for the endpoint, a JSON-encoded user-provided object, e.g. {"key":"value"}
Definition nats.h:9681
-
-
const char * Subject
Definition nats.h:9690
-
int64_t NumRequests
The number of requests received by the endpoint.
Definition nats.h:9701
-
char LastErrorString[2048]
a copy of the last error message.
Definition nats.h:9727
-
int64_t ProcessingTimeSeconds
total request processing time (the seconds part).
Definition nats.h:9712
-
int64_t ProcessingTimeNanoseconds
total request processing time (the nanoseconds part).
Definition nats.h:9717
-
const char * QueueGroup
Endpoint's actual queue group (the default "q", or one explicitly set by the user),...
Definition nats.h:9696
-
int64_t NumErrors
The number of errors, service-level and internal, associated with the endpoint.
Definition nats.h:9707
-
int64_t AverageProcessingTimeNanoseconds
average request processing time, in ns.
Definition nats.h:9722
-
const char * Name
Definition nats.h:9689
-
The Microservice endpoint group configuration object.
Definition nats.h:9734
-
bool NoQueueGroup
Disables the use of a queue group for the service.
Definition nats.h:9742
-
const char * QueueGroup
Overrides the default queue group for the service.
Definition nats.h:9739
-
const char * Prefix
The subject prefix for the group.
Definition nats.h:9736
-
The Microservice top-level configuration object.
Definition nats.h:9752
-
const char * Description
The description of the service.
Definition nats.h:9768
-
void * State
A user-provided pointer to state data.
Definition nats.h:9832
-
const char * Version
The (semantic) version of the service.
Definition nats.h:9763
-
microErrorHandler ErrHandler
An error notification handler.
Definition nats.h:9813
-
natsMetadata Metadata
Immutable metadata for the service, a JSON-encoded user-provided object, e.g. {"key":"value"}
Definition nats.h:9786
-
bool NoQueueGroup
Disables the use of a queue group for the service.
Definition nats.h:9780
-
microRequestHandler StatsHandler
A custom stats handler.
Definition nats.h:9804
-
microDoneHandler DoneHandler
A callback handler for handling the final cleanup Done event, right before the service is destroyed.
Definition nats.h:9823
-
const char * QueueGroup
Overrides the default queue group for the service ("q").
Definition nats.h:9774
-
const char * Name
The name of the service.
Definition nats.h:9758
-
microEndpointConfig * Endpoint
The "main" (aka default) endpoint configuration.
Definition nats.h:9795
-
-
natsMetadata Metadata
Metadata for the service, a JSON-encoded user-provided object, e.g. {"key":"value"}
Definition nats.h:9870
-
const char * Name
The name of the service.
Definition nats.h:9850
-
const char * Version
The semantic version of the service.
Definition nats.h:9855
-
const char * Type
Response type. Always "io.nats.micro.v1.info_response".
Definition nats.h:9845
-
const char * Id
The ID of the service instance responding to the request.
Definition nats.h:9865
-
microEndpointInfo * Endpoints
Endpoints.
Definition nats.h:9875
-
const char * Description
The description of the service.
Definition nats.h:9860
-
int EndpointsLen
The number of endpoints in the Endpoints array.
Definition nats.h:9880
-
-
int64_t Started
The timestamp of when the service was started.
Definition nats.h:9911
-
int EndpointsLen
The number of endpoints in the endpoints array.
Definition nats.h:9921
-
microEndpointStats * Endpoints
The stats for each endpoint of the service.
Definition nats.h:9916
-
const char * Version
The semantic version of the service.
Definition nats.h:9901
-
const char * Name
The name of the service.
Definition nats.h:9896
-
const char * Type
Response type. Always "io.nats.micro.v1.stats_response".
Definition nats.h:9891
-
const char * Id
The ID of the service instance responding to the request.
Definition nats.h:9906
-
-
-
-
A list of NATS messages.
Definition nats.h:240
-
int Count
Definition nats.h:242
-
natsMsg ** Msgs
Definition nats.h:241
-
-
natsMetadata Metadata
Bucket-specific metadata.
Definition nats.h:1717
-
int64_t TTL
TTL is the maximum age (expressed in milliseconds) of objects in the store.
Definition nats.h:1674
-
jsStorageType Storage
Storage is the type of storage to use for the object store.
Definition nats.h:1688
-
int Replicas
Replicas is the number of replicas to keep for the object store in clustered jetstream.
Definition nats.h:1695
-
bool Compression
Compression enables the underlying stream compression.
Definition nats.h:1710
-
const char * Bucket
Bucket is the name of the object store.
Definition nats.h:1661
-
jsPlacement * Placement
Placement is used to declare where the object store should be placed.
Definition nats.h:1703
-
const char * Description
Description is an optional description for the object store.
Definition nats.h:1666
-
int64_t MaxBytes
MaxBytes is the maximum size of the object store.
Definition nats.h:1681
-
-
objStoreMeta Meta
objStoreMeta contains high level information about the object.
Definition nats.h:1906
-
const char * Bucket
Bucket is the name of the object store.
Definition nats.h:1911
-
bool Deleted
Deleted indicates if the object is marked as deleted.
Definition nats.h:1945
-
uint64_t Size
Size is the size of the object in bytes. It only includes the size of the object itself,...
Definition nats.h:1921
-
uint32_t Chunks
Chunks is the number of chunks the object is split into.
Definition nats.h:1933
-
int64_t ModTime
ModTime is the last modification time of the object (in unix nanoseconds).
Definition nats.h:1926
-
const char * Digest
Digest is the SHA-256 digest of the object.
Definition nats.h:1940
-
const char * NUID
NUID is the unique identifier for the object set when putting the object into the store.
Definition nats.h:1916
-
-
int Count
Definition nats.h:1959
-
objStoreInfo ** List
Definition nats.h:1958
-
-
const char * Name
Name can be used to link to a single object.
Definition nats.h:1838
-
const char * Bucket
Bucket is the name of the object store the link is pointing to.
Definition nats.h:1831
-
-
-
-
-
-
-
-
-
-
-
char ** List
Definition nats.h:1730
-
int Count
Definition nats.h:1731
-
-
bool ShowDeleted
ShowDeleted includes deleted object in the result.
Definition nats.h:1982
-
-
bool Sealed
Sealed indicates the stream is sealed and cannot be modified in any way.
Definition nats.h:1778
-
bool IsCompressed
IsCompressed indicates if the data is compressed on disk.
Definition nats.h:1805
-
const char * Description
Description is the description supplied when creating the bucket.
Definition nats.h:1758
-
jsStorageType Storage
Storage indicates the underlying JetStream storage technology used tostore data.
Definition nats.h:1768
-
uint64_t Size
Size is the combined size of all data in the bucket including metadata, in bytes.
Definition nats.h:1783
-
const char * Bucket
Bucket is the name of the object store.
Definition nats.h:1753
-
const char * BackingStore
BackingStore indicates what technology is used for storage of the bucket.
Definition nats.h:1790
-
jsStreamInfo * StreamInfo
StreamInfo is the stream info retrieved to create the status.
Definition nats.h:1800
-
int Replicas
Replicas indicates how many storage replicas are kept for the data in the bucket.
Definition nats.h:1773
-
int64_t TTL
TTL indicates how long (in milliseconds) objects are kept in the bucket.
Definition nats.h:1763
-
natsMetadata Metadata
Metadata is the user supplied metadata for the bucket.
Definition nats.h:1795
-
-
int Count
Definition nats.h:1819
-
objStoreStatus ** List
Definition nats.h:1818
-
-
bool UpdatesOnly
The watcher won't return information about existing objects.
Definition nats.h:2007
-
bool IgnoreDeletes
The watcher won't return information about deleted objects.
Definition nats.h:1999
+
An initial configuration for NATS client. Provides control over the threading model,...
Definition nats.h:206
+
bool DefaultRepliesToThreadPool
Definition nats.h:216
+
bool UseSeparatePoolForReplies
Definition nats.h:217
+
int ReplyThreadPoolMax
Definition nats.h:218
+
int ThreadPoolMax
Definition nats.h:213
+
natsThreadStartedHandler ThreadStartedHandler
Definition nats.h:221
+
int64_t DefaultWriteDeadline
Definition nats.h:207
+
bool DefaultToThreadPool
Definition nats.h:212
+
int64_t LockSpinCount
Definition nats.h:209
+
void * ThreadStartedHandlerClosure
Definition nats.h:222
+
+
uint64_t Total
Definition nats.h:1136
+
uint64_t Errors
Definition nats.h:1137
+
+
int64_t Consumers
Definition nats.h:1176
+
int64_t Streams
Definition nats.h:1175
+
int TiersLen
Definition nats.h:1181
+
uint64_t Memory
Definition nats.h:1173
+
jsAPIStats API
Definition nats.h:1178
+
jsAccountLimits Limits
Definition nats.h:1179
+
jsTier ** Tiers
Definition nats.h:1180
+
char * Domain
Definition nats.h:1177
+
uint64_t Store
Definition nats.h:1174
+
+
int64_t MemoryMaxStreamBytes
Definition nats.h:1151
+
int64_t MaxStreams
Definition nats.h:1148
+
int64_t MaxAckPending
Definition nats.h:1150
+
int64_t MaxConsumers
Definition nats.h:1149
+
int64_t MaxStore
Definition nats.h:1147
+
int64_t MaxMemory
Definition nats.h:1146
+
bool MaxBytesRequired
Definition nats.h:1153
+
int64_t StoreMaxStreamBytes
Definition nats.h:1152
+
+
int ReplicasLen
Definition nats.h:742
+
char * Name
Definition nats.h:739
+
jsPeerInfo ** Replicas
Definition nats.h:741
+
char * Leader
Definition nats.h:740
+
+
int PriorityGroupsLen
Definition nats.h:929
+
bool MemoryStorage
Definition nats.h:901
+
const char * PriorityPolicy
Represents he priority policy the consumer is set to. Must be "pinned_client" or "overflow"....
Definition nats.h:919
+
const char * Name
Definition nats.h:865
+
int FilterSubjectsLen
Definition nats.h:906
+
uint64_t OptStartSeq
Definition nats.h:869
+
bool HeadersOnly
Definition nats.h:884
+
uint64_t RateLimit
Definition nats.h:878
+
jsDeliverPolicy DeliverPolicy
Definition nats.h:868
+
const char * Description
Definition nats.h:867
+
const char * Durable
Definition nats.h:866
+
const char * SampleFrequency
Definition nats.h:879
+
bool FlowControl
Definition nats.h:882
+
int64_t MaxRequestBatch
Maximum Pull Consumer request batch size.
Definition nats.h:887
+
int64_t AckWait
Definition nats.h:872
+
int64_t MaxRequestMaxBytes
Maximum Pull Consumer request maximum bytes.
Definition nats.h:889
+
int64_t OptStartTime
UTC time expressed as number of nanoseconds since epoch.
Definition nats.h:870
+
int64_t MaxWaiting
Definition nats.h:880
+
jsAckPolicy AckPolicy
Definition nats.h:871
+
natsMetadata Metadata
User-provided metadata for the consumer, encoded as an array of {"key", "value",.....
Definition nats.h:907
+
const char * DeliverSubject
Definition nats.h:892
+
const char ** PriorityGroups
The list of priority groups this consumer supports.
Definition nats.h:928
+
int64_t PinnedTTL
PinnedTTL represents the time after which the client will be unpinned if no new pull requests are sen...
Definition nats.h:925
+
int64_t * BackOff
Redelivery durations expressed in nanoseconds.
Definition nats.h:874
+
int64_t MaxRequestExpires
Maximum Pull Consumer request expiration, expressed in number of nanoseconds.
Definition nats.h:888
+
int64_t Heartbeat
Heartbeat interval expressed in number of nanoseconds.
Definition nats.h:883
+
int64_t PauseUntil
Suspends the consumer until this deadline, represented as number of nanoseconds since epoch....
Definition nats.h:914
+
int64_t Replicas
Definition nats.h:899
+
int BackOffLen
Definition nats.h:875
+
int64_t MaxDeliver
Definition nats.h:873
+
const char ** FilterSubjects
Multiple filter subjects.
Definition nats.h:905
+
jsReplayPolicy ReplayPolicy
Definition nats.h:877
+
const char * DeliverGroup
Definition nats.h:893
+
int64_t MaxAckPending
Definition nats.h:881
+
const char * FilterSubject
Definition nats.h:876
+
int64_t InactiveThreshold
How long the server keeps an ephemeral after detecting loss of interest, expressed in number of nanos...
Definition nats.h:896
+
+
bool Paused
Definition nats.h:1085
+
jsSequenceInfo Delivered
Definition nats.h:1077
+
jsPriorityGroupState * PriorityGroups
Priority groups for the (pull) consumer.
Definition nats.h:1087
+
jsConsumerConfig * Config
Definition nats.h:1076
+
bool PushBound
Definition nats.h:1084
+
int64_t NumWaiting
Definition nats.h:1081
+
int PriorityGroupsLen
Number of priority groups.
Definition nats.h:1088
+
int64_t Created
UTC time expressed as number of nanoseconds since epoch.
Definition nats.h:1075
+
jsClusterInfo * Cluster
Definition nats.h:1083
+
int64_t PauseRemaining
Remaining time in nanoseconds.
Definition nats.h:1086
+
int64_t NumAckPending
Definition nats.h:1079
+
char * Stream
Definition nats.h:1073
+
int64_t NumRedelivered
Definition nats.h:1080
+
char * Name
Definition nats.h:1074
+
jsSequenceInfo AckFloor
Definition nats.h:1078
+
uint64_t NumPending
Definition nats.h:1082
+
+
jsConsumerInfo ** List
Definition nats.h:1100
+
int Count
Definition nats.h:1101
+
+
int Count
Definition nats.h:1115
+
char ** List
Definition nats.h:1114
+
+
int64_t PauseRemaining
Remaining time in nanoseconds.
Definition nats.h:1128
+
bool Paused
Definition nats.h:1126
+
int64_t PauseUntil
UTC time expressed as number of nanoseconds since epoch.
Definition nats.h:1127
+
+
uint64_t Stream
This is the stream sequence that the application should resume from.
Definition nats.h:951
+
uint64_t ConsumerServer
This is the consumer sequence last sent by the server.
Definition nats.h:953
+
uint64_t ConsumerClient
This is the consumer sequence that was last received by the library.
Definition nats.h:952
+
+
const char * NextBySubject
Get the next message (based on sequence) for that subject.
Definition nats.h:1247
+
uint64_t Sequence
Get the message at this sequence.
Definition nats.h:1246
+
const char * LastBySubject
Get the last message on that subject.
Definition nats.h:1248
+
+
const char * DeliverPrefix
Definition nats.h:419
+
const char * APIPrefix
Definition nats.h:418
+
+
const char * ID
Definition nats.h:1268
+
const char * Group
Definition nats.h:1270
+
int64_t MaxBytes
Maximum bytes for the request (request complete based on whichever Batch or MaxBytes comes first)
Definition nats.h:1261
+
int64_t MinPending
Definition nats.h:1266
+
int Batch
Maximum number of messages to be received (see MaxBytes)
Definition nats.h:1260
+
int64_t MinAckPending
Definition nats.h:1267
+
int64_t Expires
Expiration of the request, expressed in nanoseconds.
Definition nats.h:1259
+
bool NoWait
Will not wait if the request cannot be completed.
Definition nats.h:1262
+
int64_t Heartbeat
Have server sends heartbeats to help detect communication failures.
Definition nats.h:1263
+
+
uint64_t * Msgs
Definition nats.h:641
+
uint64_t Bytes
Definition nats.h:643
+
int MsgsLen
Definition nats.h:642
+
+
+
+
+
+
+
+
+
+
jsOptionsPullSubscribeAsync PullSubscribeAsync
extra options for js_PullSubscribeAsync
Definition nats.h:1461
+
int64_t Wait
Amount of time (in milliseconds) to wait for various JetStream API requests, default is 5000 ms (5 se...
Definition nats.h:1459
+
jsOptionsPublishAsync PublishAsync
extra options for js_PublishAsync
Definition nats.h:1460
+
const char * Prefix
JetStream prefix, default is "$JS.API".
Definition nats.h:1457
+
jsOptionsStream Stream
Optional stream options.
Definition nats.h:1462
+
const char * Domain
Domain changes the domain part of JetSteam API prefix.
Definition nats.h:1458
+
+
int64_t MaxPending
Maximum outstanding asynchronous publishes that can be inflight at one time.
Definition nats.h:1389
+
void * AckHandlerClosure
Closure (or user data) passed to jsPubAckHandler callback.
Definition nats.h:1397
+
jsPubAckHandler AckHandler
Callback invoked for each asynchronous published message.
Definition nats.h:1396
+
jsPubAckErrHandler ErrHandler
Callback invoked when error encountered publishing a given message.
Definition nats.h:1403
+
void * ErrHandlerClosure
Closure (or user data) passed to jsPubAckErrHandler callback.
Definition nats.h:1404
+
int64_t StallWait
Amount of time (in milliseconds) to wait in a PublishAsync call when there is MaxPending inflight mes...
Definition nats.h:1406
+
+
int64_t MaxBytes
Auto-unsubscribe after receiving this many bytes.
Definition nats.h:1318
+
int FetchSize
When using the automatic Fetch flow control (default NextHandler), this is the number of messages to ...
Definition nats.h:1362
+
void * NextHandlerClosure
Definition nats.h:1378
+
int MaxMessages
Auto-unsubscribed after receiving this many messages.
Definition nats.h:1317
+
int64_t Timeout
Auto-unsubsribe after this many milliseconds.
Definition nats.h:1316
+
jsFetchNextHandler NextHandler
If set, switches to manual fetch flow control.
Definition nats.h:1377
+
int64_t MinAckPending
When specified, this Pull request will only receive messages when the consumer has at least this many...
Definition nats.h:1357
+
jsFetchCompleteHandler CompleteHandler
Fetch complete handler that receives the exit status code, the subscription's Complete handler is als...
Definition nats.h:1332
+
int64_t Heartbeat
Have server sends heartbeats at this interval (in milliseconds) to help detect communication failures...
Definition nats.h:1337
+
bool NoWait
If NoWait is set, the subscription will receive the messages already stored on the server subject to ...
Definition nats.h:1327
+
void * CompleteHandlerClosure
Definition nats.h:1333
+
int64_t MinPending
When specified, this subscription will only receive messages when the consumer has at least this many...
Definition nats.h:1350
+
const char * Group
The name of consumer priority group.
Definition nats.h:1343
+
int KeepAhead
When using the automatic Fetch flow control (default NextHandler), initiate the next fetch request (t...
Definition nats.h:1370
+
+
jsOptionsStreamInfo Info
Optional stream information retrieval options.
Definition nats.h:1446
+
jsOptionsStreamPurge Purge
Optional stream purge options.
Definition nats.h:1445
+
+
bool DeletedDetails
Get the list of deleted message sequences.
Definition nats.h:1432
+
const char * SubjectsFilter
Get the list of subjects in this stream.
Definition nats.h:1433
+
+
uint64_t Keep
Number of messages to keep.
Definition nats.h:1423
+
const char * Subject
This is the subject to match against messages for the purge command.
Definition nats.h:1421
+
uint64_t Sequence
Purge up to but not including sequence.
Definition nats.h:1422
+
+
bool Offline
Definition nats.h:727
+
uint64_t Lag
Definition nats.h:729
+
int64_t Active
Definition nats.h:728
+
char * Name
Definition nats.h:725
+
bool Current
Definition nats.h:726
+
+
int TagsLen
Definition nats.h:403
+
const char * Cluster
Definition nats.h:401
+
const char ** Tags
Definition nats.h:402
+
+
char * Group
Definition nats.h:1060
+
char * PinnedClientID
Definition nats.h:1061
+
int64_t PinnedTS
Definition nats.h:1062
+
+
natsMsg * Msg
Definition nats.h:1222
+
natsStatus Err
Definition nats.h:1223
+
jsErrCode ErrCode
Definition nats.h:1224
+
const char * ErrText
Definition nats.h:1225
+
+
uint64_t Sequence
Definition nats.h:1210
+
bool Duplicate
Definition nats.h:1212
+
char * Domain
Definition nats.h:1211
+
char * Stream
Definition nats.h:1209
+
+
int64_t MsgTTL
Message time to live (TTL) in milliseconds, used by the server to expire the message....
Definition nats.h:307
+
const char * ExpectLastMsgId
Expected last message ID in the stream.
Definition nats.h:303
+
int64_t MaxWait
Amount of time (in milliseconds) to wait for a publish response, default will the context's Wait valu...
Definition nats.h:300
+
uint64_t ExpectLastSeq
Expected last message sequence in the stream.
Definition nats.h:304
+
bool ExpectNoMessage
Expected no message (that is, sequence == 0) for the subject in the stream.
Definition nats.h:306
+
const char * ExpectStream
Expected stream to respond from the publish call.
Definition nats.h:302
+
const char * MsgId
Message ID used for de-duplication.
Definition nats.h:301
+
uint64_t ExpectLastSubjectSeq
Expected last message sequence for the subject in the stream.
Definition nats.h:305
+
+
bool HeadersOnly
Definition nats.h:456
+
const char * Source
Definition nats.h:454
+
const char * Destination
Definition nats.h:455
+
+
int64_t Last
UTC time expressed as number of nanoseconds since epoch.
Definition nats.h:1051
+
uint64_t Stream
Definition nats.h:1050
+
uint64_t Consumer
Definition nats.h:1049
+
+
uint64_t Consumer
Definition nats.h:1039
+
uint64_t Stream
Definition nats.h:1040
+
+
const char * Name
Definition nats.h:766
+
const char * Cluster
Definition nats.h:768
+
const char * Domain
Definition nats.h:767
+
+
jsDiscardPolicy Discard
Definition nats.h:571
+
const char ** Subjects
Definition nats.h:562
+
jsSubjectTransformConfig SubjectTransform
Applies a subject transform (to matching messages) before doing anything else when a new message is r...
Definition nats.h:619
+
bool AllowDirect
Allow higher performance, direct access to get individual messages. E.g. KeyValue.
Definition nats.h:595
+
int SourcesLen
Definition nats.h:580
+
bool DiscardNewPerSubject
Allow KV like semantics to also discard new on a per subject basis.
Definition nats.h:603
+
jsStorageCompression Compression
js_StorageCompressionNone (default) or js_StorageCompressionS2.
Definition nats.h:612
+
const char * Description
Definition nats.h:561
+
const char * Template
Definition nats.h:575
+
bool AllowMsgTTL
Allow the message to be sent with a time to live (TTL) value. Requires nats-server v2....
Definition nats.h:627
+
bool DenyPurge
Restrict the ability to purge messages.
Definition nats.h:583
+
jsStorageType Storage
Definition nats.h:572
+
jsStreamConsumerLimits ConsumerLimits
Sets the limits on certain options on all consumers of the stream.
Definition nats.h:623
+
jsRetentionPolicy Retention
Definition nats.h:564
+
int64_t MaxMsgs
Definition nats.h:566
+
int64_t MaxConsumers
Definition nats.h:565
+
natsMetadata Metadata
A user-provided array of key/value pairs, encoded as a string array [n1, v1, n2, v2,...
Definition nats.h:608
+
uint64_t FirstSeq
the starting sequence number for the stream.
Definition nats.h:615
+
const char * Name
Definition nats.h:560
+
bool NoAck
Definition nats.h:574
+
jsStreamSource ** Sources
Definition nats.h:579
+
int32_t MaxMsgSize
Definition nats.h:570
+
jsRePublish * RePublish
Allow republish of the message after being sequenced and stored.
Definition nats.h:591
+
bool MirrorDirect
Allow higher performance and unified direct access for mirrors as well.
Definition nats.h:599
+
int64_t Duplicates
Definition nats.h:576
+
int64_t MaxMsgsPerSubject
Definition nats.h:569
+
int64_t SubjectDeleteMarkerTTL
Enables and sets a duration for adding server markers for delete, purge and max age limits....
Definition nats.h:632
+
int64_t MaxAge
Max age of messages in nanoseconds.
Definition nats.h:568
+
int SubjectsLen
Definition nats.h:563
+
bool AllowRollup
Allow messages to be placed into the system and purge all older messages using a special message head...
Definition nats.h:587
+
jsStreamSource * Mirror
Definition nats.h:578
+
jsPlacement * Placement
Definition nats.h:577
+
int64_t MaxBytes
Definition nats.h:567
+
int64_t Replicas
Definition nats.h:573
+
bool Sealed
Seal a stream so no messages can get our or in.
Definition nats.h:581
+
bool DenyDelete
Restrict the ability to delete messages.
Definition nats.h:582
+
+
int MaxAckPending
Definition nats.h:477
+
int64_t InactiveThreshold
Definition nats.h:476
+
+
jsStreamSourceInfo ** Sources
Definition nats.h:785
+
int64_t Created
UTC time expressed as number of nanoseconds since epoch.
Definition nats.h:781
+
jsStreamAlternate ** Alternates
Definition nats.h:787
+
jsStreamState State
Definition nats.h:782
+
jsClusterInfo * Cluster
Definition nats.h:783
+
jsStreamSourceInfo * Mirror
Definition nats.h:784
+
int AlternatesLen
Definition nats.h:788
+
jsStreamConfig * Config
Definition nats.h:780
+
int SourcesLen
Definition nats.h:786
+
+
jsStreamInfo ** List
Definition nats.h:801
+
int Count
Definition nats.h:802
+
+
char ** List
Definition nats.h:815
+
int Count
Definition nats.h:816
+
+
jsExternalStream * External
Definition nats.h:441
+
int64_t OptStartTime
UTC time expressed as number of nanoseconds since epoch.
Definition nats.h:439
+
const char * Name
Definition nats.h:437
+
const char * Domain
Definition nats.h:445
+
uint64_t OptStartSeq
Definition nats.h:438
+
const char * FilterSubject
Definition nats.h:440
+
+
const char * FilterSubject
Definition nats.h:755
+
int64_t Active
Definition nats.h:754
+
int SubjectTransformsLen
Definition nats.h:757
+
char * Name
Definition nats.h:751
+
jsExternalStream * External
Definition nats.h:752
+
uint64_t Lag
Definition nats.h:753
+
jsSubjectTransformConfig * SubjectTransforms
Definition nats.h:756
+
+
jsLostStreamData * Lost
Definition nats.h:714
+
uint64_t LastSeq
Definition nats.h:707
+
int64_t Consumers
Definition nats.h:715
+
int DeletedLen
Definition nats.h:713
+
uint64_t Msgs
Definition nats.h:703
+
jsStreamStateSubjects * Subjects
Definition nats.h:710
+
uint64_t FirstSeq
Definition nats.h:705
+
int64_t LastTime
UTC time expressed as number of nanoseconds since epoch.
Definition nats.h:708
+
int64_t NumSubjects
Definition nats.h:709
+
uint64_t * Deleted
Definition nats.h:712
+
uint64_t NumDeleted
Definition nats.h:711
+
uint64_t Bytes
Definition nats.h:704
+
int64_t FirstTime
UTC time expressed as number of nanoseconds since epoch.
Definition nats.h:706
+
+
uint64_t Msgs
Definition nats.h:655
+
const char * Subject
Definition nats.h:654
+
+
int Count
Definition nats.h:691
+
jsStreamStateSubject * List
Definition nats.h:690
+
+
bool ManualAck
If true, the user will have to acknowledge the messages.
Definition nats.h:1018
+
const char * Consumer
If specified, the subscription will be bound to an existing consumer from the Stream without attempti...
Definition nats.h:990
+
const char * Stream
If specified, the consumer will be bound to this stream name.
Definition nats.h:980
+
bool Ordered
If true, this will be an ordered consumer.
Definition nats.h:1030
+
const char * Queue
Queue name for queue subscriptions.
Definition nats.h:1005
+
jsConsumerConfig Config
Consumer configuration.
Definition nats.h:1023
+
+
+
+
+
const char * Name
Definition nats.h:1159
+
int64_t Streams
Definition nats.h:1162
+
uint64_t Store
Definition nats.h:1161
+
int64_t Consumers
Definition nats.h:1163
+
uint64_t Memory
Definition nats.h:1160
+
jsAccountLimits Limits
Definition nats.h:1164
+
+
uint8_t History
Definition nats.h:1508
+
const char * Bucket
Definition nats.h:1505
+
int64_t MaxBytes
Definition nats.h:1510
+
int32_t MaxValueSize
Definition nats.h:1507
+
int Replicas
Definition nats.h:1512
+
const char * Description
Definition nats.h:1506
+
jsStreamSource * Mirror
Definition nats.h:1514
+
int64_t TTL
Definition nats.h:1509
+
jsStorageType StorageType
Definition nats.h:1511
+
jsRePublish * RePublish
Definition nats.h:1513
+
int SourcesLen
Definition nats.h:1516
+
jsStreamSource ** Sources
Definition nats.h:1515
+
A list of KeyValue store entries.
Definition nats.h:1575
+
kvEntry ** Entries
Definition nats.h:1576
+
int Count
Definition nats.h:1577
+
A list of KeyValue store keys.
Definition nats.h:1599
+
int Count
Definition nats.h:1601
+
char ** Keys
Definition nats.h:1600
+
+
int64_t Timeout
Definition nats.h:1543
+
int64_t DeleteMarkersOlderThan
Definition nats.h:1553
+
+
bool IgnoreDeletes
Definition nats.h:1527
+
bool IncludeHistory
Definition nats.h:1528
+
int64_t Timeout
How long to wait (in milliseconds) for some operations to complete.
Definition nats.h:1530
+
bool UpdatesOnly
Only receive updates, no initial snapshot.
Definition nats.h:1531
+
bool MetaOnly
Definition nats.h:1529
+
+
const char * Name
The name of the endpoint.
Definition nats.h:9695
+
microRequestHandler Handler
The request handler for the endpoint.
Definition nats.h:9729
+
const char * Subject
The NATS subject the endpoint will listen on.
Definition nats.h:9706
+
natsMetadata Metadata
Metadata for the endpoint, a JSON-encoded user-provided object, e.g. {"key":"value"}
Definition nats.h:9724
+
bool NoQueueGroup
Disables the use of a queue group for the service.
Definition nats.h:9718
+
const char * QueueGroup
Overrides the default queue group for the service.
Definition nats.h:9712
+
void * State
A user-provided pointer to store with the endpoint (state/closure).
Definition nats.h:9735
+
+
const char * Subject
The semantic version of the service.
Definition nats.h:9751
+
const char * Name
The name of the service.
Definition nats.h:9746
+
const char * QueueGroup
Endpoint's actual queue group (the default "q", or one explicitly set by the user),...
Definition nats.h:9757
+
natsMetadata Metadata
Metadata for the endpoint, a JSON-encoded user-provided object, e.g. {"key":"value"}
Definition nats.h:9763
+
+
const char * Subject
Definition nats.h:9772
+
int64_t NumRequests
The number of requests received by the endpoint.
Definition nats.h:9783
+
char LastErrorString[2048]
a copy of the last error message.
Definition nats.h:9809
+
int64_t ProcessingTimeSeconds
total request processing time (the seconds part).
Definition nats.h:9794
+
int64_t ProcessingTimeNanoseconds
total request processing time (the nanoseconds part).
Definition nats.h:9799
+
const char * QueueGroup
Endpoint's actual queue group (the default "q", or one explicitly set by the user),...
Definition nats.h:9778
+
int64_t NumErrors
The number of errors, service-level and internal, associated with the endpoint.
Definition nats.h:9789
+
int64_t AverageProcessingTimeNanoseconds
average request processing time, in ns.
Definition nats.h:9804
+
const char * Name
Definition nats.h:9771
+
The Microservice endpoint group configuration object.
Definition nats.h:9816
+
bool NoQueueGroup
Disables the use of a queue group for the service.
Definition nats.h:9824
+
const char * QueueGroup
Overrides the default queue group for the service.
Definition nats.h:9821
+
const char * Prefix
The subject prefix for the group.
Definition nats.h:9818
+
The Microservice top-level configuration object.
Definition nats.h:9834
+
const char * Description
The description of the service.
Definition nats.h:9850
+
void * State
A user-provided pointer to state data.
Definition nats.h:9914
+
const char * Version
The (semantic) version of the service.
Definition nats.h:9845
+
microErrorHandler ErrHandler
An error notification handler.
Definition nats.h:9895
+
natsMetadata Metadata
Immutable metadata for the service, a JSON-encoded user-provided object, e.g. {"key":"value"}
Definition nats.h:9868
+
bool NoQueueGroup
Disables the use of a queue group for the service.
Definition nats.h:9862
+
microRequestHandler StatsHandler
A custom stats handler.
Definition nats.h:9886
+
microDoneHandler DoneHandler
A callback handler for handling the final cleanup Done event, right before the service is destroyed.
Definition nats.h:9905
+
const char * QueueGroup
Overrides the default queue group for the service ("q").
Definition nats.h:9856
+
const char * Name
The name of the service.
Definition nats.h:9840
+
microEndpointConfig * Endpoint
The "main" (aka default) endpoint configuration.
Definition nats.h:9877
+
+
natsMetadata Metadata
Metadata for the service, a JSON-encoded user-provided object, e.g. {"key":"value"}
Definition nats.h:9952
+
const char * Name
The name of the service.
Definition nats.h:9932
+
const char * Version
The semantic version of the service.
Definition nats.h:9937
+
const char * Type
Response type. Always "io.nats.micro.v1.info_response".
Definition nats.h:9927
+
const char * Id
The ID of the service instance responding to the request.
Definition nats.h:9947
+
microEndpointInfo * Endpoints
Endpoints.
Definition nats.h:9957
+
const char * Description
The description of the service.
Definition nats.h:9942
+
int EndpointsLen
The number of endpoints in the Endpoints array.
Definition nats.h:9962
+
+
int64_t Started
The timestamp of when the service was started.
Definition nats.h:9993
+
int EndpointsLen
The number of endpoints in the endpoints array.
Definition nats.h:10003
+
microEndpointStats * Endpoints
The stats for each endpoint of the service.
Definition nats.h:9998
+
const char * Version
The semantic version of the service.
Definition nats.h:9983
+
const char * Name
The name of the service.
Definition nats.h:9978
+
const char * Type
Response type. Always "io.nats.micro.v1.stats_response".
Definition nats.h:9973
+
const char * Id
The ID of the service instance responding to the request.
Definition nats.h:9988
+
+
+
+
A list of NATS messages.
Definition nats.h:250
+
int Count
Definition nats.h:252
+
natsMsg ** Msgs
Definition nats.h:251
+
+
natsMetadata Metadata
Bucket-specific metadata.
Definition nats.h:1727
+
int64_t TTL
TTL is the maximum age (expressed in milliseconds) of objects in the store.
Definition nats.h:1684
+
jsStorageType Storage
Storage is the type of storage to use for the object store.
Definition nats.h:1698
+
int Replicas
Replicas is the number of replicas to keep for the object store in clustered jetstream.
Definition nats.h:1705
+
bool Compression
Compression enables the underlying stream compression.
Definition nats.h:1720
+
const char * Bucket
Bucket is the name of the object store.
Definition nats.h:1671
+
jsPlacement * Placement
Placement is used to declare where the object store should be placed.
Definition nats.h:1713
+
const char * Description
Description is an optional description for the object store.
Definition nats.h:1676
+
int64_t MaxBytes
MaxBytes is the maximum size of the object store.
Definition nats.h:1691
+
+
objStoreMeta Meta
objStoreMeta contains high level information about the object.
Definition nats.h:1916
+
const char * Bucket
Bucket is the name of the object store.
Definition nats.h:1921
+
bool Deleted
Deleted indicates if the object is marked as deleted.
Definition nats.h:1955
+
uint64_t Size
Size is the size of the object in bytes. It only includes the size of the object itself,...
Definition nats.h:1931
+
uint32_t Chunks
Chunks is the number of chunks the object is split into.
Definition nats.h:1943
+
int64_t ModTime
ModTime is the last modification time of the object (in unix nanoseconds).
Definition nats.h:1936
+
const char * Digest
Digest is the SHA-256 digest of the object.
Definition nats.h:1950
+
const char * NUID
NUID is the unique identifier for the object set when putting the object into the store.
Definition nats.h:1926
+
+
int Count
Definition nats.h:1969
+
objStoreInfo ** List
Definition nats.h:1968
+
+
const char * Name
Name can be used to link to a single object.
Definition nats.h:1848
+
const char * Bucket
Bucket is the name of the object store the link is pointing to.
Definition nats.h:1841
+
+
+
+
+
+
+
+
+
+
+
char ** List
Definition nats.h:1740
+
int Count
Definition nats.h:1741
+
+
bool ShowDeleted
ShowDeleted includes deleted object in the result.
Definition nats.h:1992
+
+
bool Sealed
Sealed indicates the stream is sealed and cannot be modified in any way.
Definition nats.h:1788
+
bool IsCompressed
IsCompressed indicates if the data is compressed on disk.
Definition nats.h:1815
+
const char * Description
Description is the description supplied when creating the bucket.
Definition nats.h:1768
+
jsStorageType Storage
Storage indicates the underlying JetStream storage technology used tostore data.
Definition nats.h:1778
+
uint64_t Size
Size is the combined size of all data in the bucket including metadata, in bytes.
Definition nats.h:1793
+
const char * Bucket
Bucket is the name of the object store.
Definition nats.h:1763
+
const char * BackingStore
BackingStore indicates what technology is used for storage of the bucket.
Definition nats.h:1800
+
jsStreamInfo * StreamInfo
StreamInfo is the stream info retrieved to create the status.
Definition nats.h:1810
+
int Replicas
Replicas indicates how many storage replicas are kept for the data in the bucket.
Definition nats.h:1783
+
int64_t TTL
TTL indicates how long (in milliseconds) objects are kept in the bucket.
Definition nats.h:1773
+
natsMetadata Metadata
Metadata is the user supplied metadata for the bucket.
Definition nats.h:1805
+
+
int Count
Definition nats.h:1829
+
objStoreStatus ** List
Definition nats.h:1828
+
+
bool UpdatesOnly
The watcher won't return information about existing objects.
Definition nats.h:2017
+
bool IgnoreDeletes
The watcher won't return information about deleted objects.
Definition nats.h:2009