1 | <!DOCTYPE html>
|
2 |
|
3 | <html lang="en">
|
4 | <head>
|
5 | <meta charset="utf-8">
|
6 | <meta name="viewport" content="width=device-width">
|
7 | <title>Documentation Class: CatSnake</title>
|
8 |
|
9 | |
10 |
|
11 |
|
12 | <link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
|
13 |
|
14 | <link type="text/css" rel="stylesheet" href="styles/site.simplex.css">
|
15 |
|
16 | </head>
|
17 |
|
18 | <body>
|
19 |
|
20 | <div class="navbar navbar-default navbar-fixed-top ">
|
21 | <div class="container">
|
22 | <div class="navbar-header">
|
23 | <a class="navbar-brand" href="index.html">Documentation</a>
|
24 | <button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
|
25 | <span class="icon-bar"></span>
|
26 | <span class="icon-bar"></span>
|
27 | <span class="icon-bar"></span>
|
28 | </button>
|
29 | </div>
|
30 | <div class="navbar-collapse collapse" id="topNavigation">
|
31 | <ul class="nav navbar-nav">
|
32 |
|
33 | <li class="dropdown">
|
34 | <a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
|
35 | <ul class="dropdown-menu ">
|
36 | <li><a href="CatSnake.html">CatSnake</a></li>
|
37 | </ul>
|
38 | </li>
|
39 |
|
40 | <li class="dropdown">
|
41 | <a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
|
42 | <ul class="dropdown-menu ">
|
43 | <li><a href="global.html#deny">deny</a></li><li><a href="global.html#grant">grant</a></li><li><a href="global.html#history">history</a></li><li><a href="global.html#info">info</a></li><li><a href="global.html#publish">publish</a></li><li><a href="global.html#subscribe">subscribe</a></li>
|
44 | </ul>
|
45 | </li>
|
46 |
|
47 | </ul>
|
48 | <div class="col-sm-3 col-md-3">
|
49 | <form class="navbar-form" role="search">
|
50 | <div class="input-group">
|
51 | <input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
|
52 | <div class="input-group-btn">
|
53 | <button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
|
54 | </div>
|
55 | </div>
|
56 | </form>
|
57 | </div>
|
58 | </div>
|
59 |
|
60 | </div>
|
61 | </div>
|
62 |
|
63 |
|
64 | <div class="container" id="toc-content">
|
65 | <div class="row">
|
66 |
|
67 |
|
68 | <div class="col-md-8">
|
69 |
|
70 | <div id="main">
|
71 |
|
72 |
|
73 | <h1 class="page-title">Class: CatSnake</h1>
|
74 | <section>
|
75 |
|
76 | <header>
|
77 |
|
78 | <h2>
|
79 | CatSnake
|
80 | </h2>
|
81 |
|
82 | <div class="class-description">Creates a new CatSnake client.</div>
|
83 |
|
84 |
|
85 | </header>
|
86 |
|
87 |
|
88 | <article>
|
89 | <div class="container-overview">
|
90 |
|
91 |
|
92 | <hr>
|
93 | <dt>
|
94 | <h4 class="name" id="CatSnake"><span class="type-signature"></span>new CatSnake(address, options)</h4>
|
95 |
|
96 |
|
97 | </dt>
|
98 | <dd>
|
99 |
|
100 |
|
101 |
|
102 |
|
103 |
|
104 |
|
105 |
|
106 |
|
107 |
|
108 | <h5>Parameters:</h5>
|
109 |
|
110 |
|
111 | <table class="params table table-striped">
|
112 | <thead>
|
113 | <tr>
|
114 |
|
115 | <th>Name</th>
|
116 |
|
117 |
|
118 | <th>Type</th>
|
119 |
|
120 |
|
121 |
|
122 |
|
123 |
|
124 | <th class="last">Description</th>
|
125 | </tr>
|
126 | </thead>
|
127 |
|
128 | <tbody>
|
129 |
|
130 |
|
131 | <tr>
|
132 |
|
133 | <td class="name"><code>address</code></td>
|
134 |
|
135 |
|
136 | <td class="type">
|
137 |
|
138 |
|
139 | <span class="param-type">string</span>
|
140 |
|
141 |
|
142 |
|
143 |
|
144 | </td>
|
145 |
|
146 |
|
147 |
|
148 |
|
149 |
|
150 | <td class="description last">the address of the catsnake server</td>
|
151 | </tr>
|
152 |
|
153 |
|
154 |
|
155 | <tr>
|
156 |
|
157 | <td class="name"><code>options</code></td>
|
158 |
|
159 |
|
160 | <td class="type">
|
161 |
|
162 |
|
163 | <span class="param-type">object</span>
|
164 |
|
165 |
|
166 |
|
167 |
|
168 | </td>
|
169 |
|
170 |
|
171 |
|
172 |
|
173 |
|
174 | <td class="description last">options such as common name and others</td>
|
175 | </tr>
|
176 |
|
177 |
|
178 | </tbody>
|
179 | </table>
|
180 |
|
181 |
|
182 |
|
183 |
|
184 | <dl class="details">
|
185 |
|
186 |
|
187 |
|
188 |
|
189 |
|
190 |
|
191 |
|
192 |
|
193 |
|
194 |
|
195 |
|
196 |
|
197 |
|
198 |
|
199 |
|
200 |
|
201 |
|
202 |
|
203 |
|
204 |
|
205 |
|
206 |
|
207 |
|
208 |
|
209 |
|
210 |
|
211 |
|
212 |
|
213 |
|
214 |
|
215 |
|
216 |
|
217 |
|
218 |
|
219 |
|
220 | </dl>
|
221 |
|
222 |
|
223 |
|
224 |
|
225 |
|
226 |
|
227 |
|
228 |
|
229 |
|
230 |
|
231 |
|
232 |
|
233 |
|
234 |
|
235 |
|
236 | </dd>
|
237 |
|
238 |
|
239 | </div>
|
240 |
|
241 |
|
242 |
|
243 |
|
244 |
|
245 |
|
246 |
|
247 |
|
248 |
|
249 |
|
250 |
|
251 |
|
252 |
|
253 |
|
254 |
|
255 |
|
256 |
|
257 |
|
258 | </article>
|
259 |
|
260 | </section>
|
261 |
|
262 |
|
263 |
|
264 |
|
265 | </div>
|
266 | </div>
|
267 |
|
268 | <div class="clearfix"></div>
|
269 |
|
270 |
|
271 | <div class="col-md-3">
|
272 | <div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
|
273 | </div>
|
274 |
|
275 |
|
276 | </div>
|
277 | </div>
|
278 |
|
279 | <div class="modal fade" id="searchResults">
|
280 | <div class="modal-dialog">
|
281 | <div class="modal-content">
|
282 | <div class="modal-header">
|
283 | <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button>
|
284 | <h4 class="modal-title">Search results</h4>
|
285 | </div>
|
286 | <div class="modal-body"></div>
|
287 | <div class="modal-footer">
|
288 | <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
|
289 | </div>
|
290 | </div>
|
291 | </div>
|
292 | </div>
|
293 |
|
294 | <footer>
|
295 |
|
296 |
|
297 | <span class="jsdoc-message">
|
298 | Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a>
|
299 |
|
300 | on 2016-04-07T21:54:42-04:00
|
301 |
|
302 | using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
|
303 | </span>
|
304 | </footer>
|
305 |
|
306 | <script src="scripts/docstrap.lib.js"></script>
|
307 | <script src="scripts/toc.js"></script>
|
308 | <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
|
309 |
|
310 | <script>
|
311 | $( function () {
|
312 | $( "[id*='$']" ).each( function () {
|
313 | var $this = $( this );
|
314 |
|
315 | $this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
|
316 | } );
|
317 |
|
318 | $( ".tutorial-section pre, .readme-section pre" ).each( function () {
|
319 | var $this = $( this );
|
320 |
|
321 | var example = $this.find( "code" );
|
322 | exampleText = example.html();
|
323 | var lang = /{@lang (.*?)}/.exec( exampleText );
|
324 | if ( lang && lang[1] ) {
|
325 | exampleText = exampleText.replace( lang[0], "" );
|
326 | example.html( exampleText );
|
327 | lang = lang[1];
|
328 | } else {
|
329 | var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
|
330 | lang = langClassMatch ? langClassMatch[1] : "javascript";
|
331 | }
|
332 |
|
333 | if ( lang ) {
|
334 |
|
335 | $this
|
336 | .addClass( "sunlight-highlight-" + lang )
|
337 | .addClass( "linenums" )
|
338 | .html( example.html() );
|
339 |
|
340 | }
|
341 | } );
|
342 |
|
343 | Sunlight.highlightAll( {
|
344 | lineNumbers : false,
|
345 | showMenu : true,
|
346 | enableDoclinks : true
|
347 | } );
|
348 |
|
349 | $.catchAnchorLinks( {
|
350 | navbarOffset: 10
|
351 | } );
|
352 | $( "#toc" ).toc( {
|
353 | anchorName : function ( i, heading, prefix ) {
|
354 | var id = $( heading ).attr( "id" );
|
355 | return id && id.replace(/\~/g, '-inner-').replace(/\./g, '-static-') || ( prefix + i );
|
356 | },
|
357 | selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
|
358 | showAndHide : false,
|
359 | smoothScrolling: true
|
360 | } );
|
361 |
|
362 | $( "#main span[id^='toc']" ).addClass( "toc-shim" );
|
363 | $( '.dropdown-toggle' ).dropdown();
|
364 |
|
365 | $( "table" ).each( function () {
|
366 | var $this = $( this );
|
367 | $this.addClass('table');
|
368 | } );
|
369 |
|
370 | } );
|
371 | </script>
|
372 |
|
373 |
|
374 |
|
375 |
|
376 |
|
377 |
|
378 |
|
379 |
|
380 |
|
381 | <script type="text/javascript">
|
382 | $(document).ready(function() {
|
383 | SearcherDisplay.init();
|
384 | });
|
385 | </script>
|
386 |
|
387 | </body>
|
388 | </html> |
\ | No newline at end of file |