<trclass="memdesc:ga388bfeaa5a78ebf6ce7c15c6e3a7156b"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Initializes a republish structure. <br/></td></tr>
<trclass="memdesc:ga9fe289ae172f83e53ca1b1b747744c1f"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Retrieves a JetStream message from the stream by sequence. <br/></td></tr>
<trclass="memdesc:ga6835b53da27d5721eddb3698e582cf0c"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Retrieves the last JetStream message from the stream for a given subject. <br/></td></tr>
<trclass="memdesc:ga8d835d47aed9c84ce3b8dcfea469f4cb"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Initializes a direct get message options structure. <br/></td></tr>
<trclass="memdesc:ga62c250cecc650b1eed0fa1691893e2ae"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Retrieves directly a JetStream message based on provided options. <br/></td></tr>
<trclass="memdesc:gaeba5d45abbe811c0e40830c5f26c78fd"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Deletes a message from the stream. <br/></td></tr>
<trclass="memdesc:ga7158f73e183462e9a15e9802e1746ff0"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Erases a message from the stream. <br/></td></tr>
<trclass="memdesc:ga94cb23a35516b7779de28fcbb263180a"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Retreives information from a stream. <br/></td></tr>
<trclass="memdesc:ga8ee87ef86e94be42685941abe9638bbd"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Destroys the stream information object. <br/></td></tr>
<trclass="memdesc:ga531d91de372f0dffb8d64abecf88b0c0"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Retrieves the list of all available streams. <br/></td></tr>
<trclass="memdesc:ga38cdcc339eb8976d23296b99aa37d629"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Destroys the stream information list object. <br/></td></tr>
<trclass="memdesc:gac3dfc87863dbbb3c959ecde4bce905bc"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Retrieves the list of all available stream names. <br/></td></tr>
<trclass="memdesc:gaf8644f281d4e24893a6a170b4f7faa65"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Destroys the stream names list object. <br/></td></tr>
<trclass="memdesc:gad13ec256e24710bb237995814871e554"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Updates a JetStream consumer. <br/></td></tr>
<trclass="memdesc:ga2dda04757b4ab27a794b64f8d727fe23"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Retrieves information about a consumer. <br/></td></tr>
<trclass="memdesc:ga9c1d5ed2f24ba836c10e415231f80088"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Destroys the consumer information object. <br/></td></tr>
<trclass="memdesc:gaf28097ede3e9ba9926fb00856e63ffd9"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Retrieves the list of all available consumers for a stream. <br/></td></tr>
<trclass="memdesc:ga421de40d8e91658353111c3f2ea90ec8"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Destroys the consumer information list object. <br/></td></tr>
<trclass="memdesc:ga690d19af55d12b82c8523d1861cef8d0"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Retrieves the list of all available consumer names for a stream. <br/></td></tr>
<trclass="memdesc:ga2ced0d190131460bf4608ab893dffc50"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Destroys the consumer names list object. <br/></td></tr>
<trclass="memdesc:gac8965dcfc6b465fbc323aa552c606c46"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Retrieves information about the JetStream usage from an account. <br/></td></tr>
<trclass="memdesc:ga7c8664b38fcce8497746367d35e5f60b"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Destroys the account information object. <br/></td></tr>
<p>Use this before setting specific external stream options.</p>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">external</td><td>the pointer to the <aclass="el"href="structjs_external_stream.html">jsExternalStream</a> to initialize. </td></tr>
<p>Creates a stream based on the provided configuration (that cannot be <code>NULL</code>). The name is mandatory and cannot contain <code>.</code> characters.</p>
<dlclass="section note"><dt>Note</dt><dd>If you do not need a <aclass="el"href="structjs_stream_info.html">jsStreamInfo</a> to be returned, you can pass <code>NULL</code>, otherwise, on success you are responsible for freeing this object.</dd></dl>
<dlclass="section see"><dt>See also</dt><dd><aclass="el"href="group__js_assets_group.html#gac230f71dbdc4d10bc7471d01763881d6"title="Initializes a streaming configuration structure.">jsStreamConfig_Init</a></dd>
<dd>
<aclass="el"href="group__js_assets_group.html#ga8ee87ef86e94be42685941abe9638bbd"title="Destroys the stream information object.">jsStreamInfo_Destroy</a></dd></dl>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">si</td><td>the location where to store the pointer to the new <aclass="el"href="structjs_stream_info.html">jsStreamInfo</a> object in response to the creation request, or <code>NULL</code> if the stream information is not needed. </td></tr>
<tr><tdclass="paramname">js</td><td>the pointer to the <aclass="el"href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> context. </td></tr>
<tr><tdclass="paramname">cfg</td><td>the pointer to the <aclass="el"href="structjs_stream_config.html">jsStreamConfig</a>. </td></tr>
<tr><tdclass="paramname">opts</td><td>the pointer to the <aclass="el"href="structjs_options.html">jsOptions</a> object, possibly <code>NULL</code>. </td></tr>
<tr><tdclass="paramname">errCode</td><td>the location where to store the JetStream specific error code, or <code>NULL</code> if not needed. </td></tr>
<p>Updates a stream based on the provided configuration (that cannot be <code>NULL</code>). The name is mandatory and cannot contain <code>.</code> characters.</p>
<dlclass="section note"><dt>Note</dt><dd>If you do not need a <aclass="el"href="structjs_stream_info.html">jsStreamInfo</a> to be returned, you can pass <code>NULL</code>, otherwise, on success you are responsible for freeing this object.</dd></dl>
<dlclass="section see"><dt>See also</dt><dd><aclass="el"href="group__js_assets_group.html#gac230f71dbdc4d10bc7471d01763881d6"title="Initializes a streaming configuration structure.">jsStreamConfig_Init</a></dd>
<dd>
<aclass="el"href="group__js_assets_group.html#ga8ee87ef86e94be42685941abe9638bbd"title="Destroys the stream information object.">jsStreamInfo_Destroy</a></dd></dl>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">si</td><td>the location where to store the pointer to the new <aclass="el"href="structjs_stream_info.html">jsStreamInfo</a> object in response to the creation request, or <code>NULL</code> if the stream information is not needed. </td></tr>
<tr><tdclass="paramname">js</td><td>the pointer to the <aclass="el"href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> context. </td></tr>
<tr><tdclass="paramname">cfg</td><td>the pointer to the <aclass="el"href="structjs_stream_config.html">jsStreamConfig</a>. </td></tr>
<tr><tdclass="paramname">opts</td><td>the pointer to the <aclass="el"href="structjs_options.html">jsOptions</a> object, possibly <code>NULL</code>. </td></tr>
<tr><tdclass="paramname">errCode</td><td>the location where to store the JetStream specific error code, or <code>NULL</code> if not needed. </td></tr>
</div><!-- fragment --><dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">js</td><td>the pointer to the <aclass="el"href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> context. </td></tr>
<tr><tdclass="paramname">stream</td><td>the name of the stream to purge. </td></tr>
<tr><tdclass="paramname">opts</td><td>the pointer to the <aclass="el"href="structjs_options.html">jsOptions</a> object, possibly <code>NULL</code>. </td></tr>
<tr><tdclass="paramname">errCode</td><td>the location where to store the JetStream specific error code, or <code>NULL</code> if not needed. </td></tr>
<p>Deletes the stream named <code>stream</code>.</p>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">js</td><td>the pointer to the <aclass="el"href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> context. </td></tr>
<tr><tdclass="paramname">stream</td><td>the name of the stream to delete. </td></tr>
<tr><tdclass="paramname">opts</td><td>the pointer to the <aclass="el"href="structjs_options.html">jsOptions</a> object, possibly <code>NULL</code>. </td></tr>
<tr><tdclass="paramname">errCode</td><td>the location where to store the JetStream specific error code, or <code>NULL</code> if not needed. </td></tr>
<p>Retrieves a raw stream message stored in JetStream by sequence number.</p>
<dlclass="section note"><dt>Note</dt><dd>The message needs to be destroyed by calling <aclass="el"href="group__msg_group.html#ga9e9590018284939f43f60964283f33ae"title="Destroys the message object.">natsMsg_Destroy</a>.</dd></dl>
<dlclass="section see"><dt>See also</dt><dd><aclass="el"href="group__js_assets_group.html#ga6835b53da27d5721eddb3698e582cf0c"title="Retrieves the last JetStream message from the stream for a given subject.">js_GetLastMsg</a></dd>
<dd>
<aclass="el"href="group__msg_group.html#ga9e9590018284939f43f60964283f33ae"title="Destroys the message object.">natsMsg_Destroy</a></dd></dl>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">msg</td><td>the memory location where the library will store the pointer to the <aclass="el"href="group__types_group.html#gadcab54026c4ed78f344ce03ce31bb61a"title="A structure holding a subject, optional reply and payload.">natsMsg</a>. </td></tr>
<tr><tdclass="paramname">js</td><td>the pointer to the <aclass="el"href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> context. </td></tr>
<tr><tdclass="paramname">stream</td><td>the name of the stream. </td></tr>
<tr><tdclass="paramname">seq</td><td>the sequence in the stream of the message being retrieved. </td></tr>
<tr><tdclass="paramname">opts</td><td>the pointer to the <aclass="el"href="structjs_options.html">jsOptions</a> object, possibly <code>NULL</code>. </td></tr>
<tr><tdclass="paramname">errCode</td><td>the location where to store the JetStream specific error code, or <code>NULL</code> if not needed. </td></tr>
<p>Retrieves the last JetStream message from the stream for a given subject.</p>
<dlclass="section note"><dt>Note</dt><dd>The message needs to be destroyed by calling <aclass="el"href="group__msg_group.html#ga9e9590018284939f43f60964283f33ae"title="Destroys the message object.">natsMsg_Destroy</a>.</dd></dl>
<dlclass="section see"><dt>See also</dt><dd><aclass="el"href="group__js_assets_group.html#ga9fe289ae172f83e53ca1b1b747744c1f"title="Retrieves a JetStream message from the stream by sequence.">js_GetMsg</a></dd>
<dd>
<aclass="el"href="group__msg_group.html#ga9e9590018284939f43f60964283f33ae"title="Destroys the message object.">natsMsg_Destroy</a></dd></dl>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">msg</td><td>the memory location where the library will store the pointer to the <aclass="el"href="group__types_group.html#gadcab54026c4ed78f344ce03ce31bb61a"title="A structure holding a subject, optional reply and payload.">natsMsg</a>. </td></tr>
<tr><tdclass="paramname">js</td><td>the pointer to the <aclass="el"href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> context. </td></tr>
<tr><tdclass="paramname">stream</td><td>the name of the stream. </td></tr>
<tr><tdclass="paramname">subject</td><td>the subject for which the last message is being retrieved. </td></tr>
<tr><tdclass="paramname">opts</td><td>the pointer to the <aclass="el"href="structjs_options.html">jsOptions</a> object, possibly <code>NULL</code>. </td></tr>
<tr><tdclass="paramname">errCode</td><td>the location where to store the JetStream specific error code, or <code>NULL</code> if not needed. </td></tr>
<p>Use this before setting specific direct get message options and passing it to <aclass="el"href="group__js_assets_group.html#ga62c250cecc650b1eed0fa1691893e2ae"title="Retrieves directly a JetStream message based on provided options.">js_DirectGetMsg</a> API.</p>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">opts</td><td>the pointer to the <aclass="el"href="structjs_direct_get_msg_options.html">jsDirectGetMsgOptions</a> object. </td></tr>
<p>If a stream is created with <code>AllowDirect</code>, it is possible to retrieve a message without going through the leader.</p>
<p>To specify the options, call <aclass="el"href="group__js_assets_group.html#ga8d835d47aed9c84ce3b8dcfea469f4cb"title="Initializes a direct get message options structure.">jsDirectGetMsgOptions_Init</a> first and the set the appropriate options, then invoke this function.</p>
<dlclass="section note"><dt>Note</dt><dd>Some options are mutually exclusive but the library is not doing the check and leave it to the server to do it and return the error returned by the server.</dd>
<dd>
This API can only be used against servers that support the direct get feature, which is <code>v2.9.0+</code>. If running against an older server the call will likely timeout.</dd></dl>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">msg</td><td>the location where to store the pointer to the retrieved message. </td></tr>
<tr><tdclass="paramname">js</td><td>the pointer to the <aclass="el"href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> context. </td></tr>
<tr><tdclass="paramname">stream</td><td>the name of the stream. </td></tr>
<tr><tdclass="paramname">opts</td><td>the pointer to the <aclass="el"href="structjs_options.html">jsOptions</a> object, possibly <code>NULL</code>. </td></tr>
<tr><tdclass="paramname">dgOpts</td><td>the pointer to the <aclass="el"href="structjs_direct_get_msg_options.html">jsDirectGetMsgOptions</a> object, cannot be <code>NULL</code>. </td></tr>
<p>Deletes the message at sequence <code>seq</code> in the stream named <code>stream</code>.</p>
<dlclass="section note"><dt>Note</dt><dd>To completely erase the content of the deleted message when stored on disk, use <aclass="el"href="group__js_assets_group.html#ga7158f73e183462e9a15e9802e1746ff0"title="Erases a message from the stream.">js_EraseMsg</a> instead.</dd></dl>
<dlclass="section see"><dt>See also</dt><dd><aclass="el"href="group__js_assets_group.html#ga7158f73e183462e9a15e9802e1746ff0"title="Erases a message from the stream.">js_EraseMsg</a></dd></dl>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">js</td><td>the pointer to the <aclass="el"href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> context. </td></tr>
<tr><tdclass="paramname">stream</td><td>the name of the stream. </td></tr>
<tr><tdclass="paramname">seq</td><td>the sequence in the stream of the message to delete. </td></tr>
<tr><tdclass="paramname">opts</td><td>the pointer to the <aclass="el"href="structjs_options.html">jsOptions</a> object, possibly <code>NULL</code>. </td></tr>
<tr><tdclass="paramname">errCode</td><td>the location where to store the JetStream specific error code, or <code>NULL</code> if not needed. </td></tr>
<p>Similar to <aclass="el"href="group__js_assets_group.html#gaeba5d45abbe811c0e40830c5f26c78fd"title="Deletes a message from the stream.">js_DeleteMsg</a> except that the content of the deleted message is erased from stable storage.</p>
<dlclass="section see"><dt>See also</dt><dd><aclass="el"href="group__js_assets_group.html#gaeba5d45abbe811c0e40830c5f26c78fd"title="Deletes a message from the stream.">js_DeleteMsg</a></dd></dl>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">js</td><td>the pointer to the <aclass="el"href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> context. </td></tr>
<tr><tdclass="paramname">stream</td><td>the name of the stream. </td></tr>
<tr><tdclass="paramname">seq</td><td>the sequence in the stream of the message to erase. </td></tr>
<tr><tdclass="paramname">opts</td><td>the pointer to the <aclass="el"href="structjs_options.html">jsOptions</a> object, possibly <code>NULL</code>. </td></tr>
<tr><tdclass="paramname">errCode</td><td>the location where to store the JetStream specific error code, or <code>NULL</code> if not needed. </td></tr>
</div><!-- fragment --><dlclass="section see"><dt>See also</dt><dd><aclass="el"href="group__js_assets_group.html#ga8ee87ef86e94be42685941abe9638bbd"title="Destroys the stream information object.">jsStreamInfo_Destroy</a></dd></dl>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">si</td><td>the location where to store the pointer to the new <aclass="el"href="structjs_stream_info.html">jsStreamInfo</a> object in response to the creation request. </td></tr>
<tr><tdclass="paramname">js</td><td>the pointer to the <aclass="el"href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> context. </td></tr>
<tr><tdclass="paramname">stream</td><td>the name of the stream which information is retrieved. </td></tr>
<tr><tdclass="paramname">opts</td><td>the pointer to the <aclass="el"href="structjs_options.html">jsOptions</a> object, possibly <code>NULL</code>. </td></tr>
<tr><tdclass="paramname">errCode</td><td>the location where to store the JetStream specific error code, or <code>NULL</code> if not needed. </td></tr>
<p>Retrieves the list of all <aclass="el"href="structjs_stream_info.html">jsStreamInfo</a>. It is possible to filter which streams are to be retrieved based on a subject filter.</p>
<dlclass="section warning"><dt>Warning</dt><dd>The list should be destroyed when no longer used by calling <aclass="el"href="group__js_assets_group.html#ga38cdcc339eb8976d23296b99aa37d629"title="Destroys the stream information list object.">jsStreamInfoList_Destroy</a>.</dd></dl>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">list</td><td>the location where to store the pointer to the new <aclass="el"href="structjs_stream_info_list.html">jsStreamInfoList</a> object. </td></tr>
<tr><tdclass="paramname">js</td><td>the pointer to the <aclass="el"href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> context. </td></tr>
<tr><tdclass="paramname">opts</td><td>the pointer to the <aclass="el"href="structjs_options.html">jsOptions</a> object, possibly <code>NULL</code>. </td></tr>
<tr><tdclass="paramname">errCode</td><td>the location where to store the JetStream specific error code, or <code>NULL</code> if not needed. </td></tr>
<p>Releases memory allocated for this stream information list.</p>
<dlclass="section warning"><dt>Warning</dt><dd>All <aclass="el"href="structjs_stream_info.html">jsStreamInfo</a> pointers contained in the list will be destroyed by this call.</dd></dl>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">list</td><td>the pointer to the <aclass="el"href="structjs_stream_info_list.html">jsStreamInfoList</a> object. </td></tr>
<p>Retrieves the list of all stream names. It is possible to filter which streams are to be retrieved based on a subject filter.</p>
<dlclass="section warning"><dt>Warning</dt><dd>The list should be destroyed when no longer used by calling <aclass="el"href="group__js_assets_group.html#gaf8644f281d4e24893a6a170b4f7faa65"title="Destroys the stream names list object.">jsStreamNamesList_Destroy</a>.</dd></dl>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">list</td><td>the location where to store the pointer to the new <aclass="el"href="structjs_stream_names_list.html">jsStreamNamesList</a> object. </td></tr>
<tr><tdclass="paramname">js</td><td>the pointer to the <aclass="el"href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> context. </td></tr>
<tr><tdclass="paramname">opts</td><td>the pointer to the <aclass="el"href="structjs_options.html">jsOptions</a> object, possibly <code>NULL</code>. </td></tr>
<tr><tdclass="paramname">errCode</td><td>the location where to store the JetStream specific error code, or <code>NULL</code> if not needed. </td></tr>
<p>Adds a consumer based on the provided configuration (that cannot be <code>NULL</code>).</p>
<dlclass="section note"><dt>Note</dt><dd>If you do not need a <aclass="el"href="structjs_consumer_info.html">jsConsumerInfo</a> to be returned, you can pass <code>NULL</code>, otherwise, on success you are responsible for freeing this object.</dd></dl>
<dlclass="section see"><dt>See also</dt><dd><aclass="el"href="group__js_assets_group.html#ga3381bb05c05bf4a8979adde68d37dd66"title="Initializes a consumer configuration structure.">jsConsumerConfig_Init</a></dd>
<dd>
<aclass="el"href="group__js_assets_group.html#ga9c1d5ed2f24ba836c10e415231f80088"title="Destroys the consumer information object.">jsConsumerInfo_Destroy</a></dd></dl>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">ci</td><td>the location where to store the pointer to the new <aclass="el"href="structjs_consumer_info.html">jsConsumerInfo</a> object in response to the creation request, or <code>NULL</code> if the consumer information is not needed. </td></tr>
<tr><tdclass="paramname">js</td><td>the pointer to the <aclass="el"href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> context. </td></tr>
<tr><tdclass="paramname">stream</td><td>the name of the stream. </td></tr>
<tr><tdclass="paramname">cfg</td><td>the pointer to the <aclass="el"href="structjs_consumer_config.html">jsConsumerConfig</a>. </td></tr>
<tr><tdclass="paramname">opts</td><td>the pointer to the <aclass="el"href="structjs_options.html">jsOptions</a> object, possibly <code>NULL</code>. </td></tr>
<tr><tdclass="paramname">errCode</td><td>the location where to store the JetStream specific error code, or <code>NULL</code> if not needed. </td></tr>
<p>Updates a consumer based on the provided configuration (that cannot be <code>NULL</code>).</p>
<dlclass="section note"><dt>Note</dt><dd>If you do not need a <aclass="el"href="structjs_consumer_info.html">jsConsumerInfo</a> to be returned, you can pass <code>NULL</code>, otherwise, on success you are responsible for freeing this object.</dd></dl>
<dlclass="section see"><dt>See also</dt><dd><aclass="el"href="group__js_assets_group.html#ga3381bb05c05bf4a8979adde68d37dd66"title="Initializes a consumer configuration structure.">jsConsumerConfig_Init</a></dd>
<dd>
<aclass="el"href="group__js_assets_group.html#ga9c1d5ed2f24ba836c10e415231f80088"title="Destroys the consumer information object.">jsConsumerInfo_Destroy</a></dd></dl>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">ci</td><td>the location where to store the pointer to the new <aclass="el"href="structjs_consumer_info.html">jsConsumerInfo</a> object in response to the creation request, or <code>NULL</code> if the consumer information is not needed. </td></tr>
<tr><tdclass="paramname">js</td><td>the pointer to the <aclass="el"href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> context. </td></tr>
<tr><tdclass="paramname">stream</td><td>the name of the stream. </td></tr>
<tr><tdclass="paramname">cfg</td><td>the pointer to the <aclass="el"href="structjs_consumer_config.html">jsConsumerConfig</a>. </td></tr>
<tr><tdclass="paramname">opts</td><td>the pointer to the <aclass="el"href="structjs_options.html">jsOptions</a> object, possibly <code>NULL</code>. </td></tr>
<tr><tdclass="paramname">errCode</td><td>the location where to store the JetStream specific error code, or <code>NULL</code> if not needed. </td></tr>
<dlclass="section note"><dt>Note</dt><dd>The returned object should be destroyed using <aclass="el"href="group__js_assets_group.html#ga9c1d5ed2f24ba836c10e415231f80088"title="Destroys the consumer information object.">jsConsumerInfo_Destroy</a> in order to free allocated memory.</dd></dl>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">ci</td><td>the location where to store the pointer to the new <aclass="el"href="structjs_consumer_info.html">jsConsumerInfo</a> object. </td></tr>
<tr><tdclass="paramname">js</td><td>the pointer to the <aclass="el"href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> context. </td></tr>
<tr><tdclass="paramname">stream</td><td>the name of the stream. </td></tr>
<tr><tdclass="paramname">consumer</td><td>the name of the consumer. </td></tr>
<tr><tdclass="paramname">opts</td><td>the pointer to the <aclass="el"href="structjs_options.html">jsOptions</a> object, possibly <code>NULL</code>. </td></tr>
<tr><tdclass="paramname">errCode</td><td>the location where to store the JetStream specific error code, or <code>NULL</code> if not needed. </td></tr>
<p>Deletes the consumer named <code>consumer</code> from stream named <code>stream</code>.</p>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">js</td><td>the pointer to the <aclass="el"href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> context. </td></tr>
<tr><tdclass="paramname">stream</td><td>the name of the stream. </td></tr>
<tr><tdclass="paramname">consumer</td><td>the name of the consumer. </td></tr>
<tr><tdclass="paramname">opts</td><td>the pointer to the <aclass="el"href="structjs_options.html">jsOptions</a> object, possibly <code>NULL</code>. </td></tr>
<tr><tdclass="paramname">errCode</td><td>the location where to store the JetStream specific error code, or <code>NULL</code> if not needed. </td></tr>
<p>Retrieves the list of all <aclass="el"href="structjs_consumer_info.html">jsConsumerInfo</a> for a given stream.</p>
<dlclass="section warning"><dt>Warning</dt><dd>The list should be destroyed when no longer used by calling <aclass="el"href="group__js_assets_group.html#ga421de40d8e91658353111c3f2ea90ec8"title="Destroys the consumer information list object.">jsConsumerInfoList_Destroy</a>.</dd></dl>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">list</td><td>the location where to store the pointer to the new <aclass="el"href="structjs_consumer_info_list.html">jsConsumerInfoList</a> object. </td></tr>
<tr><tdclass="paramname">js</td><td>the pointer to the <aclass="el"href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> context. </td></tr>
<tr><tdclass="paramname">stream</td><td>the stream name whose consumer list is requested. </td></tr>
<tr><tdclass="paramname">opts</td><td>the pointer to the <aclass="el"href="structjs_options.html">jsOptions</a> object, possibly <code>NULL</code>. </td></tr>
<tr><tdclass="paramname">errCode</td><td>the location where to store the JetStream specific error code, or <code>NULL</code> if not needed. </td></tr>
<p>Releases memory allocated for this consumer information list.</p>
<dlclass="section warning"><dt>Warning</dt><dd>All <aclass="el"href="structjs_consumer_info.html">jsConsumerInfo</a> pointers contained in the list will be destroyed by this call.</dd></dl>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">list</td><td>the pointer to the <aclass="el"href="structjs_consumer_info_list.html">jsConsumerInfoList</a> object. </td></tr>
<p>Retrieves the list of all consumer names for a given stream.</p>
<dlclass="section warning"><dt>Warning</dt><dd>The list should be destroyed when no longer used by calling <aclass="el"href="group__js_assets_group.html#ga2ced0d190131460bf4608ab893dffc50"title="Destroys the consumer names list object.">jsConsumerNamesList_Destroy</a>.</dd></dl>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">list</td><td>the location where to store the pointer to the new <aclass="el"href="structjs_consumer_names_list.html">jsConsumerNamesList</a> object. </td></tr>
<tr><tdclass="paramname">js</td><td>the pointer to the <aclass="el"href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> context. </td></tr>
<tr><tdclass="paramname">stream</td><td>the stream name whose consumer list is requested. </td></tr>
<tr><tdclass="paramname">opts</td><td>the pointer to the <aclass="el"href="structjs_options.html">jsOptions</a> object, possibly <code>NULL</code>. </td></tr>
<tr><tdclass="paramname">errCode</td><td>the location where to store the JetStream specific error code, or <code>NULL</code> if not needed. </td></tr>
<p>Releases memory allocated for this list of consumer names.</p>
<dlclass="section warning"><dt>Warning</dt><dd>All string pointers contained in the list will be destroyed by this call.</dd></dl>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">list</td><td>the pointer to the <aclass="el"href="structjs_consumer_names_list.html">jsConsumerNamesList</a> object. </td></tr>
<p>Retrieves information about the JetStream usage from an account.</p>
<dlclass="section note"><dt>Note</dt><dd>The returned object should be destroyed using <aclass="el"href="group__js_assets_group.html#ga7c8664b38fcce8497746367d35e5f60b"title="Destroys the account information object.">jsAccountInfo_Destroy</a> in order to free allocated memory.</dd></dl>
<dlclass="params"><dt>Parameters</dt><dd>
<tableclass="params">
<tr><tdclass="paramname">ai</td><td>the location where to store the pointer to the new <aclass="el"href="structjs_account_info.html">jsAccountInfo</a> object in response to the account information request. </td></tr>
<tr><tdclass="paramname">js</td><td>the pointer to the <aclass="el"href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> context. </td></tr>
<tr><tdclass="paramname">opts</td><td>the pointer to the <aclass="el"href="structjs_options.html">jsOptions</a> object, possibly <code>NULL</code>. </td></tr>
<tr><tdclass="paramname">errCode</td><td>the location where to store the JetStream specific error code, or <code>NULL</code> if not needed. </td></tr>