2023-08-15 00:19:51 -07:00
<!-- 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" / >
2023-10-14 12:24:01 -07:00
< meta name = "generator" content = "Doxygen 1.9.8" / >
2023-08-15 00:19:51 -07:00
< title > NATS C Client with JetStream and Streaming support: JetStream< / 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
2023-10-14 12:24:01 -07:00
  < span id = "projectnumber" > 3.7.0< / span >
2023-08-15 00:19:51 -07:00
< / div >
< div id = "projectbrief" > The nats.io C Client, Supported by Synadia Communications Inc.< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
2023-10-14 12:24:01 -07:00
<!-- Generated by Doxygen 1.9.8 -->
2023-08-15 00:19:51 -07:00
< 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_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 = "#groups" > Modules< / a > |
< a href = "#func-members" > Functions< / a > < / div >
< div class = "headertitle" > < div class = "title" > JetStream< div class = "ingroups" > < a class = "el" href = "group__func_group.html" > Functions< / a > < / div > < / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a id = "groups" name = "groups" > < / a >
Modules< / h2 > < / td > < / tr >
2023-10-14 12:24:01 -07:00
< tr class = "memitem:group__js_assets_group" id = "r_group__js_assets_group" > < td class = "memItemLeft" align = "right" valign = "top" >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__js_assets_group.html" > JetStream Assets Management< / a > < / td > < / tr >
2023-08-15 00:19:51 -07:00
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2023-10-14 12:24:01 -07:00
< tr class = "memitem:group__js_pub_group" id = "r_group__js_pub_group" > < td class = "memItemLeft" align = "right" valign = "top" >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__js_pub_group.html" > Publishing< / a > < / td > < / tr >
2023-08-15 00:19:51 -07:00
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2023-10-14 12:24:01 -07:00
< tr class = "memitem:group__js_sub_group" id = "r_group__js_sub_group" > < td class = "memItemLeft" align = "right" valign = "top" >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__js_sub_group.html" > Subscribing< / a > < / td > < / tr >
2023-08-15 00:19:51 -07:00
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2023-10-14 12:24:01 -07:00
< tr class = "memitem:group__js_msg" id = "r_group__js_msg" > < td class = "memItemLeft" align = "right" valign = "top" >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__js_msg.html" > Messages< / a > < / td > < / tr >
2023-08-15 00:19:51 -07:00
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a id = "func-members" name = "func-members" > < / a >
Functions< / h2 > < / td > < / tr >
2023-10-14 12:24:01 -07:00
< tr class = "memitem:ga855ff9a04888d696785cc5ede96112e4" id = "r_ga855ff9a04888d696785cc5ede96112e4" > < 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_group.html#ga855ff9a04888d696785cc5ede96112e4" > jsOptions_Init< / a > (< a class = "el" href = "structjs_options.html" > jsOptions< / a > *opts)< / td > < / tr >
2023-08-15 00:19:51 -07:00
< tr class = "memdesc:ga855ff9a04888d696785cc5ede96112e4" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Initializes a streaming context options structure. < br / > < / td > < / tr >
< tr class = "separator:ga855ff9a04888d696785cc5ede96112e4" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2023-10-14 12:24:01 -07:00
< tr class = "memitem:ga8ed08b0fe1074b1e490291f0af2cb03f" id = "r_ga8ed08b0fe1074b1e490291f0af2cb03f" > < 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_group.html#ga8ed08b0fe1074b1e490291f0af2cb03f" > natsConnection_JetStream< / a > (< a class = "el" href = "group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1" > jsCtx< / a > **js, < a class = "el" href = "group__types_group.html#gaf88dca0a18efb5c5e994d265a9f04aec" > natsConnection< / a > *nc, < a class = "el" href = "structjs_options.html" > jsOptions< / a > *opts)< / td > < / tr >
2023-08-15 00:19:51 -07:00
< tr class = "memdesc:ga8ed08b0fe1074b1e490291f0af2cb03f" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Returns a new JetStream context. < br / > < / td > < / tr >
< tr class = "separator:ga8ed08b0fe1074b1e490291f0af2cb03f" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2023-10-14 12:24:01 -07:00
< tr class = "memitem:gacfa6ce3e60ea540e3331a09a7f3dc856" id = "r_gacfa6ce3e60ea540e3331a09a7f3dc856" > < 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_group.html#gacfa6ce3e60ea540e3331a09a7f3dc856" > jsCtx_Destroy< / a > (< a class = "el" href = "group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1" > jsCtx< / a > *js)< / td > < / tr >
2023-08-15 00:19:51 -07:00
< tr class = "memdesc:gacfa6ce3e60ea540e3331a09a7f3dc856" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Destroys the JetStream context. < br / > < / td > < / tr >
< tr class = "separator:gacfa6ce3e60ea540e3331a09a7f3dc856" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table >
< a name = "details" id = "details" > < / a > < h2 class = "groupheader" > Detailed Description< / h2 >
< p > JetStream. < / p >
< h2 class = "groupheader" > Function Documentation< / h2 >
< a id = "ga855ff9a04888d696785cc5ede96112e4" name = "ga855ff9a04888d696785cc5ede96112e4" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ga855ff9a04888d696785cc5ede96112e4" > ◆   < / a > < / span > jsOptions_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 > jsOptions_Init < / td >
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "structjs_options.html" > jsOptions< / 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 stream context options and passing it to JetStream APIs.< / 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_options.html" > jsOptions< / a > to initialize. < / td > < / tr >
< / table >
< / dd >
< / dl >
< / div >
< / div >
< a id = "ga8ed08b0fe1074b1e490291f0af2cb03f" name = "ga8ed08b0fe1074b1e490291f0af2cb03f" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ga8ed08b0fe1074b1e490291f0af2cb03f" > ◆   < / a > < / span > natsConnection_JetStream()< / 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 > natsConnection_JetStream < / 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 = "group__types_group.html#gaf88dca0a18efb5c5e994d265a9f04aec" > natsConnection< / a > *  < / td >
< td class = "paramname" > < em > nc< / 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 > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > A JetStream context is used for messaging and assets management.< / p >
< p > Since the underlying NATS connection is used for communication, the NATS connection should stay valid while using the JetStream context. That is, do not close/destroy the NATS connection before destroying the JetStream context.< / p >
< dl class = "section note" > < dt > Note< / dt > < dd > When done, the context should be destroyed to release memory.< / dd > < / dl >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > js< / td > < td > the location where to store the pointer to the newly created < a class = "el" href = "group__types_group.html#gaaf12cdd24c6cc23a57c20466c92ff8c1" > jsCtx< / a > object. < / td > < / tr >
< tr > < td class = "paramname" > nc< / td > < td > the pointer to the < a class = "el" href = "group__types_group.html#gaf88dca0a18efb5c5e994d265a9f04aec" title = "A connection to a NATS Server." > natsConnection< / a > object from which to get the JetStream 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 >
< / table >
< / dd >
< / dl >
< / div >
< / div >
< a id = "gacfa6ce3e60ea540e3331a09a7f3dc856" name = "gacfa6ce3e60ea540e3331a09a7f3dc856" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#gacfa6ce3e60ea540e3331a09a7f3dc856" > ◆   < / a > < / span > jsCtx_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 jsCtx_Destroy < / 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 > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Releases memory used by the context object.< / 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 > object to destroy. < / 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 >
