Skip to content

Commit 5f198bb

Browse files
author
Minggang Wang
committed
Add three missing APIs
- get the topic name of an subscription - get the service name of a client/service
1 parent 5bf3230 commit 5f198bb

24 files changed

+306
-312
lines changed

‎docs/Client.html‎

Lines changed: 74 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,78 @@ <h2><span class="attribs"><span class="type-signature"></span></span>Client<span
125125

126126

127127

128+
<h3 class="subsection-title">Members</h3>
129+
130+
131+
132+
<h4 class="name" id="serviceName"><span class="type-signature"></span>serviceName<span class="type-signature"> :string</span></h4>
133+
134+
135+
136+
137+
138+
139+
<h5>Type:</h5>
140+
<ul>
141+
<li>
142+
143+
<span class="param-type">string</span>
144+
145+
146+
</li>
147+
</ul>
148+
149+
150+
151+
152+
153+
<dl class="details">
154+
155+
156+
157+
158+
159+
160+
161+
162+
163+
164+
165+
166+
167+
168+
169+
170+
171+
172+
173+
174+
175+
176+
177+
178+
179+
180+
<dt class="tag-source">Source:</dt>
181+
<dd class="tag-source"><ul class="dummy"><li>
182+
<a href="lib_client.js.html">lib/client.js</a>, <a href="lib_client.js.html#line89">line 89</a>
183+
</li></ul></dd>
184+
185+
186+
187+
188+
189+
190+
191+
</dl>
192+
193+
194+
195+
196+
197+
198+
199+
128200

129201

130202
<h3 class="subsection-title">Methods</h3>
@@ -328,13 +400,13 @@ <h5>Returns:</h5>
328400
</div>
329401

330402
<nav>
331-
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-rclnodejs.html">rclnodejs</a></li><li><a href="module-validator.html">validator</a></li></ul><h3>Classes</h3><ul><li><a href="Client.html">Client</a></li><li><a href="Node.html">Node</a></li><li><a href="Publisher.html">Publisher</a></li><li><a href="QoS.html">QoS</a></li><li><a href="Response.html">Response</a></li><li><a href="Service.html">Service</a></li><li><a href="Subscription.html">Subscription</a></li><li><a href="Timer.html">Timer</a></li></ul><h3>Global</h3><ul><li><a href="global.html#debug">debug</a></li><li><a href="global.html#DurabilityPolicy">DurabilityPolicy</a></li><li><a href="global.html#HistoryPolicy">HistoryPolicy</a></li><li><a href="global.html#ReliabilityPolicy">ReliabilityPolicy</a></li></ul>
403+
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-rclnodejs.html">rclnodejs</a></li><li><a href="module-validator.html">validator</a></li></ul><h3>Classes</h3><ul><li><a href="Client.html">Client</a></li><li><a href="Node.html">Node</a></li><li><a href="Publisher.html">Publisher</a></li><li><a href="QoS.html">QoS</a></li><li><a href="Response.html">Response</a></li><li><a href="Service.html">Service</a></li><li><a href="Subscription.html">Subscription</a></li><li><a href="Timer.html">Timer</a></li></ul><h3>Global</h3><ul><li><a href="global.html#DurabilityPolicy">DurabilityPolicy</a></li><li><a href="global.html#HistoryPolicy">HistoryPolicy</a></li><li><a href="global.html#ReliabilityPolicy">ReliabilityPolicy</a></li></ul>
332404
</nav>
333405

334406
<br class="clear">
335407

336408
<footer>
337-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.2</a> on Thu Dec 14 2017 14:35:39 GMT+0800 (CST)
409+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Dec 28 2017 11:26:43 GMT+0800 (CST)
338410
</footer>
339411

340412
<script> prettyPrint(); </script>

‎docs/Node.html‎

Lines changed: 2 additions & 210 deletions
Original file line numberDiff line numberDiff line change
@@ -2285,214 +2285,6 @@ <h5>Returns:</h5>
22852285

22862286

22872287

