torque
79a45fd2e3
subrepo: subdir: "deps/nats.c" merged: "66cec7f" upstream: origin: "https://github.com/nats-io/nats.c.git" branch: "v3.6.1" commit: "66cec7f" git-subrepo: version: "0.4.6" commit: "b8b46501e"
1708 lines
112 KiB
HTML
1708 lines
112 KiB
HTML
<!-- HTML header for doxygen 1.8.10-->
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.9.6"/>
|
|
<title>NATS C Client with JetStream and Streaming support: JetStream Assets Management</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="customdoxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;" >
|
|
<div id="projectname">NATS C Client with JetStream and Streaming support
|
|
 <span id="projectnumber">3.6.1</span>
|
|
</div>
|
|
<div id="projectbrief">The nats.io C Client, Supported by Synadia Communications Inc.</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.6 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('group__js_assets_group.html',''); initResizable(); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle"><div class="title">JetStream Assets Management<div class="ingroups"><a class="el" href="group__func_group.html">Functions</a> » <a class="el" href="group__js_group.html">JetStream</a></div></div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:gac230f71dbdc4d10bc7471d01763881d6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__js_assets_group.html#gac230f71dbdc4d10bc7471d01763881d6">jsStreamConfig_Init</a> (<a class="el" href="structjs_stream_config.html">jsStreamConfig</a> *cfg)</td></tr>
|
|
<tr class="memdesc:gac230f71dbdc4d10bc7471d01763881d6"><td class="mdescLeft"> </td><td class="mdescRight">Initializes a streaming configuration structure. <br /></td></tr>
|
|
<tr class="separator:gac230f71dbdc4d10bc7471d01763881d6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga223691e6831072a0b8f8103a778293b0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__js_assets_group.html#ga223691e6831072a0b8f8103a778293b0">jsPlacement_Init</a> (<a class="el" href="structjs_placement.html">jsPlacement</a> *placement)</td></tr>
|
|
<tr class="memdesc:ga223691e6831072a0b8f8103a778293b0"><td class="mdescLeft"> </td><td class="mdescRight">Initializes a placement configuration structure. <br /></td></tr>
|
|
<tr class="separator:ga223691e6831072a0b8f8103a778293b0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga7fe8e0bf98a38eb59372e7cd78aaaf56"><td class="memItemLeft" align="right" valign="top"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__js_assets_group.html#ga7fe8e0bf98a38eb59372e7cd78aaaf56">jsStreamSource_Init</a> (<a class="el" href="structjs_stream_source.html">jsStreamSource</a> *source)</td></tr>
|
|
<tr class="memdesc:ga7fe8e0bf98a38eb59372e7cd78aaaf56"><td class="mdescLeft"> </td><td class="mdescRight">Initializes a stream source configuration structure. <br /></td></tr>
|
|
<tr class="separator:ga7fe8e0bf98a38eb59372e7cd78aaaf56"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga81aebebcd79922104720da51e95020d4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__js_assets_group.html#ga81aebebcd79922104720da51e95020d4">jsExternalStream_Init</a> (<a class="el" href="structjs_external_stream.html">jsExternalStream</a> *external)</td></tr>
|
|
<tr class="memdesc:ga81aebebcd79922104720da51e95020d4"><td class="mdescLeft"> </td><td class="mdescRight">Initializes an external stream configuration structure. <br /></td></tr>
|
|
<tr class="separator:ga81aebebcd79922104720da51e95020d4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga388bfeaa5a78ebf6ce7c15c6e3a7156b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__js_assets_group.html#ga388bfeaa5a78ebf6ce7c15c6e3a7156b">jsRePublish_Init</a> (<a class="el" href="structjs_re_publish.html">jsRePublish</a> *rp)</td></tr>
|
|
<tr class="memdesc:ga388bfeaa5a78ebf6ce7c15c6e3a7156b"><td class="mdescLeft"> </td><td class="mdescRight">Initializes a republish structure. <br /></td></tr>
|
|
<tr class="separator:ga388bfeaa5a78ebf6ce7c15c6e3a7156b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga5efc5136d33ba52161e6732f88f1ee75"><td class="memItemLeft" align="right" valign="top"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__js_assets_group.html#ga5efc5136d33ba52161e6732f88f1ee75">js_AddStream</a> (<a class="el" href="structjs_stream_info.html">jsStreamInfo</a> **si, <a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> *js, <a class="el" href="structjs_stream_config.html">jsStreamConfig</a> *cfg, <a class="el" href="structjs_options.html">jsOptions</a> *opts, <a class="el" href="status_8h.html#a10731415ffcd3e2330df10c4d5fd3d70">jsErrCode</a> *errCode)</td></tr>
|
|
<tr class="memdesc:ga5efc5136d33ba52161e6732f88f1ee75"><td class="mdescLeft"> </td><td class="mdescRight">Creates a stream. <br /></td></tr>
|
|
<tr class="separator:ga5efc5136d33ba52161e6732f88f1ee75"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga75a5c44304e24481c67e17fbccc15c31"><td class="memItemLeft" align="right" valign="top"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__js_assets_group.html#ga75a5c44304e24481c67e17fbccc15c31">js_UpdateStream</a> (<a class="el" href="structjs_stream_info.html">jsStreamInfo</a> **si, <a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> *js, <a class="el" href="structjs_stream_config.html">jsStreamConfig</a> *cfg, <a class="el" href="structjs_options.html">jsOptions</a> *opts, <a class="el" href="status_8h.html#a10731415ffcd3e2330df10c4d5fd3d70">jsErrCode</a> *errCode)</td></tr>
|
|
<tr class="memdesc:ga75a5c44304e24481c67e17fbccc15c31"><td class="mdescLeft"> </td><td class="mdescRight">Updates a stream. <br /></td></tr>
|
|
<tr class="separator:ga75a5c44304e24481c67e17fbccc15c31"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga5a6a886c18a79caa403908bf7f7ef125"><td class="memItemLeft" align="right" valign="top"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__js_assets_group.html#ga5a6a886c18a79caa403908bf7f7ef125">js_PurgeStream</a> (<a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> *js, const char *stream, <a class="el" href="structjs_options.html">jsOptions</a> *opts, <a class="el" href="status_8h.html#a10731415ffcd3e2330df10c4d5fd3d70">jsErrCode</a> *errCode)</td></tr>
|
|
<tr class="memdesc:ga5a6a886c18a79caa403908bf7f7ef125"><td class="mdescLeft"> </td><td class="mdescRight">Purges a stream. <br /></td></tr>
|
|
<tr class="separator:ga5a6a886c18a79caa403908bf7f7ef125"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga397e55a0b3b6d36c9bf746eee3842172"><td class="memItemLeft" align="right" valign="top"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__js_assets_group.html#ga397e55a0b3b6d36c9bf746eee3842172">js_DeleteStream</a> (<a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> *js, const char *stream, <a class="el" href="structjs_options.html">jsOptions</a> *opts, <a class="el" href="status_8h.html#a10731415ffcd3e2330df10c4d5fd3d70">jsErrCode</a> *errCode)</td></tr>
|
|
<tr class="memdesc:ga397e55a0b3b6d36c9bf746eee3842172"><td class="mdescLeft"> </td><td class="mdescRight">Deletes a stream. <br /></td></tr>
|
|
<tr class="separator:ga397e55a0b3b6d36c9bf746eee3842172"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga9fe289ae172f83e53ca1b1b747744c1f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__js_assets_group.html#ga9fe289ae172f83e53ca1b1b747744c1f">js_GetMsg</a> (<a class="el" href="group__types_group.html#gadcab54026c4ed78f344ce03ce31bb61a">natsMsg</a> **msg, <a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> *js, const char *stream, uint64_t seq, <a class="el" href="structjs_options.html">jsOptions</a> *opts, <a class="el" href="status_8h.html#a10731415ffcd3e2330df10c4d5fd3d70">jsErrCode</a> *errCode)</td></tr>
|
|
<tr class="memdesc:ga9fe289ae172f83e53ca1b1b747744c1f"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a JetStream message from the stream by sequence. <br /></td></tr>
|
|
<tr class="separator:ga9fe289ae172f83e53ca1b1b747744c1f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga6835b53da27d5721eddb3698e582cf0c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__js_assets_group.html#ga6835b53da27d5721eddb3698e582cf0c">js_GetLastMsg</a> (<a class="el" href="group__types_group.html#gadcab54026c4ed78f344ce03ce31bb61a">natsMsg</a> **msg, <a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> *js, const char *stream, const char *subject, <a class="el" href="structjs_options.html">jsOptions</a> *opts, <a class="el" href="status_8h.html#a10731415ffcd3e2330df10c4d5fd3d70">jsErrCode</a> *errCode)</td></tr>
|
|
<tr class="memdesc:ga6835b53da27d5721eddb3698e582cf0c"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the last JetStream message from the stream for a given subject. <br /></td></tr>
|
|
<tr class="separator:ga6835b53da27d5721eddb3698e582cf0c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga8d835d47aed9c84ce3b8dcfea469f4cb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__js_assets_group.html#ga8d835d47aed9c84ce3b8dcfea469f4cb">jsDirectGetMsgOptions_Init</a> (<a class="el" href="structjs_direct_get_msg_options.html">jsDirectGetMsgOptions</a> *opts)</td></tr>
|
|
<tr class="memdesc:ga8d835d47aed9c84ce3b8dcfea469f4cb"><td class="mdescLeft"> </td><td class="mdescRight">Initializes a direct get message options structure. <br /></td></tr>
|
|
<tr class="separator:ga8d835d47aed9c84ce3b8dcfea469f4cb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga62c250cecc650b1eed0fa1691893e2ae"><td class="memItemLeft" align="right" valign="top"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__js_assets_group.html#ga62c250cecc650b1eed0fa1691893e2ae">js_DirectGetMsg</a> (<a class="el" href="group__types_group.html#gadcab54026c4ed78f344ce03ce31bb61a">natsMsg</a> **msg, <a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> *js, const char *stream, <a class="el" href="structjs_options.html">jsOptions</a> *opts, <a class="el" href="structjs_direct_get_msg_options.html">jsDirectGetMsgOptions</a> *dgOpts)</td></tr>
|
|
<tr class="memdesc:ga62c250cecc650b1eed0fa1691893e2ae"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves directly a JetStream message based on provided options. <br /></td></tr>
|
|
<tr class="separator:ga62c250cecc650b1eed0fa1691893e2ae"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaeba5d45abbe811c0e40830c5f26c78fd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__js_assets_group.html#gaeba5d45abbe811c0e40830c5f26c78fd">js_DeleteMsg</a> (<a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> *js, const char *stream, uint64_t seq, <a class="el" href="structjs_options.html">jsOptions</a> *opts, <a class="el" href="status_8h.html#a10731415ffcd3e2330df10c4d5fd3d70">jsErrCode</a> *errCode)</td></tr>
|
|
<tr class="memdesc:gaeba5d45abbe811c0e40830c5f26c78fd"><td class="mdescLeft"> </td><td class="mdescRight">Deletes a message from the stream. <br /></td></tr>
|
|
<tr class="separator:gaeba5d45abbe811c0e40830c5f26c78fd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga7158f73e183462e9a15e9802e1746ff0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__js_assets_group.html#ga7158f73e183462e9a15e9802e1746ff0">js_EraseMsg</a> (<a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> *js, const char *stream, uint64_t seq, <a class="el" href="structjs_options.html">jsOptions</a> *opts, <a class="el" href="status_8h.html#a10731415ffcd3e2330df10c4d5fd3d70">jsErrCode</a> *errCode)</td></tr>
|
|
<tr class="memdesc:ga7158f73e183462e9a15e9802e1746ff0"><td class="mdescLeft"> </td><td class="mdescRight">Erases a message from the stream. <br /></td></tr>
|
|
<tr class="separator:ga7158f73e183462e9a15e9802e1746ff0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga94cb23a35516b7779de28fcbb263180a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__js_assets_group.html#ga94cb23a35516b7779de28fcbb263180a">js_GetStreamInfo</a> (<a class="el" href="structjs_stream_info.html">jsStreamInfo</a> **si, <a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> *js, const char *stream, <a class="el" href="structjs_options.html">jsOptions</a> *opts, <a class="el" href="status_8h.html#a10731415ffcd3e2330df10c4d5fd3d70">jsErrCode</a> *errCode)</td></tr>
|
|
<tr class="memdesc:ga94cb23a35516b7779de28fcbb263180a"><td class="mdescLeft"> </td><td class="mdescRight">Retreives information from a stream. <br /></td></tr>
|
|
<tr class="separator:ga94cb23a35516b7779de28fcbb263180a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga8ee87ef86e94be42685941abe9638bbd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__js_assets_group.html#ga8ee87ef86e94be42685941abe9638bbd">jsStreamInfo_Destroy</a> (<a class="el" href="structjs_stream_info.html">jsStreamInfo</a> *si)</td></tr>
|
|
<tr class="memdesc:ga8ee87ef86e94be42685941abe9638bbd"><td class="mdescLeft"> </td><td class="mdescRight">Destroys the stream information object. <br /></td></tr>
|
|
<tr class="separator:ga8ee87ef86e94be42685941abe9638bbd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga531d91de372f0dffb8d64abecf88b0c0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__js_assets_group.html#ga531d91de372f0dffb8d64abecf88b0c0">js_Streams</a> (<a class="el" href="structjs_stream_info_list.html">jsStreamInfoList</a> **list, <a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> *js, <a class="el" href="structjs_options.html">jsOptions</a> *opts, <a class="el" href="status_8h.html#a10731415ffcd3e2330df10c4d5fd3d70">jsErrCode</a> *errCode)</td></tr>
|
|
<tr class="memdesc:ga531d91de372f0dffb8d64abecf88b0c0"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the list of all available streams. <br /></td></tr>
|
|
<tr class="separator:ga531d91de372f0dffb8d64abecf88b0c0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga38cdcc339eb8976d23296b99aa37d629"><td class="memItemLeft" align="right" valign="top"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__js_assets_group.html#ga38cdcc339eb8976d23296b99aa37d629">jsStreamInfoList_Destroy</a> (<a class="el" href="structjs_stream_info_list.html">jsStreamInfoList</a> *list)</td></tr>
|
|
<tr class="memdesc:ga38cdcc339eb8976d23296b99aa37d629"><td class="mdescLeft"> </td><td class="mdescRight">Destroys the stream information list object. <br /></td></tr>
|
|
<tr class="separator:ga38cdcc339eb8976d23296b99aa37d629"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gac3dfc87863dbbb3c959ecde4bce905bc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__js_assets_group.html#gac3dfc87863dbbb3c959ecde4bce905bc">js_StreamNames</a> (<a class="el" href="structjs_stream_names_list.html">jsStreamNamesList</a> **list, <a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> *js, <a class="el" href="structjs_options.html">jsOptions</a> *opts, <a class="el" href="status_8h.html#a10731415ffcd3e2330df10c4d5fd3d70">jsErrCode</a> *errCode)</td></tr>
|
|
<tr class="memdesc:gac3dfc87863dbbb3c959ecde4bce905bc"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the list of all available stream names. <br /></td></tr>
|
|
<tr class="separator:gac3dfc87863dbbb3c959ecde4bce905bc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaf8644f281d4e24893a6a170b4f7faa65"><td class="memItemLeft" align="right" valign="top"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__js_assets_group.html#gaf8644f281d4e24893a6a170b4f7faa65">jsStreamNamesList_Destroy</a> (<a class="el" href="structjs_stream_names_list.html">jsStreamNamesList</a> *list)</td></tr>
|
|
<tr class="memdesc:gaf8644f281d4e24893a6a170b4f7faa65"><td class="mdescLeft"> </td><td class="mdescRight">Destroys the stream names list object. <br /></td></tr>
|
|
<tr class="separator:gaf8644f281d4e24893a6a170b4f7faa65"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga3381bb05c05bf4a8979adde68d37dd66"><td class="memItemLeft" align="right" valign="top"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__js_assets_group.html#ga3381bb05c05bf4a8979adde68d37dd66">jsConsumerConfig_Init</a> (<a class="el" href="structjs_consumer_config.html">jsConsumerConfig</a> *cc)</td></tr>
|
|
<tr class="memdesc:ga3381bb05c05bf4a8979adde68d37dd66"><td class="mdescLeft"> </td><td class="mdescRight">Initializes a consumer configuration structure. <br /></td></tr>
|
|
<tr class="separator:ga3381bb05c05bf4a8979adde68d37dd66"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaf2efb63db150e782d9007090b49d4115"><td class="memItemLeft" align="right" valign="top"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__js_assets_group.html#gaf2efb63db150e782d9007090b49d4115">js_AddConsumer</a> (<a class="el" href="structjs_consumer_info.html">jsConsumerInfo</a> **ci, <a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> *js, const char *stream, <a class="el" href="structjs_consumer_config.html">jsConsumerConfig</a> *cfg, <a class="el" href="structjs_options.html">jsOptions</a> *opts, <a class="el" href="status_8h.html#a10731415ffcd3e2330df10c4d5fd3d70">jsErrCode</a> *errCode)</td></tr>
|
|
<tr class="memdesc:gaf2efb63db150e782d9007090b49d4115"><td class="mdescLeft"> </td><td class="mdescRight">Adds a JetStream consumer. <br /></td></tr>
|
|
<tr class="separator:gaf2efb63db150e782d9007090b49d4115"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gad13ec256e24710bb237995814871e554"><td class="memItemLeft" align="right" valign="top"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__js_assets_group.html#gad13ec256e24710bb237995814871e554">js_UpdateConsumer</a> (<a class="el" href="structjs_consumer_info.html">jsConsumerInfo</a> **ci, <a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> *js, const char *stream, <a class="el" href="structjs_consumer_config.html">jsConsumerConfig</a> *cfg, <a class="el" href="structjs_options.html">jsOptions</a> *opts, <a class="el" href="status_8h.html#a10731415ffcd3e2330df10c4d5fd3d70">jsErrCode</a> *errCode)</td></tr>
|
|
<tr class="memdesc:gad13ec256e24710bb237995814871e554"><td class="mdescLeft"> </td><td class="mdescRight">Updates a JetStream consumer. <br /></td></tr>
|
|
<tr class="separator:gad13ec256e24710bb237995814871e554"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga2dda04757b4ab27a794b64f8d727fe23"><td class="memItemLeft" align="right" valign="top"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__js_assets_group.html#ga2dda04757b4ab27a794b64f8d727fe23">js_GetConsumerInfo</a> (<a class="el" href="structjs_consumer_info.html">jsConsumerInfo</a> **ci, <a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> *js, const char *stream, const char *consumer, <a class="el" href="structjs_options.html">jsOptions</a> *opts, <a class="el" href="status_8h.html#a10731415ffcd3e2330df10c4d5fd3d70">jsErrCode</a> *errCode)</td></tr>
|
|
<tr class="memdesc:ga2dda04757b4ab27a794b64f8d727fe23"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves information about a consumer. <br /></td></tr>
|
|
<tr class="separator:ga2dda04757b4ab27a794b64f8d727fe23"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga52fbc61759b11494db91f348a733c490"><td class="memItemLeft" align="right" valign="top"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__js_assets_group.html#ga52fbc61759b11494db91f348a733c490">js_DeleteConsumer</a> (<a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> *js, const char *stream, const char *consumer, <a class="el" href="structjs_options.html">jsOptions</a> *opts, <a class="el" href="status_8h.html#a10731415ffcd3e2330df10c4d5fd3d70">jsErrCode</a> *errCode)</td></tr>
|
|
<tr class="memdesc:ga52fbc61759b11494db91f348a733c490"><td class="mdescLeft"> </td><td class="mdescRight">Deletes a consumer. <br /></td></tr>
|
|
<tr class="separator:ga52fbc61759b11494db91f348a733c490"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga9c1d5ed2f24ba836c10e415231f80088"><td class="memItemLeft" align="right" valign="top"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__js_assets_group.html#ga9c1d5ed2f24ba836c10e415231f80088">jsConsumerInfo_Destroy</a> (<a class="el" href="structjs_consumer_info.html">jsConsumerInfo</a> *ci)</td></tr>
|
|
<tr class="memdesc:ga9c1d5ed2f24ba836c10e415231f80088"><td class="mdescLeft"> </td><td class="mdescRight">Destroys the consumer information object. <br /></td></tr>
|
|
<tr class="separator:ga9c1d5ed2f24ba836c10e415231f80088"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaf28097ede3e9ba9926fb00856e63ffd9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__js_assets_group.html#gaf28097ede3e9ba9926fb00856e63ffd9">js_Consumers</a> (<a class="el" href="structjs_consumer_info_list.html">jsConsumerInfoList</a> **list, <a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> *js, const char *stream, <a class="el" href="structjs_options.html">jsOptions</a> *opts, <a class="el" href="status_8h.html#a10731415ffcd3e2330df10c4d5fd3d70">jsErrCode</a> *errCode)</td></tr>
|
|
<tr class="memdesc:gaf28097ede3e9ba9926fb00856e63ffd9"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the list of all available consumers for a stream. <br /></td></tr>
|
|
<tr class="separator:gaf28097ede3e9ba9926fb00856e63ffd9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga421de40d8e91658353111c3f2ea90ec8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__js_assets_group.html#ga421de40d8e91658353111c3f2ea90ec8">jsConsumerInfoList_Destroy</a> (<a class="el" href="structjs_consumer_info_list.html">jsConsumerInfoList</a> *list)</td></tr>
|
|
<tr class="memdesc:ga421de40d8e91658353111c3f2ea90ec8"><td class="mdescLeft"> </td><td class="mdescRight">Destroys the consumer information list object. <br /></td></tr>
|
|
<tr class="separator:ga421de40d8e91658353111c3f2ea90ec8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga690d19af55d12b82c8523d1861cef8d0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__js_assets_group.html#ga690d19af55d12b82c8523d1861cef8d0">js_ConsumerNames</a> (<a class="el" href="structjs_consumer_names_list.html">jsConsumerNamesList</a> **list, <a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> *js, const char *stream, <a class="el" href="structjs_options.html">jsOptions</a> *opts, <a class="el" href="status_8h.html#a10731415ffcd3e2330df10c4d5fd3d70">jsErrCode</a> *errCode)</td></tr>
|
|
<tr class="memdesc:ga690d19af55d12b82c8523d1861cef8d0"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the list of all available consumer names for a stream. <br /></td></tr>
|
|
<tr class="separator:ga690d19af55d12b82c8523d1861cef8d0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga2ced0d190131460bf4608ab893dffc50"><td class="memItemLeft" align="right" valign="top"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__js_assets_group.html#ga2ced0d190131460bf4608ab893dffc50">jsConsumerNamesList_Destroy</a> (<a class="el" href="structjs_consumer_names_list.html">jsConsumerNamesList</a> *list)</td></tr>
|
|
<tr class="memdesc:ga2ced0d190131460bf4608ab893dffc50"><td class="mdescLeft"> </td><td class="mdescRight">Destroys the consumer names list object. <br /></td></tr>
|
|
<tr class="separator:ga2ced0d190131460bf4608ab893dffc50"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gac8965dcfc6b465fbc323aa552c606c46"><td class="memItemLeft" align="right" valign="top"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__js_assets_group.html#gac8965dcfc6b465fbc323aa552c606c46">js_GetAccountInfo</a> (<a class="el" href="structjs_account_info.html">jsAccountInfo</a> **ai, <a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> *js, <a class="el" href="structjs_options.html">jsOptions</a> *opts, <a class="el" href="status_8h.html#a10731415ffcd3e2330df10c4d5fd3d70">jsErrCode</a> *errCode)</td></tr>
|
|
<tr class="memdesc:gac8965dcfc6b465fbc323aa552c606c46"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves information about the JetStream usage from an account. <br /></td></tr>
|
|
<tr class="separator:gac8965dcfc6b465fbc323aa552c606c46"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga7c8664b38fcce8497746367d35e5f60b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__js_assets_group.html#ga7c8664b38fcce8497746367d35e5f60b">jsAccountInfo_Destroy</a> (<a class="el" href="structjs_account_info.html">jsAccountInfo</a> *ai)</td></tr>
|
|
<tr class="memdesc:ga7c8664b38fcce8497746367d35e5f60b"><td class="mdescLeft"> </td><td class="mdescRight">Destroys the account information object. <br /></td></tr>
|
|
<tr class="separator:ga7c8664b38fcce8497746367d35e5f60b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<p>JetStream Assets Management </p>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="gac230f71dbdc4d10bc7471d01763881d6" name="gac230f71dbdc4d10bc7471d01763881d6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gac230f71dbdc4d10bc7471d01763881d6">◆ </a></span>jsStreamConfig_Init()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> jsStreamConfig_Init </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structjs_stream_config.html">jsStreamConfig</a> * </td>
|
|
<td class="paramname"><em>cfg</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Use this before setting specific stream configuration options and passing this configuration to some of the stream management APIs.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">cfg</td><td>the pointer to the <a class="el" href="structjs_stream_config.html">jsStreamConfig</a> to initialize. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga223691e6831072a0b8f8103a778293b0" name="ga223691e6831072a0b8f8103a778293b0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga223691e6831072a0b8f8103a778293b0">◆ </a></span>jsPlacement_Init()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> jsPlacement_Init </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structjs_placement.html">jsPlacement</a> * </td>
|
|
<td class="paramname"><em>placement</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Use this before setting specific stream placement options.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">placement</td><td>the pointer to the <a class="el" href="structjs_placement.html">jsPlacement</a> to initialize. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga7fe8e0bf98a38eb59372e7cd78aaaf56" name="ga7fe8e0bf98a38eb59372e7cd78aaaf56"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga7fe8e0bf98a38eb59372e7cd78aaaf56">◆ </a></span>jsStreamSource_Init()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> jsStreamSource_Init </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structjs_stream_source.html">jsStreamSource</a> * </td>
|
|
<td class="paramname"><em>source</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Use this before setting specific stream source options.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">source</td><td>the pointer to the <a class="el" href="structjs_stream_source.html">jsStreamSource</a> to initialize. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga81aebebcd79922104720da51e95020d4" name="ga81aebebcd79922104720da51e95020d4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga81aebebcd79922104720da51e95020d4">◆ </a></span>jsExternalStream_Init()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> jsExternalStream_Init </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structjs_external_stream.html">jsExternalStream</a> * </td>
|
|
<td class="paramname"><em>external</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Use this before setting specific external stream options.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">external</td><td>the pointer to the <a class="el" href="structjs_external_stream.html">jsExternalStream</a> to initialize. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga388bfeaa5a78ebf6ce7c15c6e3a7156b" name="ga388bfeaa5a78ebf6ce7c15c6e3a7156b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga388bfeaa5a78ebf6ce7c15c6e3a7156b">◆ </a></span>jsRePublish_Init()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> jsRePublish_Init </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structjs_re_publish.html">jsRePublish</a> * </td>
|
|
<td class="paramname"><em>rp</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Use this to set the source, destination and/or headers only for a stream re-publish.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">rp</td><td>the pointer to the <a class="el" href="structjs_re_publish.html">jsRePublish</a> to initialize. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga5efc5136d33ba52161e6732f88f1ee75" name="ga5efc5136d33ba52161e6732f88f1ee75"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga5efc5136d33ba52161e6732f88f1ee75">◆ </a></span>js_AddStream()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> js_AddStream </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structjs_stream_info.html">jsStreamInfo</a> ** </td>
|
|
<td class="paramname"><em>si</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> * </td>
|
|
<td class="paramname"><em>js</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structjs_stream_config.html">jsStreamConfig</a> * </td>
|
|
<td class="paramname"><em>cfg</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structjs_options.html">jsOptions</a> * </td>
|
|
<td class="paramname"><em>opts</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="status_8h.html#a10731415ffcd3e2330df10c4d5fd3d70">jsErrCode</a> * </td>
|
|
<td class="paramname"><em>errCode</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<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>
|
|
<dl class="section note"><dt>Note</dt><dd>If you do not need a <a class="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>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__js_assets_group.html#gac230f71dbdc4d10bc7471d01763881d6" title="Initializes a streaming configuration structure.">jsStreamConfig_Init</a> </dd>
|
|
<dd>
|
|
<a class="el" href="group__js_assets_group.html#ga8ee87ef86e94be42685941abe9638bbd" title="Destroys the stream information object.">jsStreamInfo_Destroy</a></dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">si</td><td>the location where to store the pointer to the new <a class="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><td class="paramname">js</td><td>the pointer to the <a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> context. </td></tr>
|
|
<tr><td class="paramname">cfg</td><td>the pointer to the <a class="el" href="structjs_stream_config.html">jsStreamConfig</a>. </td></tr>
|
|
<tr><td class="paramname">opts</td><td>the pointer to the <a class="el" href="structjs_options.html">jsOptions</a> object, possibly <code>NULL</code>. </td></tr>
|
|
<tr><td class="paramname">errCode</td><td>the location where to store the JetStream specific error code, or <code>NULL</code> if not needed. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga75a5c44304e24481c67e17fbccc15c31" name="ga75a5c44304e24481c67e17fbccc15c31"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga75a5c44304e24481c67e17fbccc15c31">◆ </a></span>js_UpdateStream()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> js_UpdateStream </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structjs_stream_info.html">jsStreamInfo</a> ** </td>
|
|
<td class="paramname"><em>si</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> * </td>
|
|
<td class="paramname"><em>js</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structjs_stream_config.html">jsStreamConfig</a> * </td>
|
|
<td class="paramname"><em>cfg</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structjs_options.html">jsOptions</a> * </td>
|
|
<td class="paramname"><em>opts</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="status_8h.html#a10731415ffcd3e2330df10c4d5fd3d70">jsErrCode</a> * </td>
|
|
<td class="paramname"><em>errCode</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<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>
|
|
<dl class="section note"><dt>Note</dt><dd>If you do not need a <a class="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>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__js_assets_group.html#gac230f71dbdc4d10bc7471d01763881d6" title="Initializes a streaming configuration structure.">jsStreamConfig_Init</a> </dd>
|
|
<dd>
|
|
<a class="el" href="group__js_assets_group.html#ga8ee87ef86e94be42685941abe9638bbd" title="Destroys the stream information object.">jsStreamInfo_Destroy</a></dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">si</td><td>the location where to store the pointer to the new <a class="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><td class="paramname">js</td><td>the pointer to the <a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> context. </td></tr>
|
|
<tr><td class="paramname">cfg</td><td>the pointer to the <a class="el" href="structjs_stream_config.html">jsStreamConfig</a>. </td></tr>
|
|
<tr><td class="paramname">opts</td><td>the pointer to the <a class="el" href="structjs_options.html">jsOptions</a> object, possibly <code>NULL</code>. </td></tr>
|
|
<tr><td class="paramname">errCode</td><td>the location where to store the JetStream specific error code, or <code>NULL</code> if not needed. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga5a6a886c18a79caa403908bf7f7ef125" name="ga5a6a886c18a79caa403908bf7f7ef125"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga5a6a886c18a79caa403908bf7f7ef125">◆ </a></span>js_PurgeStream()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> js_PurgeStream </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> * </td>
|
|
<td class="paramname"><em>js</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>stream</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structjs_options.html">jsOptions</a> * </td>
|
|
<td class="paramname"><em>opts</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="status_8h.html#a10731415ffcd3e2330df10c4d5fd3d70">jsErrCode</a> * </td>
|
|
<td class="paramname"><em>errCode</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Purges the stream named <code>stream</code>.</p>
|
|
<p>For more advanced purge options, you can specify them through <a class="el" href="structjs_options.html">jsOptions</a>.</p>
|
|
<div class="fragment"><div class="line">jsOptions o;</div>
|
|
<div class="line"> </div>
|
|
<div class="line">jsOptions_Init(&o);</div>
|
|
<div class="line">o.Stream.Purge.Subject = "foo";</div>
|
|
<div class="line">o.Stream.Purge.Sequence = 4;</div>
|
|
<div class="line"> </div>
|
|
<div class="line">js_PurgeStream(js, "MY_STREAM", &o, &jerr);</div>
|
|
</div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">js</td><td>the pointer to the <a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> context. </td></tr>
|
|
<tr><td class="paramname">stream</td><td>the name of the stream to purge. </td></tr>
|
|
<tr><td class="paramname">opts</td><td>the pointer to the <a class="el" href="structjs_options.html">jsOptions</a> object, possibly <code>NULL</code>. </td></tr>
|
|
<tr><td class="paramname">errCode</td><td>the location where to store the JetStream specific error code, or <code>NULL</code> if not needed. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga397e55a0b3b6d36c9bf746eee3842172" name="ga397e55a0b3b6d36c9bf746eee3842172"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga397e55a0b3b6d36c9bf746eee3842172">◆ </a></span>js_DeleteStream()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> js_DeleteStream </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> * </td>
|
|
<td class="paramname"><em>js</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>stream</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structjs_options.html">jsOptions</a> * </td>
|
|
<td class="paramname"><em>opts</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="status_8h.html#a10731415ffcd3e2330df10c4d5fd3d70">jsErrCode</a> * </td>
|
|
<td class="paramname"><em>errCode</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Deletes the stream named <code>stream</code>.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">js</td><td>the pointer to the <a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> context. </td></tr>
|
|
<tr><td class="paramname">stream</td><td>the name of the stream to delete. </td></tr>
|
|
<tr><td class="paramname">opts</td><td>the pointer to the <a class="el" href="structjs_options.html">jsOptions</a> object, possibly <code>NULL</code>. </td></tr>
|
|
<tr><td class="paramname">errCode</td><td>the location where to store the JetStream specific error code, or <code>NULL</code> if not needed. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga9fe289ae172f83e53ca1b1b747744c1f" name="ga9fe289ae172f83e53ca1b1b747744c1f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga9fe289ae172f83e53ca1b1b747744c1f">◆ </a></span>js_GetMsg()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> js_GetMsg </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__types_group.html#gadcab54026c4ed78f344ce03ce31bb61a">natsMsg</a> ** </td>
|
|
<td class="paramname"><em>msg</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> * </td>
|
|
<td class="paramname"><em>js</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>stream</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint64_t </td>
|
|
<td class="paramname"><em>seq</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structjs_options.html">jsOptions</a> * </td>
|
|
<td class="paramname"><em>opts</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="status_8h.html#a10731415ffcd3e2330df10c4d5fd3d70">jsErrCode</a> * </td>
|
|
<td class="paramname"><em>errCode</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Retrieves a raw stream message stored in JetStream by sequence number.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>The message needs to be destroyed by calling <a class="el" href="group__msg_group.html#ga9e9590018284939f43f60964283f33ae" title="Destroys the message object.">natsMsg_Destroy</a>.</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="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>
|
|
<a class="el" href="group__msg_group.html#ga9e9590018284939f43f60964283f33ae" title="Destroys the message object.">natsMsg_Destroy</a></dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">msg</td><td>the memory location where the library will store the pointer to the <a class="el" href="group__types_group.html#gadcab54026c4ed78f344ce03ce31bb61a" title="A structure holding a subject, optional reply and payload.">natsMsg</a>. </td></tr>
|
|
<tr><td class="paramname">js</td><td>the pointer to the <a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> context. </td></tr>
|
|
<tr><td class="paramname">stream</td><td>the name of the stream. </td></tr>
|
|
<tr><td class="paramname">seq</td><td>the sequence in the stream of the message being retrieved. </td></tr>
|
|
<tr><td class="paramname">opts</td><td>the pointer to the <a class="el" href="structjs_options.html">jsOptions</a> object, possibly <code>NULL</code>. </td></tr>
|
|
<tr><td class="paramname">errCode</td><td>the location where to store the JetStream specific error code, or <code>NULL</code> if not needed. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga6835b53da27d5721eddb3698e582cf0c" name="ga6835b53da27d5721eddb3698e582cf0c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga6835b53da27d5721eddb3698e582cf0c">◆ </a></span>js_GetLastMsg()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> js_GetLastMsg </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__types_group.html#gadcab54026c4ed78f344ce03ce31bb61a">natsMsg</a> ** </td>
|
|
<td class="paramname"><em>msg</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> * </td>
|
|
<td class="paramname"><em>js</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>stream</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>subject</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structjs_options.html">jsOptions</a> * </td>
|
|
<td class="paramname"><em>opts</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="status_8h.html#a10731415ffcd3e2330df10c4d5fd3d70">jsErrCode</a> * </td>
|
|
<td class="paramname"><em>errCode</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Retrieves the last JetStream message from the stream for a given subject.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>The message needs to be destroyed by calling <a class="el" href="group__msg_group.html#ga9e9590018284939f43f60964283f33ae" title="Destroys the message object.">natsMsg_Destroy</a>.</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__js_assets_group.html#ga9fe289ae172f83e53ca1b1b747744c1f" title="Retrieves a JetStream message from the stream by sequence.">js_GetMsg</a> </dd>
|
|
<dd>
|
|
<a class="el" href="group__msg_group.html#ga9e9590018284939f43f60964283f33ae" title="Destroys the message object.">natsMsg_Destroy</a></dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">msg</td><td>the memory location where the library will store the pointer to the <a class="el" href="group__types_group.html#gadcab54026c4ed78f344ce03ce31bb61a" title="A structure holding a subject, optional reply and payload.">natsMsg</a>. </td></tr>
|
|
<tr><td class="paramname">js</td><td>the pointer to the <a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> context. </td></tr>
|
|
<tr><td class="paramname">stream</td><td>the name of the stream. </td></tr>
|
|
<tr><td class="paramname">subject</td><td>the subject for which the last message is being retrieved. </td></tr>
|
|
<tr><td class="paramname">opts</td><td>the pointer to the <a class="el" href="structjs_options.html">jsOptions</a> object, possibly <code>NULL</code>. </td></tr>
|
|
<tr><td class="paramname">errCode</td><td>the location where to store the JetStream specific error code, or <code>NULL</code> if not needed. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga8d835d47aed9c84ce3b8dcfea469f4cb" name="ga8d835d47aed9c84ce3b8dcfea469f4cb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga8d835d47aed9c84ce3b8dcfea469f4cb">◆ </a></span>jsDirectGetMsgOptions_Init()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> jsDirectGetMsgOptions_Init </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structjs_direct_get_msg_options.html">jsDirectGetMsgOptions</a> * </td>
|
|
<td class="paramname"><em>opts</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Use this before setting specific direct get message options and passing it to <a class="el" href="group__js_assets_group.html#ga62c250cecc650b1eed0fa1691893e2ae" title="Retrieves directly a JetStream message based on provided options.">js_DirectGetMsg</a> API.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">opts</td><td>the pointer to the <a class="el" href="structjs_direct_get_msg_options.html">jsDirectGetMsgOptions</a> object. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga62c250cecc650b1eed0fa1691893e2ae" name="ga62c250cecc650b1eed0fa1691893e2ae"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga62c250cecc650b1eed0fa1691893e2ae">◆ </a></span>js_DirectGetMsg()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> js_DirectGetMsg </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__types_group.html#gadcab54026c4ed78f344ce03ce31bb61a">natsMsg</a> ** </td>
|
|
<td class="paramname"><em>msg</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> * </td>
|
|
<td class="paramname"><em>js</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>stream</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structjs_options.html">jsOptions</a> * </td>
|
|
<td class="paramname"><em>opts</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structjs_direct_get_msg_options.html">jsDirectGetMsgOptions</a> * </td>
|
|
<td class="paramname"><em>dgOpts</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<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 <a class="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>
|
|
<dl class="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>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">msg</td><td>the location where to store the pointer to the retrieved message. </td></tr>
|
|
<tr><td class="paramname">js</td><td>the pointer to the <a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> context. </td></tr>
|
|
<tr><td class="paramname">stream</td><td>the name of the stream. </td></tr>
|
|
<tr><td class="paramname">opts</td><td>the pointer to the <a class="el" href="structjs_options.html">jsOptions</a> object, possibly <code>NULL</code>. </td></tr>
|
|
<tr><td class="paramname">dgOpts</td><td>the pointer to the <a class="el" href="structjs_direct_get_msg_options.html">jsDirectGetMsgOptions</a> object, cannot be <code>NULL</code>. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaeba5d45abbe811c0e40830c5f26c78fd" name="gaeba5d45abbe811c0e40830c5f26c78fd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaeba5d45abbe811c0e40830c5f26c78fd">◆ </a></span>js_DeleteMsg()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> js_DeleteMsg </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> * </td>
|
|
<td class="paramname"><em>js</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>stream</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint64_t </td>
|
|
<td class="paramname"><em>seq</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structjs_options.html">jsOptions</a> * </td>
|
|
<td class="paramname"><em>opts</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="status_8h.html#a10731415ffcd3e2330df10c4d5fd3d70">jsErrCode</a> * </td>
|
|
<td class="paramname"><em>errCode</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Deletes the message at sequence <code>seq</code> in the stream named <code>stream</code>.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>To completely erase the content of the deleted message when stored on disk, use <a class="el" href="group__js_assets_group.html#ga7158f73e183462e9a15e9802e1746ff0" title="Erases a message from the stream.">js_EraseMsg</a> instead.</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__js_assets_group.html#ga7158f73e183462e9a15e9802e1746ff0" title="Erases a message from the stream.">js_EraseMsg</a></dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">js</td><td>the pointer to the <a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> context. </td></tr>
|
|
<tr><td class="paramname">stream</td><td>the name of the stream. </td></tr>
|
|
<tr><td class="paramname">seq</td><td>the sequence in the stream of the message to delete. </td></tr>
|
|
<tr><td class="paramname">opts</td><td>the pointer to the <a class="el" href="structjs_options.html">jsOptions</a> object, possibly <code>NULL</code>. </td></tr>
|
|
<tr><td class="paramname">errCode</td><td>the location where to store the JetStream specific error code, or <code>NULL</code> if not needed. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga7158f73e183462e9a15e9802e1746ff0" name="ga7158f73e183462e9a15e9802e1746ff0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga7158f73e183462e9a15e9802e1746ff0">◆ </a></span>js_EraseMsg()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> js_EraseMsg </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> * </td>
|
|
<td class="paramname"><em>js</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>stream</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint64_t </td>
|
|
<td class="paramname"><em>seq</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structjs_options.html">jsOptions</a> * </td>
|
|
<td class="paramname"><em>opts</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="status_8h.html#a10731415ffcd3e2330df10c4d5fd3d70">jsErrCode</a> * </td>
|
|
<td class="paramname"><em>errCode</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Similar to <a class="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>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__js_assets_group.html#gaeba5d45abbe811c0e40830c5f26c78fd" title="Deletes a message from the stream.">js_DeleteMsg</a></dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">js</td><td>the pointer to the <a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> context. </td></tr>
|
|
<tr><td class="paramname">stream</td><td>the name of the stream. </td></tr>
|
|
<tr><td class="paramname">seq</td><td>the sequence in the stream of the message to erase. </td></tr>
|
|
<tr><td class="paramname">opts</td><td>the pointer to the <a class="el" href="structjs_options.html">jsOptions</a> object, possibly <code>NULL</code>. </td></tr>
|
|
<tr><td class="paramname">errCode</td><td>the location where to store the JetStream specific error code, or <code>NULL</code> if not needed. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga94cb23a35516b7779de28fcbb263180a" name="ga94cb23a35516b7779de28fcbb263180a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga94cb23a35516b7779de28fcbb263180a">◆ </a></span>js_GetStreamInfo()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> js_GetStreamInfo </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structjs_stream_info.html">jsStreamInfo</a> ** </td>
|
|
<td class="paramname"><em>si</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> * </td>
|
|
<td class="paramname"><em>js</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>stream</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structjs_options.html">jsOptions</a> * </td>
|
|
<td class="paramname"><em>opts</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="status_8h.html#a10731415ffcd3e2330df10c4d5fd3d70">jsErrCode</a> * </td>
|
|
<td class="paramname"><em>errCode</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Returns information about the stream named <code>stream</code>.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>You need to free the returned object.</dd></dl>
|
|
<p>To get some detailed information about deleted messages, set this option:</p>
|
|
<div class="fragment"><div class="line">jsOptions o;</div>
|
|
<div class="line"> </div>
|
|
<div class="line">jsOptions_Init(&o);</div>
|
|
<div class="line">o.Stream.Info.DeletedDetails = true;</div>
|
|
<div class="line">js_GetStreamInfo(&si, js, "MY_STREAM", &o, &jerr);</div>
|
|
</div><!-- fragment --><dl class="section see"><dt>See also</dt><dd><a class="el" href="group__js_assets_group.html#ga8ee87ef86e94be42685941abe9638bbd" title="Destroys the stream information object.">jsStreamInfo_Destroy</a></dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">si</td><td>the location where to store the pointer to the new <a class="el" href="structjs_stream_info.html">jsStreamInfo</a> object in response to the creation request. </td></tr>
|
|
<tr><td class="paramname">js</td><td>the pointer to the <a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> context. </td></tr>
|
|
<tr><td class="paramname">stream</td><td>the name of the stream which information is retrieved. </td></tr>
|
|
<tr><td class="paramname">opts</td><td>the pointer to the <a class="el" href="structjs_options.html">jsOptions</a> object, possibly <code>NULL</code>. </td></tr>
|
|
<tr><td class="paramname">errCode</td><td>the location where to store the JetStream specific error code, or <code>NULL</code> if not needed. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga8ee87ef86e94be42685941abe9638bbd" name="ga8ee87ef86e94be42685941abe9638bbd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga8ee87ef86e94be42685941abe9638bbd">◆ </a></span>jsStreamInfo_Destroy()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> void jsStreamInfo_Destroy </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structjs_stream_info.html">jsStreamInfo</a> * </td>
|
|
<td class="paramname"><em>si</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Releases memory allocated for this stream information object.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">si</td><td>the pointer to the <a class="el" href="structjs_stream_info.html">jsStreamInfo</a> object. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga531d91de372f0dffb8d64abecf88b0c0" name="ga531d91de372f0dffb8d64abecf88b0c0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga531d91de372f0dffb8d64abecf88b0c0">◆ </a></span>js_Streams()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> js_Streams </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structjs_stream_info_list.html">jsStreamInfoList</a> ** </td>
|
|
<td class="paramname"><em>list</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> * </td>
|
|
<td class="paramname"><em>js</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structjs_options.html">jsOptions</a> * </td>
|
|
<td class="paramname"><em>opts</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="status_8h.html#a10731415ffcd3e2330df10c4d5fd3d70">jsErrCode</a> * </td>
|
|
<td class="paramname"><em>errCode</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Retrieves the list of all <a class="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>
|
|
<dl class="section warning"><dt>Warning</dt><dd>The list should be destroyed when no longer used by calling <a class="el" href="group__js_assets_group.html#ga38cdcc339eb8976d23296b99aa37d629" title="Destroys the stream information list object.">jsStreamInfoList_Destroy</a>.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">list</td><td>the location where to store the pointer to the new <a class="el" href="structjs_stream_info_list.html">jsStreamInfoList</a> object. </td></tr>
|
|
<tr><td class="paramname">js</td><td>the pointer to the <a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> context. </td></tr>
|
|
<tr><td class="paramname">opts</td><td>the pointer to the <a class="el" href="structjs_options.html">jsOptions</a> object, possibly <code>NULL</code>. </td></tr>
|
|
<tr><td class="paramname">errCode</td><td>the location where to store the JetStream specific error code, or <code>NULL</code> if not needed. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga38cdcc339eb8976d23296b99aa37d629" name="ga38cdcc339eb8976d23296b99aa37d629"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga38cdcc339eb8976d23296b99aa37d629">◆ </a></span>jsStreamInfoList_Destroy()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> void jsStreamInfoList_Destroy </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structjs_stream_info_list.html">jsStreamInfoList</a> * </td>
|
|
<td class="paramname"><em>list</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Releases memory allocated for this stream information list.</p>
|
|
<dl class="section warning"><dt>Warning</dt><dd>All <a class="el" href="structjs_stream_info.html">jsStreamInfo</a> pointers contained in the list will be destroyed by this call.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">list</td><td>the pointer to the <a class="el" href="structjs_stream_info_list.html">jsStreamInfoList</a> object. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gac3dfc87863dbbb3c959ecde4bce905bc" name="gac3dfc87863dbbb3c959ecde4bce905bc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gac3dfc87863dbbb3c959ecde4bce905bc">◆ </a></span>js_StreamNames()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> js_StreamNames </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structjs_stream_names_list.html">jsStreamNamesList</a> ** </td>
|
|
<td class="paramname"><em>list</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> * </td>
|
|
<td class="paramname"><em>js</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structjs_options.html">jsOptions</a> * </td>
|
|
<td class="paramname"><em>opts</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="status_8h.html#a10731415ffcd3e2330df10c4d5fd3d70">jsErrCode</a> * </td>
|
|
<td class="paramname"><em>errCode</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<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>
|
|
<dl class="section warning"><dt>Warning</dt><dd>The list should be destroyed when no longer used by calling <a class="el" href="group__js_assets_group.html#gaf8644f281d4e24893a6a170b4f7faa65" title="Destroys the stream names list object.">jsStreamNamesList_Destroy</a>.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">list</td><td>the location where to store the pointer to the new <a class="el" href="structjs_stream_names_list.html">jsStreamNamesList</a> object. </td></tr>
|
|
<tr><td class="paramname">js</td><td>the pointer to the <a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> context. </td></tr>
|
|
<tr><td class="paramname">opts</td><td>the pointer to the <a class="el" href="structjs_options.html">jsOptions</a> object, possibly <code>NULL</code>. </td></tr>
|
|
<tr><td class="paramname">errCode</td><td>the location where to store the JetStream specific error code, or <code>NULL</code> if not needed. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaf8644f281d4e24893a6a170b4f7faa65" name="gaf8644f281d4e24893a6a170b4f7faa65"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaf8644f281d4e24893a6a170b4f7faa65">◆ </a></span>jsStreamNamesList_Destroy()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> void jsStreamNamesList_Destroy </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structjs_stream_names_list.html">jsStreamNamesList</a> * </td>
|
|
<td class="paramname"><em>list</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Releases memory allocated for this list of stream names.</p>
|
|
<dl class="section warning"><dt>Warning</dt><dd>All string pointers contained in the list will be destroyed by this call.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">list</td><td>the pointer to the <a class="el" href="structjs_stream_names_list.html">jsStreamNamesList</a> object. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga3381bb05c05bf4a8979adde68d37dd66" name="ga3381bb05c05bf4a8979adde68d37dd66"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga3381bb05c05bf4a8979adde68d37dd66">◆ </a></span>jsConsumerConfig_Init()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> jsConsumerConfig_Init </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structjs_consumer_config.html">jsConsumerConfig</a> * </td>
|
|
<td class="paramname"><em>cc</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Use this before adding a consumer.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structjs_consumer_config.html">jsConsumerConfig</a></dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">cc</td><td>the pointer to the <a class="el" href="structjs_consumer_config.html">jsConsumerConfig</a> to initialize. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaf2efb63db150e782d9007090b49d4115" name="gaf2efb63db150e782d9007090b49d4115"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaf2efb63db150e782d9007090b49d4115">◆ </a></span>js_AddConsumer()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> js_AddConsumer </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structjs_consumer_info.html">jsConsumerInfo</a> ** </td>
|
|
<td class="paramname"><em>ci</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> * </td>
|
|
<td class="paramname"><em>js</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>stream</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structjs_consumer_config.html">jsConsumerConfig</a> * </td>
|
|
<td class="paramname"><em>cfg</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structjs_options.html">jsOptions</a> * </td>
|
|
<td class="paramname"><em>opts</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="status_8h.html#a10731415ffcd3e2330df10c4d5fd3d70">jsErrCode</a> * </td>
|
|
<td class="paramname"><em>errCode</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Adds a consumer based on the provided configuration (that cannot be <code>NULL</code>).</p>
|
|
<dl class="section note"><dt>Note</dt><dd>If you do not need a <a class="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>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__js_assets_group.html#ga3381bb05c05bf4a8979adde68d37dd66" title="Initializes a consumer configuration structure.">jsConsumerConfig_Init</a> </dd>
|
|
<dd>
|
|
<a class="el" href="group__js_assets_group.html#ga9c1d5ed2f24ba836c10e415231f80088" title="Destroys the consumer information object.">jsConsumerInfo_Destroy</a></dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ci</td><td>the location where to store the pointer to the new <a class="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><td class="paramname">js</td><td>the pointer to the <a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> context. </td></tr>
|
|
<tr><td class="paramname">stream</td><td>the name of the stream. </td></tr>
|
|
<tr><td class="paramname">cfg</td><td>the pointer to the <a class="el" href="structjs_consumer_config.html">jsConsumerConfig</a>. </td></tr>
|
|
<tr><td class="paramname">opts</td><td>the pointer to the <a class="el" href="structjs_options.html">jsOptions</a> object, possibly <code>NULL</code>. </td></tr>
|
|
<tr><td class="paramname">errCode</td><td>the location where to store the JetStream specific error code, or <code>NULL</code> if not needed. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gad13ec256e24710bb237995814871e554" name="gad13ec256e24710bb237995814871e554"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gad13ec256e24710bb237995814871e554">◆ </a></span>js_UpdateConsumer()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> js_UpdateConsumer </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structjs_consumer_info.html">jsConsumerInfo</a> ** </td>
|
|
<td class="paramname"><em>ci</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> * </td>
|
|
<td class="paramname"><em>js</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>stream</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structjs_consumer_config.html">jsConsumerConfig</a> * </td>
|
|
<td class="paramname"><em>cfg</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structjs_options.html">jsOptions</a> * </td>
|
|
<td class="paramname"><em>opts</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="status_8h.html#a10731415ffcd3e2330df10c4d5fd3d70">jsErrCode</a> * </td>
|
|
<td class="paramname"><em>errCode</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Updates a consumer based on the provided configuration (that cannot be <code>NULL</code>).</p>
|
|
<dl class="section note"><dt>Note</dt><dd>If you do not need a <a class="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>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__js_assets_group.html#ga3381bb05c05bf4a8979adde68d37dd66" title="Initializes a consumer configuration structure.">jsConsumerConfig_Init</a> </dd>
|
|
<dd>
|
|
<a class="el" href="group__js_assets_group.html#ga9c1d5ed2f24ba836c10e415231f80088" title="Destroys the consumer information object.">jsConsumerInfo_Destroy</a></dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ci</td><td>the location where to store the pointer to the new <a class="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><td class="paramname">js</td><td>the pointer to the <a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> context. </td></tr>
|
|
<tr><td class="paramname">stream</td><td>the name of the stream. </td></tr>
|
|
<tr><td class="paramname">cfg</td><td>the pointer to the <a class="el" href="structjs_consumer_config.html">jsConsumerConfig</a>. </td></tr>
|
|
<tr><td class="paramname">opts</td><td>the pointer to the <a class="el" href="structjs_options.html">jsOptions</a> object, possibly <code>NULL</code>. </td></tr>
|
|
<tr><td class="paramname">errCode</td><td>the location where to store the JetStream specific error code, or <code>NULL</code> if not needed. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga2dda04757b4ab27a794b64f8d727fe23" name="ga2dda04757b4ab27a794b64f8d727fe23"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga2dda04757b4ab27a794b64f8d727fe23">◆ </a></span>js_GetConsumerInfo()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> js_GetConsumerInfo </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structjs_consumer_info.html">jsConsumerInfo</a> ** </td>
|
|
<td class="paramname"><em>ci</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> * </td>
|
|
<td class="paramname"><em>js</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>stream</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>consumer</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structjs_options.html">jsOptions</a> * </td>
|
|
<td class="paramname"><em>opts</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="status_8h.html#a10731415ffcd3e2330df10c4d5fd3d70">jsErrCode</a> * </td>
|
|
<td class="paramname"><em>errCode</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section note"><dt>Note</dt><dd>The returned object should be destroyed using <a class="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>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ci</td><td>the location where to store the pointer to the new <a class="el" href="structjs_consumer_info.html">jsConsumerInfo</a> object. </td></tr>
|
|
<tr><td class="paramname">js</td><td>the pointer to the <a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> context. </td></tr>
|
|
<tr><td class="paramname">stream</td><td>the name of the stream. </td></tr>
|
|
<tr><td class="paramname">consumer</td><td>the name of the consumer. </td></tr>
|
|
<tr><td class="paramname">opts</td><td>the pointer to the <a class="el" href="structjs_options.html">jsOptions</a> object, possibly <code>NULL</code>. </td></tr>
|
|
<tr><td class="paramname">errCode</td><td>the location where to store the JetStream specific error code, or <code>NULL</code> if not needed. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga52fbc61759b11494db91f348a733c490" name="ga52fbc61759b11494db91f348a733c490"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga52fbc61759b11494db91f348a733c490">◆ </a></span>js_DeleteConsumer()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> js_DeleteConsumer </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> * </td>
|
|
<td class="paramname"><em>js</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>stream</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>consumer</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structjs_options.html">jsOptions</a> * </td>
|
|
<td class="paramname"><em>opts</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="status_8h.html#a10731415ffcd3e2330df10c4d5fd3d70">jsErrCode</a> * </td>
|
|
<td class="paramname"><em>errCode</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Deletes the consumer named <code>consumer</code> from stream named <code>stream</code>.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">js</td><td>the pointer to the <a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> context. </td></tr>
|
|
<tr><td class="paramname">stream</td><td>the name of the stream. </td></tr>
|
|
<tr><td class="paramname">consumer</td><td>the name of the consumer. </td></tr>
|
|
<tr><td class="paramname">opts</td><td>the pointer to the <a class="el" href="structjs_options.html">jsOptions</a> object, possibly <code>NULL</code>. </td></tr>
|
|
<tr><td class="paramname">errCode</td><td>the location where to store the JetStream specific error code, or <code>NULL</code> if not needed. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga9c1d5ed2f24ba836c10e415231f80088" name="ga9c1d5ed2f24ba836c10e415231f80088"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga9c1d5ed2f24ba836c10e415231f80088">◆ </a></span>jsConsumerInfo_Destroy()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> void jsConsumerInfo_Destroy </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structjs_consumer_info.html">jsConsumerInfo</a> * </td>
|
|
<td class="paramname"><em>ci</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Releases memory allocated for this consumer information object.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ci</td><td>the pointer to the <a class="el" href="structjs_consumer_info.html">jsConsumerInfo</a> object. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gaf28097ede3e9ba9926fb00856e63ffd9" name="gaf28097ede3e9ba9926fb00856e63ffd9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gaf28097ede3e9ba9926fb00856e63ffd9">◆ </a></span>js_Consumers()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> js_Consumers </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structjs_consumer_info_list.html">jsConsumerInfoList</a> ** </td>
|
|
<td class="paramname"><em>list</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> * </td>
|
|
<td class="paramname"><em>js</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>stream</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structjs_options.html">jsOptions</a> * </td>
|
|
<td class="paramname"><em>opts</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="status_8h.html#a10731415ffcd3e2330df10c4d5fd3d70">jsErrCode</a> * </td>
|
|
<td class="paramname"><em>errCode</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Retrieves the list of all <a class="el" href="structjs_consumer_info.html">jsConsumerInfo</a> for a given stream.</p>
|
|
<dl class="section warning"><dt>Warning</dt><dd>The list should be destroyed when no longer used by calling <a class="el" href="group__js_assets_group.html#ga421de40d8e91658353111c3f2ea90ec8" title="Destroys the consumer information list object.">jsConsumerInfoList_Destroy</a>.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">list</td><td>the location where to store the pointer to the new <a class="el" href="structjs_consumer_info_list.html">jsConsumerInfoList</a> object. </td></tr>
|
|
<tr><td class="paramname">js</td><td>the pointer to the <a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> context. </td></tr>
|
|
<tr><td class="paramname">stream</td><td>the stream name whose consumer list is requested. </td></tr>
|
|
<tr><td class="paramname">opts</td><td>the pointer to the <a class="el" href="structjs_options.html">jsOptions</a> object, possibly <code>NULL</code>. </td></tr>
|
|
<tr><td class="paramname">errCode</td><td>the location where to store the JetStream specific error code, or <code>NULL</code> if not needed. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga421de40d8e91658353111c3f2ea90ec8" name="ga421de40d8e91658353111c3f2ea90ec8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga421de40d8e91658353111c3f2ea90ec8">◆ </a></span>jsConsumerInfoList_Destroy()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> void jsConsumerInfoList_Destroy </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structjs_consumer_info_list.html">jsConsumerInfoList</a> * </td>
|
|
<td class="paramname"><em>list</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Releases memory allocated for this consumer information list.</p>
|
|
<dl class="section warning"><dt>Warning</dt><dd>All <a class="el" href="structjs_consumer_info.html">jsConsumerInfo</a> pointers contained in the list will be destroyed by this call.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">list</td><td>the pointer to the <a class="el" href="structjs_consumer_info_list.html">jsConsumerInfoList</a> object. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga690d19af55d12b82c8523d1861cef8d0" name="ga690d19af55d12b82c8523d1861cef8d0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga690d19af55d12b82c8523d1861cef8d0">◆ </a></span>js_ConsumerNames()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> js_ConsumerNames </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structjs_consumer_names_list.html">jsConsumerNamesList</a> ** </td>
|
|
<td class="paramname"><em>list</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> * </td>
|
|
<td class="paramname"><em>js</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>stream</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structjs_options.html">jsOptions</a> * </td>
|
|
<td class="paramname"><em>opts</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="status_8h.html#a10731415ffcd3e2330df10c4d5fd3d70">jsErrCode</a> * </td>
|
|
<td class="paramname"><em>errCode</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Retrieves the list of all consumer names for a given stream.</p>
|
|
<dl class="section warning"><dt>Warning</dt><dd>The list should be destroyed when no longer used by calling <a class="el" href="group__js_assets_group.html#ga2ced0d190131460bf4608ab893dffc50" title="Destroys the consumer names list object.">jsConsumerNamesList_Destroy</a>.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">list</td><td>the location where to store the pointer to the new <a class="el" href="structjs_consumer_names_list.html">jsConsumerNamesList</a> object. </td></tr>
|
|
<tr><td class="paramname">js</td><td>the pointer to the <a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> context. </td></tr>
|
|
<tr><td class="paramname">stream</td><td>the stream name whose consumer list is requested. </td></tr>
|
|
<tr><td class="paramname">opts</td><td>the pointer to the <a class="el" href="structjs_options.html">jsOptions</a> object, possibly <code>NULL</code>. </td></tr>
|
|
<tr><td class="paramname">errCode</td><td>the location where to store the JetStream specific error code, or <code>NULL</code> if not needed. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga2ced0d190131460bf4608ab893dffc50" name="ga2ced0d190131460bf4608ab893dffc50"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga2ced0d190131460bf4608ab893dffc50">◆ </a></span>jsConsumerNamesList_Destroy()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> void jsConsumerNamesList_Destroy </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structjs_consumer_names_list.html">jsConsumerNamesList</a> * </td>
|
|
<td class="paramname"><em>list</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Releases memory allocated for this list of consumer names.</p>
|
|
<dl class="section warning"><dt>Warning</dt><dd>All string pointers contained in the list will be destroyed by this call.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">list</td><td>the pointer to the <a class="el" href="structjs_consumer_names_list.html">jsConsumerNamesList</a> object. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="gac8965dcfc6b465fbc323aa552c606c46" name="gac8965dcfc6b465fbc323aa552c606c46"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#gac8965dcfc6b465fbc323aa552c606c46">◆ </a></span>js_GetAccountInfo()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> <a class="el" href="status_8h.html#a36c934157b663b7b5fb5d6609c897c80">natsStatus</a> js_GetAccountInfo </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structjs_account_info.html">jsAccountInfo</a> ** </td>
|
|
<td class="paramname"><em>ai</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> * </td>
|
|
<td class="paramname"><em>js</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structjs_options.html">jsOptions</a> * </td>
|
|
<td class="paramname"><em>opts</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="status_8h.html#a10731415ffcd3e2330df10c4d5fd3d70">jsErrCode</a> * </td>
|
|
<td class="paramname"><em>errCode</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Retrieves information about the JetStream usage from an account.</p>
|
|
<dl class="section note"><dt>Note</dt><dd>The returned object should be destroyed using <a class="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>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ai</td><td>the location where to store the pointer to the new <a class="el" href="structjs_account_info.html">jsAccountInfo</a> object in response to the account information request. </td></tr>
|
|
<tr><td class="paramname">js</td><td>the pointer to the <a class="el" href="group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1">jsCtx</a> context. </td></tr>
|
|
<tr><td class="paramname">opts</td><td>the pointer to the <a class="el" href="structjs_options.html">jsOptions</a> object, possibly <code>NULL</code>. </td></tr>
|
|
<tr><td class="paramname">errCode</td><td>the location where to store the JetStream specific error code, or <code>NULL</code> if not needed. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ga7c8664b38fcce8497746367d35e5f60b" name="ga7c8664b38fcce8497746367d35e5f60b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ga7c8664b38fcce8497746367d35e5f60b">◆ </a></span>jsAccountInfo_Destroy()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="nats_8h.html#a3bc1b3fe7f64083e60c7c3b93f205bad">NATS_EXTERN</a> void jsAccountInfo_Destroy </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structjs_account_info.html">jsAccountInfo</a> * </td>
|
|
<td class="paramname"><em>ai</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Releases memory allocated for this account information object.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ai</td><td>the pointer to the <a class="el" href="structjs_account_info.html">jsAccountInfo</a> object. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- HTML footer for doxygen 1.8.10-->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="footer">NATS.IO Supported By Synadia Communications Inc.
|
|
<a href="http://www.nats.io">
|
|
</a></li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|