|
NATS C Client with JetStream and Streaming support
- 3.8.0
+ 3.9.0-beta
The nats.io C Client, Supported by Synadia Communications Inc.
|
@@ -36,22 +35,21 @@
+Files | libevent.h | | | libuv.h | | file | libevent.h [code] | file | libuv.h [code] | ||||||
+Directories | adapters | | directory | adapters | |||||
+Files | nats.h | | | status.h | | file | nats.h [code] | file | status.h [code] | ||||||
Attempts to connect to a NATS Server.
This call supports multiple comma separated URLs. If more than one is specified, it behaves as if you were using a natsOptions object and called natsOptions_SetServers() with the equivalent array of URLs. The list is randomized before the connect sequence starts.
-| nc | the location where to store the pointer to the newly created natsConnection object. |
| urls | the URL to connect to, or the list of URLs to chose from. If NULL this call is equivalent to natsConnection_ConnectTo() with NATS_DEFAULT_URL |
| urls | the URL to connect to, or the list of URLs to chose from. If NULL this call is equivalent to natsConnection_ConnectTo() with NATS_DEFAULT_URL |
Performs a round trip to the server and return when it receives the internal reply, or if the call times-out (timeout is expressed in milliseconds).
-See possible failure case described in natsConnection_Flush().
+See possible failure case described in natsConnection_Flush().
| nc | the pointer to the natsConnection object. | ( | -natsConnection * | nc | ) | +natsConnection * | +nc | ) |
Unlike natsConnection_GetServers, this function only returns the list of servers that have been discovered after the a connection has been established (with servers version 0.9.2 and above).
+Unlike natsConnection_GetServers, this function only returns the list of servers that have been discovered after the a connection has been established (with servers version 0.9.2 and above).
No credential information is included in any of the server URLs returned by this call.
If you want to use any of these URLs to connect to a server that requires authentication, you will need to use natsOptions_SetUserInfo or natsOptions_SetToken.
| nc | the pointer to the natsConnection object. | ( | -natsConnection * | nc, | +natsConnection * | +nc, |
| - | int64_t | timeout ) | +int64_t | +timeout | +|
| + | ) | +
Identical to natsConnection_Drain but the timeout can be specified here.
+Identical to natsConnection_Drain but the timeout can be specified here.
The value is expressed in milliseconds. Zero or negative value means that the operation will not timeout.
| nc | the pointer to the natsConnection object. | ( | -natsConnection * | nc, | +natsConnection * | +nc, |
| - | const unsigned char * | message, | +const unsigned char * | +message, | |
| - | int | messageLen, | +int | +messageLen, | |
| - | unsigned char | sig[64] ) | +unsigned char | +sig[64] | +|
| + | ) | +
When a connection is created to the server, the server identifies the connection's remote IP address and return it back to the client.
| nc | the pointer to the natsConnection object. | ( | -natsConnection * | nc, | +natsConnection * | +nc, |
| - | int64_t * | rtt ) | +int64_t * | +rtt | +|
| + | ) | +
Unlike natsConnection_GetClientIP, this function returns the connection's local IP and port.
+Unlike natsConnection_GetClientIP, this function returns the connection's local IP and port.
| ( | -natsConnection * | nc | ) | +natsConnection * | +nc | ) |
Closes the connection to the server. This call will release all blocking calls, such as natsConnection_Flush() and natsSubscription_NextMsg(). The connection object is still usable until the call to natsConnection_Destroy().
+Closes the connection to the server. This call will release all blocking calls, such as natsConnection_Flush() and natsSubscription_NextMsg(). The connection object is still usable until the call to natsConnection_Destroy().
| nc | the pointer to the natsConnection object. | ( | -natsConnection * | nc | ) | +natsConnection * | +nc | ) |
+FunctionsNATS_EXTERN natsStatus | natsConnection_Publish (natsConnection *nc, const char *subj, const void *data, int dataLen) | | Publishes data on a subject. | NATS_EXTERN natsStatus | natsConnection_Publish (natsConnection *nc, const char *subj, const void *data, int dataLen) | | NATS_EXTERN natsStatus | natsConnection_PublishString (natsConnection *nc, const char *subj, const char *str) | | Publishes a string on a subject. | NATS_EXTERN natsStatus | natsConnection_PublishString (natsConnection *nc, const char *subj, const char *str) | | NATS_EXTERN natsStatus | natsConnection_PublishMsg (natsConnection *nc, natsMsg *msg) | | Publishes a message on a subject. | NATS_EXTERN natsStatus | natsConnection_PublishMsg (natsConnection *nc, natsMsg *msg) | | NATS_EXTERN natsStatus | natsConnection_PublishRequest (natsConnection *nc, const char *subj, const char *reply, const void *data, int dataLen) | | Publishes data on a subject expecting replies on the given reply. | NATS_EXTERN natsStatus | natsConnection_PublishRequest (natsConnection *nc, const char *subj, const char *reply, const void *data, int dataLen) | | NATS_EXTERN natsStatus | natsConnection_PublishRequestString (natsConnection *nc, const char *subj, const char *reply, const char *str) | | Publishes a string on a subject expecting replies on the given reply. | NATS_EXTERN natsStatus | natsConnection_PublishRequestString (natsConnection *nc, const char *subj, const char *reply, const char *str) | | 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_Request (natsMsg **replyMsg, natsConnection *nc, const char *subj, const void *data, int dataLen, int64_t timeout) | | NATS_EXTERN natsStatus | natsConnection_RequestString (natsMsg **replyMsg, natsConnection *nc, const char *subj, const char *str, int64_t timeout) | | Sends a request (as a string) and waits for a reply. | NATS_EXTERN natsStatus | natsConnection_RequestString (natsMsg **replyMsg, natsConnection *nc, const char *subj, const char *str, int64_t timeout) | | NATS_EXTERN natsStatus | natsConnection_RequestMsg (natsMsg **replyMsg, natsConnection *nc, natsMsg *requestMsg, int64_t timeout) | | Sends a request based on the given | requestMsg and waits for a reply. NATS_EXTERN natsStatus | natsConnection_RequestMsg (natsMsg **replyMsg, natsConnection *nc, natsMsg *requestMsg, int64_t timeout) | | Publishes data on a subject. More... | Publishes a string on a subject. More... | Publishes a message on a subject. More... | Publishes data on a subject expecting replies on the given reply. More... | Publishes a string on a subject expecting replies on the given reply. More... | Sends a request and waits for a reply. More... | Sends a request (as a string) and waits for a reply. More... | Sends a request based on the given requestMsg and waits for a reply. More... | ||||||||||||||||||||
Publishing functions
Convenient function to publish a string. This call is equivalent to:
| nc | the pointer to the natsConnection object. | ( | -natsConnection * | nc, | +natsConnection * | +nc, |
| - | natsMsg * | msg ) | +natsMsg * | +msg | +|
| + | ) | +
Publishes the data argument to the given subject expecting a response on the reply subject. Use natsConnection_Request() for automatically waiting for a response inline.
+Publishes the data argument to the given subject expecting a response on the reply subject. Use natsConnection_Request() for automatically waiting for a response inline.
| nc | the pointer to the natsConnection object. | ( | -natsConnection * | nc, | +natsConnection * | +nc, |
| - | const char * | subj, | +const char * | +subj, | |
| - | const char * | reply, | +const char * | +reply, | |
| - | const char * | str ) | +const char * | +str | +|
| + | ) | +
Convenient function to send a request as a string. This call is equivalent to:
| replyMsg | the location where to store the pointer to the received natsMsg reply. | ( | -natsMsg ** | replyMsg, | +natsMsg ** | +replyMsg, |
| - | natsConnection * | nc, | +natsConnection * | +nc, | |
| - | natsMsg * | requestMsg, | +natsMsg * | +requestMsg, | |
| - | int64_t | timeout ) | +int64_t | +timeout | +|
| + | ) | +
Similar to natsConnection_Request but uses requestMsg to extract subject, and payload to send.
Similar to natsConnection_Request but uses requestMsg to extract subject, and payload to send.
| replyMsg | the location where to store the pointer to the received natsMsg reply. |
|
NATS C Client with JetStream and Streaming support
- 3.8.0
+ 3.9.0-beta
The nats.io C Client, Supported by Synadia Communications Inc.
|
@@ -36,22 +35,21 @@
+FunctionsNATS_EXTERN natsStatus | natsConnection_Subscribe (natsSubscription **sub, natsConnection *nc, const char *subject, natsMsgHandler cb, void *cbClosure) | | Creates an asynchronous subscription. | NATS_EXTERN natsStatus | natsConnection_Subscribe (natsSubscription **sub, natsConnection *nc, const char *subject, natsMsgHandler cb, void *cbClosure) | | NATS_EXTERN natsStatus | natsConnection_SubscribeTimeout (natsSubscription **sub, natsConnection *nc, const char *subject, int64_t timeout, natsMsgHandler cb, void *cbClosure) | | Creates an asynchronous subscription with a timeout. | NATS_EXTERN natsStatus | natsConnection_SubscribeTimeout (natsSubscription **sub, natsConnection *nc, const char *subject, int64_t timeout, natsMsgHandler cb, void *cbClosure) | | 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) | | 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_QueueSubscribe (natsSubscription **sub, natsConnection *nc, const char *subject, const char *queueGroup, natsMsgHandler cb, void *cbClosure) | | 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. | NATS_EXTERN natsStatus | natsConnection_QueueSubscribeTimeout (natsSubscription **sub, natsConnection *nc, const char *subject, const char *queueGroup, int64_t timeout, natsMsgHandler cb, void *cbClosure) | | NATS_EXTERN natsStatus | natsConnection_QueueSubscribeSync (natsSubscription **sub, natsConnection *nc, const char *subject, const char *queueGroup) | | Creates a synchronous queue subscriber. | NATS_EXTERN natsStatus | natsConnection_QueueSubscribeSync (natsSubscription **sub, natsConnection *nc, const char *subject, const char *queueGroup) | | Creates an asynchronous subscription. More... | Creates an asynchronous subscription with a timeout. More... | Creates a synchronous subcription. More... | Creates an asynchronous queue subscriber. More... | Creates an asynchronous queue subscriber with a timeout. More... | Creates a synchronous queue subscriber. More... | ||||||||||||||||
Subscribing functions.
Similar to natsConnection_Subscribe, but creates a synchronous subscription that can be polled via natsSubscription_NextMsg().
+Similar to natsConnection_Subscribe, but creates a synchronous subscription that can be polled via natsSubscription_NextMsg().
| sub | the location where to store the pointer to the newly created natsSubscription object. | ( | -natsSubscription ** | sub, | +natsSubscription ** | +sub, |
| - | natsConnection * | nc, | +natsConnection * | +nc, | |
| - | const char * | subject, | +const char * | +subject, | |
| - | const char * | queueGroup, | +const char * | +queueGroup, | |
| - | natsMsgHandler | cb, | +natsMsgHandler | +cb, | |
| - | void * | cbClosure ) | +void * | +cbClosure | +|
| + | ) | +
Similar to natsConnection_QueueSubscribe, but creates a synchronous subscription that can be polled via natsSubscription_NextMsg().
+Similar to natsConnection_QueueSubscribe, but creates a synchronous subscription that can be polled via natsSubscription_NextMsg().
| sub | the location where to store the pointer to the newly created natsSubscription object. |
|
NATS C Client with JetStream and Streaming support
- 3.8.0
+ 3.9.0-beta
The nats.io C Client, Supported by Synadia Communications Inc.
|
@@ -36,22 +35,21 @@
You will find here the environment variables that change the default behavior of the NATS C Client library.
diff --git a/doc/html/group__func_group.html b/doc/html/group__func_group.html
index bc062d1bf..a692d355f 100644
--- a/doc/html/group__func_group.html
+++ b/doc/html/group__func_group.html
@@ -4,7 +4,7 @@
-Topics | |
| Library | |
+Modules | |
| Library | |
| Status | |
| Status | |
| Statistics | |
| Statistics | |
| Options | |
| Options | |
| Streaming Connection Options | |
| Streaming Connection Options | |
| Streaming Subscription Options | |
| Streaming Subscription Options | |
| Inboxes | |
| Inboxes | |
| Message | |
| Message | |
| Streaming Message | |
| Streaming Message | |
| Connection | |
| Connection | |
| Subscription | |
| Subscription | |
| Streaming Connection | |
| Streaming Connection | |
| Streaming Subscription | |
| Streaming Subscription | |
| JetStream | |
| JetStream | |
| KeyValue store | |
| KeyValue store | |
+FunctionsNATS_EXTERN natsStatus | natsInbox_Create (natsInbox **newInbox) | | Creates an inbox. | NATS_EXTERN natsStatus | natsInbox_Create (natsInbox **newInbox) | | NATS_EXTERN void | natsInbox_Destroy (natsInbox *inbox) | | Destroys the inbox. | NATS_EXTERN void | natsInbox_Destroy (natsInbox *inbox) | | Creates an inbox. More... | Destroys the inbox. More... | ||||||||
NATS Inboxes.
Returns an inbox string which can be used for directed replies from subscribers. These are guaranteed to be unique, but can be shared and subscribed to by others.
| newInbox | the location where to store a pointer to the newly created natsInbox. | ( | -natsInbox * | inbox | ) | +natsInbox * | +inbox | ) |
+FunctionsNATS_EXTERN natsStatus | jsStreamConfig_Init (jsStreamConfig *cfg) | | Initializes a streaming configuration structure. | NATS_EXTERN natsStatus | jsStreamConfig_Init (jsStreamConfig *cfg) | | NATS_EXTERN natsStatus | jsPlacement_Init (jsPlacement *placement) | | Initializes a placement configuration structure. | NATS_EXTERN natsStatus | jsPlacement_Init (jsPlacement *placement) | | NATS_EXTERN natsStatus | jsStreamSource_Init (jsStreamSource *source) | | Initializes a stream source configuration structure. | NATS_EXTERN natsStatus | jsStreamSource_Init (jsStreamSource *source) | | NATS_EXTERN natsStatus | jsExternalStream_Init (jsExternalStream *external) | | Initializes an external stream configuration structure. | NATS_EXTERN natsStatus | jsExternalStream_Init (jsExternalStream *external) | | NATS_EXTERN natsStatus | jsRePublish_Init (jsRePublish *rp) | | Initializes a republish structure. | NATS_EXTERN natsStatus | jsRePublish_Init (jsRePublish *rp) | | NATS_EXTERN natsStatus | js_AddStream (jsStreamInfo **si, jsCtx *js, jsStreamConfig *cfg, jsOptions *opts, jsErrCode *errCode) | | Creates a stream. | NATS_EXTERN natsStatus | js_AddStream (jsStreamInfo **si, jsCtx *js, jsStreamConfig *cfg, jsOptions *opts, jsErrCode *errCode) | | NATS_EXTERN natsStatus | js_UpdateStream (jsStreamInfo **si, jsCtx *js, jsStreamConfig *cfg, jsOptions *opts, jsErrCode *errCode) | | Updates a stream. | NATS_EXTERN natsStatus | js_UpdateStream (jsStreamInfo **si, jsCtx *js, jsStreamConfig *cfg, jsOptions *opts, jsErrCode *errCode) | | NATS_EXTERN natsStatus | js_PurgeStream (jsCtx *js, const char *stream, jsOptions *opts, jsErrCode *errCode) | | Purges a stream. | NATS_EXTERN natsStatus | js_PurgeStream (jsCtx *js, const char *stream, jsOptions *opts, jsErrCode *errCode) | | NATS_EXTERN natsStatus | js_DeleteStream (jsCtx *js, const char *stream, jsOptions *opts, jsErrCode *errCode) | | Deletes a stream. | NATS_EXTERN natsStatus | js_DeleteStream (jsCtx *js, const char *stream, jsOptions *opts, jsErrCode *errCode) | | 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_GetMsg (natsMsg **msg, jsCtx *js, const char *stream, uint64_t seq, jsOptions *opts, jsErrCode *errCode) | | NATS_EXTERN natsStatus | js_GetLastMsg (natsMsg **msg, jsCtx *js, const char *stream, const char *subject, jsOptions *opts, jsErrCode *errCode) | | Retrieves the last JetStream message from the stream for a given subject. | NATS_EXTERN natsStatus | js_GetLastMsg (natsMsg **msg, jsCtx *js, const char *stream, const char *subject, jsOptions *opts, jsErrCode *errCode) | | NATS_EXTERN natsStatus | jsDirectGetMsgOptions_Init (jsDirectGetMsgOptions *opts) | | Initializes a direct get message options structure. | NATS_EXTERN natsStatus | jsDirectGetMsgOptions_Init (jsDirectGetMsgOptions *opts) | | NATS_EXTERN natsStatus | js_DirectGetMsg (natsMsg **msg, jsCtx *js, const char *stream, jsOptions *opts, jsDirectGetMsgOptions *dgOpts) | | Retrieves directly a JetStream message based on provided options. | NATS_EXTERN natsStatus | js_DirectGetMsg (natsMsg **msg, jsCtx *js, const char *stream, jsOptions *opts, jsDirectGetMsgOptions *dgOpts) | | NATS_EXTERN natsStatus | js_DeleteMsg (jsCtx *js, const char *stream, uint64_t seq, jsOptions *opts, jsErrCode *errCode) | | Deletes a message from the stream. | NATS_EXTERN natsStatus | js_DeleteMsg (jsCtx *js, const char *stream, uint64_t seq, jsOptions *opts, jsErrCode *errCode) | | NATS_EXTERN natsStatus | js_EraseMsg (jsCtx *js, const char *stream, uint64_t seq, jsOptions *opts, jsErrCode *errCode) | | Erases a message from the stream. | NATS_EXTERN natsStatus | js_EraseMsg (jsCtx *js, const char *stream, uint64_t seq, jsOptions *opts, jsErrCode *errCode) | | 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) | | NATS_EXTERN void | jsStreamInfo_Destroy (jsStreamInfo *si) | | Destroys the stream information object. | NATS_EXTERN void | jsStreamInfo_Destroy (jsStreamInfo *si) | | NATS_EXTERN natsStatus | js_Streams (jsStreamInfoList **list, jsCtx *js, jsOptions *opts, jsErrCode *errCode) | | Retrieves the list of all available streams. | NATS_EXTERN natsStatus | js_Streams (jsStreamInfoList **list, jsCtx *js, jsOptions *opts, jsErrCode *errCode) | | NATS_EXTERN void | jsStreamInfoList_Destroy (jsStreamInfoList *list) | | Destroys the stream information list object. | NATS_EXTERN void | jsStreamInfoList_Destroy (jsStreamInfoList *list) | | NATS_EXTERN natsStatus | js_StreamNames (jsStreamNamesList **list, jsCtx *js, jsOptions *opts, jsErrCode *errCode) | | Retrieves the list of all available stream names. | NATS_EXTERN natsStatus | js_StreamNames (jsStreamNamesList **list, jsCtx *js, jsOptions *opts, jsErrCode *errCode) | | NATS_EXTERN void | jsStreamNamesList_Destroy (jsStreamNamesList *list) | | Destroys the stream names list object. | NATS_EXTERN void | jsStreamNamesList_Destroy (jsStreamNamesList *list) | | NATS_EXTERN natsStatus | jsConsumerConfig_Init (jsConsumerConfig *cc) | | Initializes a consumer configuration structure. | NATS_EXTERN natsStatus | jsConsumerConfig_Init (jsConsumerConfig *cc) | | NATS_EXTERN natsStatus | js_AddConsumer (jsConsumerInfo **ci, jsCtx *js, const char *stream, jsConsumerConfig *cfg, jsOptions *opts, jsErrCode *errCode) | | Adds a JetStream consumer. | NATS_EXTERN natsStatus | js_AddConsumer (jsConsumerInfo **ci, jsCtx *js, const char *stream, jsConsumerConfig *cfg, jsOptions *opts, jsErrCode *errCode) | | NATS_EXTERN natsStatus | js_UpdateConsumer (jsConsumerInfo **ci, jsCtx *js, const char *stream, jsConsumerConfig *cfg, jsOptions *opts, jsErrCode *errCode) | | Updates a JetStream consumer. | NATS_EXTERN natsStatus | js_UpdateConsumer (jsConsumerInfo **ci, jsCtx *js, const char *stream, jsConsumerConfig *cfg, jsOptions *opts, jsErrCode *errCode) | | NATS_EXTERN natsStatus | js_GetConsumerInfo (jsConsumerInfo **ci, jsCtx *js, const char *stream, const char *consumer, jsOptions *opts, jsErrCode *errCode) | | Retrieves information about a consumer. | NATS_EXTERN natsStatus | js_GetConsumerInfo (jsConsumerInfo **ci, jsCtx *js, const char *stream, const char *consumer, jsOptions *opts, jsErrCode *errCode) | | NATS_EXTERN natsStatus | js_DeleteConsumer (jsCtx *js, const char *stream, const char *consumer, jsOptions *opts, jsErrCode *errCode) | | Deletes a consumer. | NATS_EXTERN natsStatus | js_DeleteConsumer (jsCtx *js, const char *stream, const char *consumer, jsOptions *opts, jsErrCode *errCode) | | NATS_EXTERN void | jsConsumerInfo_Destroy (jsConsumerInfo *ci) | | Destroys the consumer information object. | 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. More... | | NATS_EXTERN void | jsConsumerPauseResponse_Destroy (jsConsumerPauseResponse *cpr) | | Destroys the PauseConsumer response object. More... | | NATS_EXTERN void | jsConsumerInfo_Destroy (jsConsumerInfo *ci) | | NATS_EXTERN natsStatus | js_Consumers (jsConsumerInfoList **list, jsCtx *js, const char *stream, jsOptions *opts, jsErrCode *errCode) | | Retrieves the list of all available consumers for a stream. | NATS_EXTERN natsStatus | js_Consumers (jsConsumerInfoList **list, jsCtx *js, const char *stream, jsOptions *opts, jsErrCode *errCode) | | NATS_EXTERN void | jsConsumerInfoList_Destroy (jsConsumerInfoList *list) | | Destroys the consumer information list object. | NATS_EXTERN void | jsConsumerInfoList_Destroy (jsConsumerInfoList *list) | | NATS_EXTERN natsStatus | js_ConsumerNames (jsConsumerNamesList **list, jsCtx *js, const char *stream, jsOptions *opts, jsErrCode *errCode) | | Retrieves the list of all available consumer names for a stream. | NATS_EXTERN natsStatus | js_ConsumerNames (jsConsumerNamesList **list, jsCtx *js, const char *stream, jsOptions *opts, jsErrCode *errCode) | | NATS_EXTERN void | jsConsumerNamesList_Destroy (jsConsumerNamesList *list) | | Destroys the consumer names list object. | NATS_EXTERN void | jsConsumerNamesList_Destroy (jsConsumerNamesList *list) | | NATS_EXTERN natsStatus | js_GetAccountInfo (jsAccountInfo **ai, jsCtx *js, jsOptions *opts, jsErrCode *errCode) | | Retrieves information about the JetStream usage from an account. | NATS_EXTERN natsStatus | js_GetAccountInfo (jsAccountInfo **ai, jsCtx *js, jsOptions *opts, jsErrCode *errCode) | | NATS_EXTERN void | jsAccountInfo_Destroy (jsAccountInfo *ai) | | Destroys the account information object. | NATS_EXTERN void | jsAccountInfo_Destroy (jsAccountInfo *ai) | | Initializes a streaming configuration structure. More... | Initializes a placement configuration structure. More... | Initializes a stream source configuration structure. More... | Initializes an external stream configuration structure. More... | Initializes a republish structure. More... | Creates a stream. More... | Updates a stream. More... | Purges a stream. More... | Deletes a stream. More... | Retrieves a JetStream message from the stream by sequence. More... | Retrieves the last JetStream message from the stream for a given subject. More... | Initializes a direct get message options structure. More... | Retrieves directly a JetStream message based on provided options. More... | Deletes a message from the stream. More... | Erases a message from the stream. More... | Retreives information from a stream. More... | Destroys the stream information object. More... | Retrieves the list of all available streams. More... | Destroys the stream information list object. More... | Retrieves the list of all available stream names. More... | Destroys the stream names list object. More... | Initializes a consumer configuration structure. More... | Adds a JetStream consumer. More... | Updates a JetStream consumer. More... | Retrieves information about a consumer. More... | Deletes a consumer. More... | Destroys the consumer information object. More... | Retrieves the list of all available consumers for a stream. More... | Destroys the consumer information list object. More... | Retrieves the list of all available consumer names for a stream. More... | Destroys the consumer names list object. More... | Retrieves information about the JetStream usage from an account. More... | Destroys the account information object. More... | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
JetStream Assets Management
Creates a stream based on the provided configuration (that cannot be NULL). The name is mandatory and cannot contain . characters.
NULL, otherwise, on success you are responsible for freeing this object.| si | the location where to store the pointer to the new jsStreamInfo object in response to the creation request, or NULL if the stream information is not needed. | ( | -jsStreamInfo ** | si, | +jsStreamInfo ** | +si, |
| - | jsCtx * | js, | +jsCtx * | +js, | |
| - | jsStreamConfig * | cfg, | +jsStreamConfig * | +cfg, | |
| - | jsOptions * | opts, | +jsOptions * | +opts, | |
| - | jsErrCode * | errCode ) | +jsErrCode * | +errCode | +|
| + | ) | +
Updates a stream based on the provided configuration (that cannot be NULL). The name is mandatory and cannot contain . characters.
NULL, otherwise, on success you are responsible for freeing this object.| si | the location where to store the pointer to the new jsStreamInfo object in response to the creation request, or NULL if the stream information is not needed. | ( | -jsCtx * | js, | +jsCtx * | +js, |
| - | const char * | stream, | +const char * | +stream, | |
| - | jsOptions * | opts, | +jsOptions * | +opts, | |
| - | jsErrCode * | errCode ) | +jsErrCode * | +errCode | +|
| + | ) | +
Retrieves a raw stream message stored in JetStream by sequence number.
Retrieves the last JetStream message from the stream for a given subject.
Use this before setting specific direct get message options and passing it to js_DirectGetMsg API.
+Use this before setting specific direct get message options and passing it to js_DirectGetMsg API.
| opts | the pointer to the jsDirectGetMsgOptions object. | ( | -natsMsg ** | msg, | +natsMsg ** | +msg, |
| - | jsCtx * | js, | +jsCtx * | +js, | |
| - | const char * | stream, | +const char * | +stream, | |
| - | jsOptions * | opts, | +jsOptions * | +opts, | |
| - | jsDirectGetMsgOptions * | dgOpts ) | +jsDirectGetMsgOptions * | +dgOpts | +|
| + | ) | +
If a stream is created with AllowDirect, it is possible to retrieve a message without going through the leader.
To specify the options, call jsDirectGetMsgOptions_Init first and the set the appropriate options, then invoke this function.
+To specify the options, call jsDirectGetMsgOptions_Init first and the set the appropriate options, then invoke this function.
v2.9.0+. If running against an older server the call will likely timeout.Deletes the message at sequence seq in the stream named stream.
| js | the pointer to the jsCtx context. | ( | -jsCtx * | js, | +jsCtx * | +js, |
| - | const char * | stream, | +const char * | +stream, | |
| - | uint64_t | seq, | +uint64_t | +seq, | |
| - | jsOptions * | opts, | +jsOptions * | +opts, | |
| - | jsErrCode * | errCode ) | +jsErrCode * | +errCode | +|
| + | ) | +
Similar to js_DeleteMsg except that the content of the deleted message is erased from stable storage.
-Similar to js_DeleteMsg except that the content of the deleted message is erased from stable storage.
+| js | the pointer to the jsCtx context. | ( | -jsStreamInfo ** | si, | +jsStreamInfo ** | +si, |
| - | jsCtx * | js, | +jsCtx * | +js, | |
| - | const char * | stream, | +const char * | +stream, | |
| - | jsOptions * | opts, | +jsOptions * | +opts, | |
| - | jsErrCode * | errCode ) | +jsErrCode * | +errCode | +|
| + | ) | +
| si | the location where to store the pointer to the new jsStreamInfo object in response to the creation request. | ( | -jsStreamInfo * | si | ) | +jsStreamInfo * | +si | ) |
Retrieves the list of all jsStreamInfo. It is possible to filter which streams are to be retrieved based on a subject filter.
-| list | the location where to store the pointer to the new jsStreamInfoList object. | ( | -jsStreamInfoList * | list | ) | +jsStreamInfoList * | +list | ) |
Retrieves the list of all stream names. It is possible to filter which streams are to be retrieved based on a subject filter.
-| list | the location where to store the pointer to the new jsStreamNamesList object. | ( | -jsStreamNamesList * | list | ) | +jsStreamNamesList * | +list | ) |
Adds a consumer based on the provided configuration (that cannot be NULL).
NULL, otherwise, on success you are responsible for freeing this object.| ci | the location where to store the pointer to the new jsConsumerInfo object in response to the creation request, or NULL if the consumer information is not needed. | ( | -jsConsumerInfo ** | ci, | +jsConsumerInfo ** | +ci, |
| - | jsCtx * | js, | +jsCtx * | +js, | |
| - | const char * | stream, | +const char * | +stream, | |
| - | jsConsumerConfig * | cfg, | +jsConsumerConfig * | +cfg, | |
| - | jsOptions * | opts, | +jsOptions * | +opts, | |
| - | jsErrCode * | errCode ) | +jsErrCode * | +errCode | +|
| + | ) | +
Updates a consumer based on the provided configuration (that cannot be NULL).
NULL, otherwise, on success you are responsible for freeing this object.| ci | the location where to store the pointer to the new jsConsumerInfo object in response to the creation request, or NULL if the consumer information is not needed. | ( | -jsConsumerInfo ** | ci, | +jsConsumerInfo ** | +ci, |
| - | jsCtx * | js, | +jsCtx * | +js, | |
| - | const char * | stream, | +const char * | +stream, | |
| - | const char * | consumer, | +const char * | +consumer, | |
| - | jsOptions * | opts, | +jsOptions * | +opts, | |
| - | jsErrCode * | errCode ) | +jsErrCode * | +errCode | +|
| + | ) | +
| ci | the location where to store the pointer to the new jsConsumerInfo object. | ( | -jsCtx * | js, | +jsCtx * | +js, |
| - | const char * | stream, | +const char * | +stream, | |
| - | const char * | consumer, | +const char * | +consumer, | |
| - | jsOptions * | opts, | +jsOptions * | +opts, | |
| - | jsErrCode * | errCode ) | +jsErrCode * | +errCode | +|
| + | ) | +
| NATS_EXTERN natsStatus js_PauseConsumer | +( | +jsConsumerPauseResponse ** | +new_cpr, | +
| + | + | jsCtx * | +js, | +
| + | + | const char * | +stream, | +
| + | + | const char * | +consumer, | +
| + | + | uint64_t | +pauseUntil, | +
| + | + | jsOptions * | +opts, | +
| + | + | jsErrCode * | +errCode | +
| + | ) | ++ |
Pauses the consumer named consumer on stream named stream.
| new_cpr | if not NULL, will receive the response of the operation. |
| js | the pointer to the jsCtx context. |
| stream | the name of the stream. |
| consumer | the name of the consumer. |
| pauseUntil | the time in nanoseconds since the Unix epoch to pause the consumer until. |
| opts | the pointer to the jsOptions object, possibly NULL. |
| errCode | the location where to store the JetStream specific error code, or NULL if not needed. |
| NATS_EXTERN void jsConsumerPauseResponse_Destroy | +( | +jsConsumerPauseResponse * | +cpr | ) | ++ |
Releases memory allocated for this object.
+| cpr | the pointer to the jsConsumerPauseResponse object. |
Retrieves the list of all jsConsumerInfo for a given stream.
-| list | the location where to store the pointer to the new jsConsumerInfoList object. | ( | -jsConsumerInfoList * | list | ) | +jsConsumerInfoList * | +list | ) |
Retrieves the list of all consumer names for a given stream.
-| list | the location where to store the pointer to the new jsConsumerNamesList object. | ( | -jsConsumerNamesList * | list | ) | +jsConsumerNamesList * | +list | ) |
Retrieves information about the JetStream usage from an account.
-| ai | the location where to store the pointer to the new jsAccountInfo object in response to the account information request. | ( | -jsAccountInfo * | ai | ) | +jsAccountInfo * | +ai | ) |
-Topics | |
| JetStream Assets Management | |
+Modules | |
| JetStream Assets Management | |
| Publishing | |
| Publishing | |
| Subscribing | |
| Subscribing | |
| Messages | |
| Messages | |
+FunctionsNATS_EXTERN natsStatus | jsOptions_Init (jsOptions *opts) | | Initializes a streaming context options structure. | NATS_EXTERN natsStatus | jsOptions_Init (jsOptions *opts) | | NATS_EXTERN natsStatus | natsConnection_JetStream (jsCtx **js, natsConnection *nc, jsOptions *opts) | | Returns a new JetStream context. | NATS_EXTERN natsStatus | natsConnection_JetStream (jsCtx **js, natsConnection *nc, jsOptions *opts) | | NATS_EXTERN void | jsCtx_Destroy (jsCtx *js) | | Destroys the JetStream context. | NATS_EXTERN void | jsCtx_Destroy (jsCtx *js) | | Initializes a streaming context options structure. More... | Returns a new JetStream context. More... | Destroys the JetStream context. More... | ||||||||||
JetStream.
+FunctionsNATS_EXTERN natsStatus | natsMsg_GetMetaData (jsMsgMetaData **new_meta, natsMsg *msg) | | Returns metadata from this JetStream message. | NATS_EXTERN natsStatus | natsMsg_GetMetaData (jsMsgMetaData **new_meta, natsMsg *msg) | | NATS_EXTERN void | jsMsgMetaData_Destroy (jsMsgMetaData *meta) | | Destroys the message metadata object. | NATS_EXTERN void | jsMsgMetaData_Destroy (jsMsgMetaData *meta) | | NATS_EXTERN natsStatus | natsMsg_Ack (natsMsg *msg, jsOptions *opts) | | Acknowledges a message. | NATS_EXTERN natsStatus | natsMsg_Ack (natsMsg *msg, jsOptions *opts) | | NATS_EXTERN natsStatus | natsMsg_AckSync (natsMsg *msg, jsOptions *opts, jsErrCode *errCode) | | Acknowledges a message and wait for a confirmation. | NATS_EXTERN natsStatus | natsMsg_AckSync (natsMsg *msg, jsOptions *opts, jsErrCode *errCode) | | NATS_EXTERN natsStatus | natsMsg_Nak (natsMsg *msg, jsOptions *opts) | | Negatively acknowledges a message. | NATS_EXTERN natsStatus | natsMsg_Nak (natsMsg *msg, jsOptions *opts) | | NATS_EXTERN natsStatus | natsMsg_NakWithDelay (natsMsg *msg, int64_t delay, jsOptions *opts) | | Negatively acknowledges a message. | NATS_EXTERN natsStatus | natsMsg_NakWithDelay (natsMsg *msg, int64_t delay, jsOptions *opts) | | NATS_EXTERN natsStatus | natsMsg_InProgress (natsMsg *msg, jsOptions *opts) | | Resets redelivery timer on the server. | NATS_EXTERN natsStatus | natsMsg_InProgress (natsMsg *msg, jsOptions *opts) | | NATS_EXTERN natsStatus | natsMsg_Term (natsMsg *msg, jsOptions *opts) | | Abandon this message. | NATS_EXTERN natsStatus | natsMsg_Term (natsMsg *msg, jsOptions *opts) | | NATS_EXTERN uint64_t | natsMsg_GetSequence (natsMsg *msg) | | Returns the sequence number of this JetStream message. | NATS_EXTERN uint64_t | natsMsg_GetSequence (natsMsg *msg) | | NATS_EXTERN int64_t | natsMsg_GetTime (natsMsg *msg) | | Returns the timestamp (in UTC) of this JetStream message. | NATS_EXTERN int64_t | natsMsg_GetTime (natsMsg *msg) | | Returns metadata from this JetStream message. More... | Destroys the message metadata object. More... | Acknowledges a message. More... | Acknowledges a message and wait for a confirmation. More... | Negatively acknowledges a message. More... | Negatively acknowledges a message. More... | Resets redelivery timer on the server. More... | Abandon this message. More... | Returns the sequence number of this JetStream message. More... | Returns the timestamp (in UTC) of this JetStream message. More... | ||||||||||||||||||||||||
Function specific to JetStream messages
This works only for JetStream messages that have been received through a subscription callback or calling natsSubscription_NextMsg.
-This is the synchronous version of natsMsg_Ack. This indicates successful message processing, and waits for confirmation from the server that the acknowledgment has been processed.
+This is the synchronous version of natsMsg_Ack. This indicates successful message processing, and waits for confirmation from the server that the acknowledgment has been processed.
| msg | the pointer to the natsMsg object. | ( | -natsMsg * | msg, | +natsMsg * | +msg, |
| - | jsOptions * | opts ) | +jsOptions * | +opts | +|
| + | ) | +
+FunctionsNATS_EXTERN natsStatus | jsPubOptions_Init (jsPubOptions *opts) | | Initializes a publish options structure. | NATS_EXTERN natsStatus | jsPubOptions_Init (jsPubOptions *opts) | | NATS_EXTERN natsStatus | js_Publish (jsPubAck **pubAck, jsCtx *js, const char *subj, const void *data, int dataLen, jsPubOptions *opts, jsErrCode *errCode) | | Publishes data on a subject to JetStream. | NATS_EXTERN natsStatus | js_Publish (jsPubAck **pubAck, jsCtx *js, const char *subj, const void *data, int dataLen, jsPubOptions *opts, jsErrCode *errCode) | | NATS_EXTERN natsStatus | js_PublishMsg (jsPubAck **pubAck, jsCtx *js, natsMsg *msg, jsPubOptions *opts, jsErrCode *errCode) | | Publishes a message to JetStream. | NATS_EXTERN natsStatus | js_PublishMsg (jsPubAck **pubAck, jsCtx *js, natsMsg *msg, jsPubOptions *opts, jsErrCode *errCode) | | NATS_EXTERN void | jsPubAck_Destroy (jsPubAck *pubAck) | | Destroys the publish acknowledgment object. | NATS_EXTERN void | jsPubAck_Destroy (jsPubAck *pubAck) | | NATS_EXTERN natsStatus | js_PublishAsync (jsCtx *js, const char *subj, const void *data, int dataLen, jsPubOptions *opts) | | Publishes data to JetStream but does not wait for a jsPubAck. | NATS_EXTERN natsStatus | js_PublishAsync (jsCtx *js, const char *subj, const void *data, int dataLen, jsPubOptions *opts) | | NATS_EXTERN natsStatus | js_PublishMsgAsync (jsCtx *js, natsMsg **msg, jsPubOptions *opts) | | Publishes a message to JetStream but does not wait for a jsPubAck. | NATS_EXTERN natsStatus | js_PublishMsgAsync (jsCtx *js, natsMsg **msg, jsPubOptions *opts) | | NATS_EXTERN natsStatus | js_PublishAsyncComplete (jsCtx *js, jsPubOptions *opts) | | Wait for all outstanding messages to be acknowledged. | NATS_EXTERN natsStatus | js_PublishAsyncComplete (jsCtx *js, jsPubOptions *opts) | | NATS_EXTERN natsStatus | js_PublishAsyncGetPendingList (natsMsgList *pending, jsCtx *js) | | Returns the list of pending messages published asynchronously. | NATS_EXTERN natsStatus | js_PublishAsyncGetPendingList (natsMsgList *pending, jsCtx *js) | | Initializes a publish options structure. More... | Publishes data on a subject to JetStream. More... | Publishes a message to JetStream. More... | Destroys the publish acknowledgment object. More... | Publishes data to JetStream but does not wait for a jsPubAck. More... | Publishes a message to JetStream but does not wait for a jsPubAck. More... | Wait for all outstanding messages to be acknowledged. More... | Returns the list of pending messages published asynchronously. More... | ||||||||||||||||||||
Publishing functions
Publishes the data to the given subject to JetStream.
-See js_PublishMsg for details.
+See js_PublishMsg for details.
| pubAck | the location where to store the pub acknowledgment, or NULL if not needed. | ( | -jsPubAck ** | pubAck, | +jsPubAck ** | +pubAck, |
| - | jsCtx * | js, | +jsCtx * | +js, | |
| - | natsMsg * | msg, | +natsMsg * | +msg, | |
| - | jsPubOptions * | opts, | +jsPubOptions * | +opts, | |
| - | jsErrCode * | errCode ) | +jsErrCode * | +errCode | +|
| + | ) | +
Publishes the given message to JetStream.
NULL, but keep in mind that the publish acknowledgment is still sent by the server. | pubAck | the location where to store the pub acknowledgment, or NULL if not needed. | ( | -jsPubAck * | pubAck | ) | +jsPubAck * | +pubAck | ) |
See js_PublishMsgAsync for details.
+See js_PublishMsgAsync for details.
| js | the pointer to the jsCtx object. | ( | -jsCtx * | js, | +jsCtx * | +js, |
| - | natsMsg ** | msg, | +natsMsg ** | +msg, | |
| - | jsPubOptions * | opts ) | +jsPubOptions * | +opts | +|
| + | ) | +
Publishes a message asynchronously to JetStream. User can call js_PublishAsyncComplete to be notified when all publish acknowledgments for the pending publish calls have been received.
+Publishes a message asynchronously to JetStream. User can call js_PublishAsyncComplete to be notified when all publish acknowledgments for the pending publish calls have been received.
NULL.