2288-
2289-
2290-
2291-
2292-
2293-
<h4 class="name" id="name"><span class="type-signature"></span>name<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
2294-
2295-
2296-
2297-
2298-
2299-
2300-
<div class="description">
2301-
/* Get the name of the node.
2302-
</div>
2303-
2304-
2305-
2306-
2307-
2308-
2309-
2310-
2311-
2312-
2313-
2314-
2315-
2316-
<dl class="details">
2317-
2318-
2319-
2320-
2321-
2322-
2323-
2324-
2325-
2326-
2327-
2328-
2329-
2330-
2331-
2332-
2333-
2334-
2335-
2336-
2337-
2338-
2339-
2340-
2341-
2342-
2343-
<dt class="tag-source">Source:</dt>
2344-
<dd class="tag-source"><ul class="dummy"><li>
2345-
<a href="lib_node.js.html">lib/node.js</a>, <a href="lib_node.js.html#line350">line 350</a>
2346-
</li></ul></dd>
2347-
2348-
2349-
2350-
2351-
2352-
2353-
2354-
</dl>
2355-
2356-
2357-
2358-
2359-
2360-
2361-
2362-
2363-
2364-
2365-
2366-
2367-
2368-
<h5>Returns:</h5>
2369-
2370-
2371-
2372-
2373-
<dl>
2374-
<dt>
2375-
Type
2376-
</dt>
2377-
<dd>
2378-
2379-
<span class="param-type">string</span>
2380-
2381-
2382-
</dd>
2383-
</dl>
2384-
2385-
2386-
2387-
2388-
2389-
2390-
2391-
2392-
2393-
2394-
2395-
2396-
2397-
<h4 class="name" id="namespace"><span class="type-signature"></span>namespace<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
2398-
2399-
2400-
2401-
2402-
2403-
2404-
<div class="description">
2405-
/* Get the namespace of the node.
2406-
</div>
2407-
2408-
2409-
2410-
2411-
2412-
2413-
2414-
2415-
2416-
2417-
2418-
2419-
2420-
<dl class="details">
2421-
2422-
2423-
2424-
2425-
2426-
2427-
2428-
2429-
2430-
2431-
2432-
2433-
2434-
2435-
2436-
2437-
2438-
2439-
2440-
2441-
2442-
2443-
2444-
2445-
2446-
2447-
<dt class="tag-source">Source:</dt>
2448-
<dd class="tag-source"><ul class="dummy"><li>
2449-
<a href="lib_node.js.html">lib/node.js</a>, <a href="lib_node.js.html#line357">line 357</a>
2450-
</li></ul></dd>
2451-
2452-
2453-
2454-
2455-
2456-
2457-
2458-
</dl>
2459-
2460-
2461-
2462-
2463-
2464-
2465-
2466-
2467-
2468-
2469-
2470-
2471-
2472-
<h5>Returns:</h5>
2473-
2474-
2475-
2476-
2477-
<dl>
2478-
<dt>
2479-
Type
2480-
</dt>
2481-
<dd>
2482-
2483-
<span class="param-type">string</span>
2484-
2485-
2486-
</dd>
2487-
</dl>
2488-
2489-
2490-
2491-
2492-
2493-
2494-
2495-
24962288

24972289

24982290

@@ -2508,13 +2300,13 @@ <h5>Returns:</h5>
25082300
</div>
25092301

25102302
<nav>
2511-
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-rclnodejs.html">rclnodejs</a></li><li><a href="module-validator.html">validator</a></li></ul><h3>Classes</h3><ul><li><a href="Client.html">Client</a></li><li><a href="Node.html">Node</a></li><li><a href="Publisher.html">Publisher</a></li><li><a href="QoS.html">QoS</a></li><li><a href="Response.html">Response</a></li><li><a href="Service.html">Service</a></li><li><a href="Subscription.html">Subscription</a></li><li><a href="Timer.html">Timer</a></li></ul><h3>Global</h3><ul><li><a href="global.html#debug">debug</a></li><li><a href="global.html#DurabilityPolicy">DurabilityPolicy</a></li><li><a href="global.html#HistoryPolicy">HistoryPolicy</a></li><li><a href="global.html#ReliabilityPolicy">ReliabilityPolicy</a></li></ul>
2303+
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-rclnodejs.html">rclnodejs</a></li><li><a href="module-validator.html">validator</a></li></ul><h3>Classes</h3><ul><li><a href="Client.html">Client</a></li><li><a href="Node.html">Node</a></li><li><a href="Publisher.html">Publisher</a></li><li><a href="QoS.html">QoS</a></li><li><a href="Response.html">Response</a></li><li><a href="Service.html">Service</a></li><li><a href="Subscription.html">Subscription</a></li><li><a href="Timer.html">Timer</a></li></ul><h3>Global</h3><ul><li><a href="global.html#DurabilityPolicy">DurabilityPolicy</a></li><li><a href="global.html#HistoryPolicy">HistoryPolicy</a></li><li><a href="global.html#ReliabilityPolicy">ReliabilityPolicy</a></li></ul>
25122304
</nav>
25132305

25142306
<br class="clear">
25152307

25162308
<footer>
2517-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.2</a> on Thu Dec 14 2017 14:35:39 GMT+0800 (CST)
2309+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Dec 28 2017 11:26:43 GMT+0800 (CST)
25182310
</footer>
25192311

25202312
<script> prettyPrint(); </script>

‎docs/Publisher.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -370,13 +370,13 @@ <h5>Returns:</h5>
370370
</div>
371371

372372
<nav>
373-
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-rclnodejs.html">rclnodejs</a></li><li><a href="module-validator.html">validator</a></li></ul><h3>Classes</h3><ul><li><a href="Client.html">Client</a></li><li><a href="Node.html">Node</a></li><li><a href="Publisher.html">Publisher</a></li><li><a href="QoS.html">QoS</a></li><li><a href="Response.html">Response</a></li><li><a href="Service.html">Service</a></li><li><a href="Subscription.html">Subscription</a></li><li><a href="Timer.html">Timer</a></li></ul><h3>Global</h3><ul><li><a href="global.html#debug">debug</a></li><li><a href="global.html#DurabilityPolicy">DurabilityPolicy</a></li><li><a href="global.html#HistoryPolicy">HistoryPolicy</a></li><li><a href="global.html#ReliabilityPolicy">ReliabilityPolicy</a></li></ul>
373+
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-rclnodejs.html">rclnodejs</a></li><li><a href="module-validator.html">validator</a></li></ul><h3>Classes</h3><ul><li><a href="Client.html">Client</a></li><li><a href="Node.html">Node</a></li><li><a href="Publisher.html">Publisher</a></li><li><a href="QoS.html">QoS</a></li><li><a href="Response.html">Response</a></li><li><a href="Service.html">Service</a></li><li><a href="Subscription.html">Subscription</a></li><li><a href="Timer.html">Timer</a></li></ul><h3>Global</h3><ul><li><a href="global.html#DurabilityPolicy">DurabilityPolicy</a></li><li><a href="global.html#HistoryPolicy">HistoryPolicy</a></li><li><a href="global.html#ReliabilityPolicy">ReliabilityPolicy</a></li></ul>
374374
</nav>
375375

376376
<br class="clear">
377377

378378
<footer>
379-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.2</a> on Thu Dec 14 2017 14:35:40 GMT+0800 (CST)
379+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Dec 28 2017 11:26:43 GMT+0800 (CST)
380380
</footer>
381381

382382
<script> prettyPrint(); </script>

‎docs/QoS.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2605,13 +2605,13 @@ <h5>Returns:</h5>
26052605
</div>
26062606

26072607
<nav>
2608-
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-rclnodejs.html">rclnodejs</a></li><li><a href="module-validator.html">validator</a></li></ul><h3>Classes</h3><ul><li><a href="Client.html">Client</a></li><li><a href="Node.html">Node</a></li><li><a href="Publisher.html">Publisher</a></li><li><a href="QoS.html">QoS</a></li><li><a href="Response.html">Response</a></li><li><a href="Service.html">Service</a></li><li><a href="Subscription.html">Subscription</a></li><li><a href="Timer.html">Timer</a></li></ul><h3>Global</h3><ul><li><a href="global.html#debug">debug</a></li><li><a href="global.html#DurabilityPolicy">DurabilityPolicy</a></li><li><a href="global.html#HistoryPolicy">HistoryPolicy</a></li><li><a href="global.html#ReliabilityPolicy">ReliabilityPolicy</a></li></ul>
2608+
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-rclnodejs.html">rclnodejs</a></li><li><a href="module-validator.html">validator</a></li></ul><h3>Classes</h3><ul><li><a href="Client.html">Client</a></li><li><a href="Node.html">Node</a></li><li><a href="Publisher.html">Publisher</a></li><li><a href="QoS.html">QoS</a></li><li><a href="Response.html">Response</a></li><li><a href="Service.html">Service</a></li><li><a href="Subscription.html">Subscription</a></li><li><a href="Timer.html">Timer</a></li></ul><h3>Global</h3><ul><li><a href="global.html#DurabilityPolicy">DurabilityPolicy</a></li><li><a href="global.html#HistoryPolicy">HistoryPolicy</a></li><li><a href="global.html#ReliabilityPolicy">ReliabilityPolicy</a></li></ul>
26092609
</nav>
26102610

26112611
<br class="clear">
26122612

26132613
<footer>
2614-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.2</a> on Thu Dec 14 2017 14:35:40 GMT+0800 (CST)
2614+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Dec 28 2017 11:26:43 GMT+0800 (CST)
26152615
</footer>
26162616

26172617
<script> prettyPrint(); </script>

‎docs/Response.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -306,13 +306,13 @@ <h5>Returns:</h5>
306306
</div>
307307

308308
<nav>
309-
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-rclnodejs.html">rclnodejs</a></li><li><a href="module-validator.html">validator</a></li></ul><h3>Classes</h3><ul><li><a href="Client.html">Client</a></li><li><a href="Node.html">Node</a></li><li><a href="Publisher.html">Publisher</a></li><li><a href="QoS.html">QoS</a></li><li><a href="Response.html">Response</a></li><li><a href="Service.html">Service</a></li><li><a href="Subscription.html">Subscription</a></li><li><a href="Timer.html">Timer</a></li></ul><h3>Global</h3><ul><li><a href="global.html#debug">debug</a></li><li><a href="global.html#DurabilityPolicy">DurabilityPolicy</a></li><li><a href="global.html#HistoryPolicy">HistoryPolicy</a></li><li><a href="global.html#ReliabilityPolicy">ReliabilityPolicy</a></li></ul>
309+
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-rclnodejs.html">rclnodejs</a></li><li><a href="module-validator.html">validator</a></li></ul><h3>Classes</h3><ul><li><a href="Client.html">Client</a></li><li><a href="Node.html">Node</a></li><li><a href="Publisher.html">Publisher</a></li><li><a href="QoS.html">QoS</a></li><li><a href="Response.html">Response</a></li><li><a href="Service.html">Service</a></li><li><a href="Subscription.html">Subscription</a></li><li><a href="Timer.html">Timer</a></li></ul><h3>Global</h3><ul><li><a href="global.html#DurabilityPolicy">DurabilityPolicy</a></li><li><a href="global.html#HistoryPolicy">HistoryPolicy</a></li><li><a href="global.html#ReliabilityPolicy">ReliabilityPolicy</a></li></ul>
310310
</nav>
311311

312312
<br class="clear">
313313

314314
<footer>
315-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.2</a> on Thu Dec 14 2017 14:35:40 GMT+0800 (CST)
315+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Dec 28 2017 11:26:43 GMT+0800 (CST)
316316
</footer>
317317

318318
<script> prettyPrint(); </script>

0 commit comments

Comments
 (0)