zabbix_sender_api 1.1.1 → 1.1.2

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,650 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Class: Zabbix::Sender::Connection
8
+
9
+ &mdash; Documentation by YARD 0.9.26
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../css/style.css" type="text/css" />
14
+
15
+ <link rel="stylesheet" href="../../css/common.css" type="text/css" />
16
+
17
+ <script type="text/javascript">
18
+ pathId = "Zabbix::Sender::Connection";
19
+ relpath = '../../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../../class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../../_index.html">Index (C)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../Zabbix.html" title="Zabbix (module)">Zabbix</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Sender.html" title="Zabbix::Sender (module)">Sender</a></span></span>
41
+ &raquo;
42
+ <span class="title">Connection</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Class: Zabbix::Sender::Connection
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName">Object</span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next">Zabbix::Sender::Connection</li>
78
+
79
+ </ul>
80
+ <a href="#" class="inheritanceTree">show all</a>
81
+
82
+ </dd>
83
+ </dl>
84
+
85
+
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+ <dl>
96
+ <dt>Defined in:</dt>
97
+ <dd>lib/zabbix_sender_api/api.rb</dd>
98
+ </dl>
99
+
100
+ </div>
101
+
102
+ <h2>Overview</h2><div class="docstring">
103
+ <div class="discussion">
104
+
105
+ <p>Connection is an abstract class that defines the basis of specific connection types (Pipe, Socket). It is not meant to be instantiated on its own.</p>
106
+
107
+
108
+ </div>
109
+ </div>
110
+ <div class="tags">
111
+
112
+
113
+ </div><div id="subclasses">
114
+ <h2>Direct Known Subclasses</h2>
115
+ <p class="children"><span class='object_link'><a href="Pipe.html" title="Zabbix::Sender::Pipe (class)">Pipe</a></span>, <span class='object_link'><a href="Socket.html" title="Zabbix::Sender::Socket (class)">Socket</a></span></p>
116
+ </div>
117
+
118
+
119
+
120
+
121
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
122
+ <ul class="summary">
123
+
124
+ <li class="public ">
125
+ <span class="summary_signature">
126
+
127
+ <a href="#pipe-instance_method" title="#pipe (instance method)">#<strong>pipe</strong> &#x21d2; Object </a>
128
+
129
+
130
+
131
+ </span>
132
+
133
+
134
+
135
+
136
+ <span class="note title readonly">readonly</span>
137
+
138
+
139
+
140
+
141
+
142
+
143
+
144
+
145
+
146
+ <span class="summary_desc"><div class='inline'>
147
+ <p>Returns the value of attribute pipe.</p>
148
+ </div></span>
149
+
150
+ </li>
151
+
152
+
153
+ <li class="public ">
154
+ <span class="summary_signature">
155
+
156
+ <a href="#targetHost-instance_method" title="#targetHost (instance method)">#<strong>targetHost</strong> &#x21d2; Object </a>
157
+
158
+
159
+
160
+ </span>
161
+
162
+
163
+
164
+
165
+ <span class="note title readonly">readonly</span>
166
+
167
+
168
+
169
+
170
+
171
+
172
+
173
+
174
+
175
+ <span class="summary_desc"><div class='inline'>
176
+ <p>target host (server or proxy) name or ip.</p>
177
+ </div></span>
178
+
179
+ </li>
180
+
181
+
182
+ </ul>
183
+
184
+
185
+
186
+
187
+
188
+ <h2>
189
+ Instance Method Summary
190
+ <small><a href="#" class="summary_toggle">collapse</a></small>
191
+ </h2>
192
+
193
+ <ul class="summary">
194
+
195
+ <li class="public ">
196
+ <span class="summary_signature">
197
+
198
+ <a href="#flush-instance_method" title="#flush (instance method)">#<strong>flush</strong> &#x21d2; Object </a>
199
+
200
+
201
+
202
+ </span>
203
+
204
+
205
+
206
+
207
+
208
+
209
+
210
+
211
+
212
+ <span class="summary_desc"><div class='inline'>
213
+ <p>Closes the zabbix_sender pipe if it&#39;s open.</p>
214
+ </div></span>
215
+
216
+ </li>
217
+
218
+
219
+ <li class="public ">
220
+ <span class="summary_signature">
221
+
222
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(proxy: Zabbix::AgentConfiguration.zabbixProxy) &#x21d2; Connection </a>
223
+
224
+
225
+
226
+ </span>
227
+
228
+
229
+ <span class="note title constructor">constructor</span>
230
+
231
+
232
+
233
+
234
+
235
+
236
+
237
+
238
+ <span class="summary_desc"><div class='inline'>
239
+ <p>Initialize a new Connector object.</p>
240
+ </div></span>
241
+
242
+ </li>
243
+
244
+
245
+ <li class="public ">
246
+ <span class="summary_signature">
247
+
248
+ <a href="#open-instance_method" title="#open (instance method)">#<strong>open</strong> &#x21d2; Object </a>
249
+
250
+
251
+
252
+ </span>
253
+
254
+
255
+
256
+
257
+
258
+
259
+
260
+
261
+
262
+ <span class="summary_desc"><div class='inline'>
263
+ <p>Aborts execution if directly called.</p>
264
+ </div></span>
265
+
266
+ </li>
267
+
268
+
269
+ <li class="public ">
270
+ <span class="summary_signature">
271
+
272
+ <a href="#sendBatch-instance_method" title="#sendBatch (instance method)">#<strong>sendBatch</strong>(aBatch) &#x21d2; Object </a>
273
+
274
+
275
+
276
+ </span>
277
+
278
+
279
+
280
+
281
+
282
+
283
+
284
+
285
+
286
+ <span class="summary_desc"><div class='inline'>
287
+ <p>Aborts execution if directly called.</p>
288
+ </div></span>
289
+
290
+ </li>
291
+
292
+
293
+ <li class="public ">
294
+ <span class="summary_signature">
295
+
296
+ <a href="#sendBatchAtomic-instance_method" title="#sendBatchAtomic (instance method)">#<strong>sendBatchAtomic</strong>(aBatch) &#x21d2; Object </a>
297
+
298
+
299
+
300
+ </span>
301
+
302
+
303
+
304
+
305
+
306
+
307
+
308
+
309
+
310
+ <span class="summary_desc"><div class='inline'>
311
+ <p>Send a Batch instance to zabbix (via zabbix_sender).</p>
312
+ </div></span>
313
+
314
+ </li>
315
+
316
+
317
+ </ul>
318
+
319
+
320
+ <div id="constructor_details" class="method_details_list">
321
+ <h2>Constructor Details</h2>
322
+
323
+ <div class="method_details first">
324
+ <h3 class="signature first" id="initialize-instance_method">
325
+
326
+ #<strong>initialize</strong>(proxy: Zabbix::AgentConfiguration.zabbixProxy) &#x21d2; <tt><span class='object_link'><a href="" title="Zabbix::Sender::Connection (class)">Connection</a></span></tt>
327
+
328
+
329
+
330
+
331
+
332
+ </h3><div class="docstring">
333
+ <div class="discussion">
334
+
335
+ <p>Initialize a new Connector object. Proxy is optional.</p>
336
+
337
+ <p>An attempt is made to provide sane default values. If you have a zabbix_agentd.conf file in one of the usual places and zabbix_sender is on your path, it&#39;ll probably just work</p>
338
+
339
+
340
+ </div>
341
+ </div>
342
+ <div class="tags">
343
+
344
+
345
+ </div><table class="source_code">
346
+ <tr>
347
+ <td>
348
+ <pre class="lines">
349
+
350
+
351
+ 88
352
+ 89
353
+ 90
354
+ 91</pre>
355
+ </td>
356
+ <td>
357
+ <pre class="code"><span class="info file"># File 'lib/zabbix_sender_api/api.rb', line 88</span>
358
+
359
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>proxy:</span> <span class='const'><span class='object_link'><a href="../../Zabbix.html" title="Zabbix (module)">Zabbix</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../AgentConfiguration.html" title="Zabbix::AgentConfiguration (class)">AgentConfiguration</a></span></span><span class='period'>.</span><span class='id identifier rubyid_zabbixProxy'><span class='object_link'><a href="../AgentConfiguration.html#zabbixProxy-class_method" title="Zabbix::AgentConfiguration.zabbixProxy (method)">zabbixProxy</a></span></span><span class='rparen'>)</span>
360
+ <span class='ivar'>@targetHost</span> <span class='op'>=</span> <span class='id identifier rubyid_proxy'>proxy</span>
361
+ <span class='ivar'>@pipe</span> <span class='op'>=</span> <span class='kw'>nil</span>
362
+ <span class='kw'>end</span></pre>
363
+ </td>
364
+ </tr>
365
+ </table>
366
+ </div>
367
+
368
+ </div>
369
+
370
+ <div id="instance_attr_details" class="attr_details">
371
+ <h2>Instance Attribute Details</h2>
372
+
373
+
374
+ <span id=""></span>
375
+ <div class="method_details first">
376
+ <h3 class="signature first" id="pipe-instance_method">
377
+
378
+ #<strong>pipe</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
379
+
380
+
381
+
382
+
383
+
384
+ </h3><div class="docstring">
385
+ <div class="discussion">
386
+
387
+ <p>Returns the value of attribute pipe.</p>
388
+
389
+
390
+ </div>
391
+ </div>
392
+ <div class="tags">
393
+
394
+
395
+ </div><table class="source_code">
396
+ <tr>
397
+ <td>
398
+ <pre class="lines">
399
+
400
+
401
+ 79
402
+ 80
403
+ 81</pre>
404
+ </td>
405
+ <td>
406
+ <pre class="code"><span class="info file"># File 'lib/zabbix_sender_api/api.rb', line 79</span>
407
+
408
+ <span class='kw'>def</span> <span class='id identifier rubyid_pipe'>pipe</span>
409
+ <span class='ivar'>@pipe</span>
410
+ <span class='kw'>end</span></pre>
411
+ </td>
412
+ </tr>
413
+ </table>
414
+ </div>
415
+
416
+
417
+ <span id=""></span>
418
+ <div class="method_details ">
419
+ <h3 class="signature " id="targetHost-instance_method">
420
+
421
+ #<strong>targetHost</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
422
+
423
+
424
+
425
+
426
+
427
+ </h3><div class="docstring">
428
+ <div class="discussion">
429
+
430
+ <p>target host (server or proxy) name or ip</p>
431
+
432
+
433
+ </div>
434
+ </div>
435
+ <div class="tags">
436
+
437
+
438
+ </div><table class="source_code">
439
+ <tr>
440
+ <td>
441
+ <pre class="lines">
442
+
443
+
444
+ 78
445
+ 79
446
+ 80</pre>
447
+ </td>
448
+ <td>
449
+ <pre class="code"><span class="info file"># File 'lib/zabbix_sender_api/api.rb', line 78</span>
450
+
451
+ <span class='kw'>def</span> <span class='id identifier rubyid_targetHost'>targetHost</span>
452
+ <span class='ivar'>@targetHost</span>
453
+ <span class='kw'>end</span></pre>
454
+ </td>
455
+ </tr>
456
+ </table>
457
+ </div>
458
+
459
+ </div>
460
+
461
+
462
+ <div id="instance_method_details" class="method_details_list">
463
+ <h2>Instance Method Details</h2>
464
+
465
+
466
+ <div class="method_details first">
467
+ <h3 class="signature first" id="flush-instance_method">
468
+
469
+ #<strong>flush</strong> &#x21d2; <tt>Object</tt>
470
+
471
+
472
+
473
+
474
+
475
+ </h3><div class="docstring">
476
+ <div class="discussion">
477
+
478
+ <p>Closes the zabbix_sender pipe if it&#39;s open</p>
479
+
480
+
481
+ </div>
482
+ </div>
483
+ <div class="tags">
484
+
485
+
486
+ </div><table class="source_code">
487
+ <tr>
488
+ <td>
489
+ <pre class="lines">
490
+
491
+
492
+ 116
493
+ 117
494
+ 118
495
+ 119
496
+ 120</pre>
497
+ </td>
498
+ <td>
499
+ <pre class="code"><span class="info file"># File 'lib/zabbix_sender_api/api.rb', line 116</span>
500
+
501
+ <span class='kw'>def</span> <span class='id identifier rubyid_flush'>flush</span>
502
+ <span class='kw'>if</span> <span class='ivar'>@pipe</span> <span class='kw'>and</span> <span class='kw'>not</span> <span class='ivar'>@pipe</span><span class='period'>.</span><span class='id identifier rubyid_closed?'>closed?</span>
503
+ <span class='ivar'>@pipe</span><span class='period'>.</span><span class='id identifier rubyid_close'>close</span>
504
+ <span class='kw'>end</span>
505
+ <span class='kw'>end</span></pre>
506
+ </td>
507
+ </tr>
508
+ </table>
509
+ </div>
510
+
511
+ <div class="method_details ">
512
+ <h3 class="signature " id="open-instance_method">
513
+
514
+ #<strong>open</strong> &#x21d2; <tt>Object</tt>
515
+
516
+
517
+
518
+
519
+
520
+ </h3><div class="docstring">
521
+ <div class="discussion">
522
+
523
+ <p>Aborts execution if directly called. Subclasses must override.</p>
524
+
525
+
526
+ </div>
527
+ </div>
528
+ <div class="tags">
529
+
530
+
531
+ </div><table class="source_code">
532
+ <tr>
533
+ <td>
534
+ <pre class="lines">
535
+
536
+
537
+ 95
538
+ 96
539
+ 97</pre>
540
+ </td>
541
+ <td>
542
+ <pre class="code"><span class="info file"># File 'lib/zabbix_sender_api/api.rb', line 95</span>
543
+
544
+ <span class='kw'>def</span> <span class='id identifier rubyid_open'>open</span>
545
+ <span class='id identifier rubyid_abort'>abort</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Call to abstract method Connection::open</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
546
+ <span class='kw'>end</span></pre>
547
+ </td>
548
+ </tr>
549
+ </table>
550
+ </div>
551
+
552
+ <div class="method_details ">
553
+ <h3 class="signature " id="sendBatch-instance_method">
554
+
555
+ #<strong>sendBatch</strong>(aBatch) &#x21d2; <tt>Object</tt>
556
+
557
+
558
+
559
+
560
+
561
+ </h3><div class="docstring">
562
+ <div class="discussion">
563
+
564
+ <p>Aborts execution if directly called. Subclasses must override.</p>
565
+
566
+
567
+ </div>
568
+ </div>
569
+ <div class="tags">
570
+
571
+
572
+ </div><table class="source_code">
573
+ <tr>
574
+ <td>
575
+ <pre class="lines">
576
+
577
+
578
+ 101
579
+ 102
580
+ 103</pre>
581
+ </td>
582
+ <td>
583
+ <pre class="code"><span class="info file"># File 'lib/zabbix_sender_api/api.rb', line 101</span>
584
+
585
+ <span class='kw'>def</span> <span class='id identifier rubyid_sendBatch'>sendBatch</span><span class='lparen'>(</span><span class='id identifier rubyid_aBatch'>aBatch</span><span class='rparen'>)</span>
586
+ <span class='id identifier rubyid_abort'>abort</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Call to abstract method Connection::sendBatch(aBatch)</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
587
+ <span class='kw'>end</span></pre>
588
+ </td>
589
+ </tr>
590
+ </table>
591
+ </div>
592
+
593
+ <div class="method_details ">
594
+ <h3 class="signature " id="sendBatchAtomic-instance_method">
595
+
596
+ #<strong>sendBatchAtomic</strong>(aBatch) &#x21d2; <tt>Object</tt>
597
+
598
+
599
+
600
+
601
+
602
+ </h3><div class="docstring">
603
+ <div class="discussion">
604
+
605
+ <p>Send a Batch instance to zabbix (via zabbix_sender). This opens the pipe, writes the data to the pipe, and closes the pipe all in one go.</p>
606
+
607
+
608
+ </div>
609
+ </div>
610
+ <div class="tags">
611
+
612
+
613
+ </div><table class="source_code">
614
+ <tr>
615
+ <td>
616
+ <pre class="lines">
617
+
618
+
619
+ 108
620
+ 109
621
+ 110
622
+ 111
623
+ 112</pre>
624
+ </td>
625
+ <td>
626
+ <pre class="code"><span class="info file"># File 'lib/zabbix_sender_api/api.rb', line 108</span>
627
+
628
+ <span class='kw'>def</span> <span class='id identifier rubyid_sendBatchAtomic'>sendBatchAtomic</span><span class='lparen'>(</span><span class='id identifier rubyid_aBatch'>aBatch</span><span class='rparen'>)</span>
629
+ <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_open'>open</span>
630
+ <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_sendBatch'>sendBatch</span><span class='lparen'>(</span><span class='id identifier rubyid_aBatch'>aBatch</span><span class='rparen'>)</span>
631
+ <span class='kw'>return</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_flush'>flush</span>
632
+ <span class='kw'>end</span></pre>
633
+ </td>
634
+ </tr>
635
+ </table>
636
+ </div>
637
+
638
+ </div>
639
+
640
+ </div>
641
+
642
+ <div id="footer">
643
+ Generated on Sat Sep 11 00:00:06 2021 by
644
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
645
+ 0.9.26 (ruby-2.7.4).
646
+ </div>
647
+
648
+ </div>
649
+ </body>
650
+ </html>