siffer 0.0.5 → 0.0.7

Sign up to get free protection for your applications and to get access to all the features.
Files changed (102) hide show
  1. data/LICENSE +1 -1
  2. data/README +93 -0
  3. data/lib/siffer.rb +13 -16
  4. data/lib/siffer/agent.rb +39 -31
  5. data/lib/siffer/core_ext/hash.rb +15 -0
  6. data/lib/siffer/messages.rb +38 -4
  7. data/lib/siffer/messages/ack.rb +160 -35
  8. data/lib/siffer/messages/event.rb +20 -0
  9. data/lib/siffer/messages/message.rb +47 -58
  10. data/lib/siffer/messages/provide.rb +25 -0
  11. data/lib/siffer/messages/provision.rb +17 -0
  12. data/lib/siffer/messages/register.rb +42 -52
  13. data/lib/siffer/messages/request.rb +138 -0
  14. data/lib/siffer/messages/response.rb +48 -0
  15. data/lib/siffer/messages/subscribe.rb +17 -0
  16. data/lib/siffer/messages/system_control.rb +94 -0
  17. data/lib/siffer/models.rb +1 -0
  18. data/lib/siffer/models/address.rb +39 -0
  19. metadata +25 -146
  20. data/README.rdoc +0 -65
  21. data/Rakefile +0 -64
  22. data/bin/siffer +0 -71
  23. data/doc/SIF ImplementationSpecification.pdf +0 -0
  24. data/doc/rdoc/classes/Siffer.html +0 -259
  25. data/doc/rdoc/classes/Siffer/Agent.html +0 -177
  26. data/doc/rdoc/classes/Siffer/Container.html +0 -165
  27. data/doc/rdoc/classes/Siffer/Messages.html +0 -81
  28. data/doc/rdoc/classes/Siffer/Messages/Ack.html +0 -115
  29. data/doc/rdoc/classes/Siffer/Messages/Acl.html +0 -83
  30. data/doc/rdoc/classes/Siffer/Messages/Error.html +0 -157
  31. data/doc/rdoc/classes/Siffer/Messages/Message.html +0 -235
  32. data/doc/rdoc/classes/Siffer/Messages/Message/Header.html +0 -107
  33. data/doc/rdoc/classes/Siffer/Messages/Register.html +0 -154
  34. data/doc/rdoc/classes/Siffer/Messages/RequestBody.html +0 -185
  35. data/doc/rdoc/classes/Siffer/Messages/Status.html +0 -156
  36. data/doc/rdoc/classes/Siffer/Messaging.html +0 -212
  37. data/doc/rdoc/classes/Siffer/Protocol.html +0 -254
  38. data/doc/rdoc/classes/Siffer/Protocol/NonPostRequest.html +0 -54
  39. data/doc/rdoc/classes/Siffer/Protocol/UnknownPath.html +0 -54
  40. data/doc/rdoc/classes/Siffer/Registration.html +0 -251
  41. data/doc/rdoc/classes/Siffer/Request.html +0 -103
  42. data/doc/rdoc/classes/Siffer/RequestLogger.html +0 -109
  43. data/doc/rdoc/classes/Siffer/Response.html +0 -91
  44. data/doc/rdoc/classes/Siffer/Server.html +0 -156
  45. data/doc/rdoc/created.rid +0 -1
  46. data/doc/rdoc/files/LICENSE.html +0 -76
  47. data/doc/rdoc/files/README_rdoc.html +0 -131
  48. data/doc/rdoc/files/lib/siffer/agent_rb.html +0 -49
  49. data/doc/rdoc/files/lib/siffer/container_rb.html +0 -57
  50. data/doc/rdoc/files/lib/siffer/messages/ack_rb.html +0 -49
  51. data/doc/rdoc/files/lib/siffer/messages/acl_rb.html +0 -49
  52. data/doc/rdoc/files/lib/siffer/messages/error_rb.html +0 -49
  53. data/doc/rdoc/files/lib/siffer/messages/message_rb.html +0 -49
  54. data/doc/rdoc/files/lib/siffer/messages/register_rb.html +0 -49
  55. data/doc/rdoc/files/lib/siffer/messages/request_body_rb.html +0 -49
  56. data/doc/rdoc/files/lib/siffer/messages/status_rb.html +0 -49
  57. data/doc/rdoc/files/lib/siffer/messages_rb.html +0 -63
  58. data/doc/rdoc/files/lib/siffer/messaging_rb.html +0 -49
  59. data/doc/rdoc/files/lib/siffer/protocol_rb.html +0 -49
  60. data/doc/rdoc/files/lib/siffer/registration_rb.html +0 -49
  61. data/doc/rdoc/files/lib/siffer/request_logger_rb.html +0 -49
  62. data/doc/rdoc/files/lib/siffer/request_rb.html +0 -49
  63. data/doc/rdoc/files/lib/siffer/response_rb.html +0 -49
  64. data/doc/rdoc/files/lib/siffer/server_rb.html +0 -49
  65. data/doc/rdoc/files/lib/siffer_rb.html +0 -64
  66. data/doc/rdoc/fr_class_index.html +0 -25
  67. data/doc/rdoc/fr_file_index.html +0 -39
  68. data/doc/rdoc/fr_method_index.html +0 -4539
  69. data/doc/rdoc/index.html +0 -15
  70. data/doc/rdoc/rdoc-style.css +0 -319
  71. data/lib/siffer/container.rb +0 -94
  72. data/lib/siffer/messages/acl.rb +0 -25
  73. data/lib/siffer/messages/error.rb +0 -174
  74. data/lib/siffer/messages/request_body.rb +0 -66
  75. data/lib/siffer/messages/status.rb +0 -55
  76. data/lib/siffer/messaging.rb +0 -99
  77. data/lib/siffer/protocol.rb +0 -164
  78. data/lib/siffer/registration.rb +0 -87
  79. data/lib/siffer/request.rb +0 -28
  80. data/lib/siffer/request_logger.rb +0 -32
  81. data/lib/siffer/response.rb +0 -26
  82. data/lib/siffer/server.rb +0 -42
  83. data/spec/agent_spec.rb +0 -48
  84. data/spec/cli_spec.rb +0 -40
  85. data/spec/container_spec.rb +0 -103
  86. data/spec/default_agent +0 -6
  87. data/spec/default_server +0 -5
  88. data/spec/message_specs/ack_spec.rb +0 -28
  89. data/spec/message_specs/error_spec.rb +0 -24
  90. data/spec/message_specs/header_spec.rb +0 -25
  91. data/spec/message_specs/message_spec.rb +0 -57
  92. data/spec/message_specs/register_spec.rb +0 -86
  93. data/spec/message_specs/request_body_spec.rb +0 -58
  94. data/spec/message_specs/status_spec.rb +0 -25
  95. data/spec/messaging_spec.rb +0 -85
  96. data/spec/protocol_spec.rb +0 -50
  97. data/spec/registration_spec.rb +0 -33
  98. data/spec/request_logger_spec.rb +0 -28
  99. data/spec/request_spec.rb +0 -25
  100. data/spec/response_spec.rb +0 -24
  101. data/spec/server_spec.rb +0 -30
  102. data/spec/spec_helper.rb +0 -35
data/doc/rdoc/classes/Siffer/Messages/Message.html DELETED
@@ -1,235 +0,0 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
2
- <html lang='en'>
3
- <head>
4
- <title>Class: Siffer::Messages::Message [Siffer == h3o(software) SIF]</title>
5
- <meta content='text/html; charset=UTF-8' http-equiv='Content-Type'>
6
- <link href='../../.././rdoc-style.css' media='screen' rel='stylesheet' type='text/css'>
7
- <script type='text/javascript'>
8
- //<![CDATA[
9
- function popupCode(url) {
10
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
11
- }
12
-
13
- function toggleCode(id) {
14
- var code = document.getElementById(id)
15
-
16
- code.style.display = code.style.display != 'block' ? 'block' : 'none'
17
- return true
18
- }
19
-
20
- // Make codeblocks hidden by default
21
- document.writeln('<' + 'style type="text/css">.method .source pre { display: none }<\/style>')
22
- //]]>
23
- </script>
24
- </head>
25
- <body class='page'>
26
- <div class='class' id='wrapper'>
27
- <div class='header'>
28
- <h1 class='name'>
29
- <span class='type'>Class</span>
30
- Siffer::Messages::Message
31
- </h1>
32
- <ol class='paths'>
33
- <li>
34
- <a href="../../../files/lib/siffer/messages/message_rb.html">lib/siffer/messages/message.rb</a>
35
- </li>
36
- </ol>
37
- <div class='parent'>
38
- Parent:
39
- <strong>Object</strong>
40
- </div>
41
- </div>
42
- <div id='content'>
43
- <div id='text'>
44
- <div id='description'>
45
- <p>
46
- Base class for all <a href="../Messages.html">Messages</a> in the
47
- framework. Embeds the XMLNS as well as the version of SIF implemented.
48
- </p>
49
- </div>
50
- <div id='method-list'>
51
- <h2>Methods</h2>
52
- <h3>public class</h3>
53
- <ol>
54
- <li><a href="#M000018">new</a></li>
55
- </ol>
56
- <h3>public instance</h3>
57
- <ol>
58
- <li><a href="#M000022">body</a></li>
59
- <li><a href="#M000019">content</a></li>
60
- <li><a href="#M000021">msg_id</a></li>
61
- <li><a href="#M000023">put_header_into</a></li>
62
- <li><a href="#M000024">read</a></li>
63
- <li><a href="#M000020">source_id</a></li>
64
- <li><a href="#M000025">to_str</a></li>
65
- </ol>
66
- </div>
67
- <div id='section'>
68
- <div id='class-list'>
69
- <h2>Classes and Modules</h2>
70
- Class <a href="Message/Header.html" class="link">Siffer::Messages::Message::Header</a><br />
71
- </div>
72
- <div id='attribute-list'>
73
- <h2 class='section-bar'>Attributes</h2>
74
- <div class='name-list'>
75
- <table>
76
- <tr class='top-aligned-row context-row'>
77
- <td class='context-item-name'>header</td>
78
- <td class='context-item-value'>[R]</td>
79
- <td class='context-item-desc'></td>
80
- </tr>
81
- <tr class='top-aligned-row context-row'>
82
- <td class='context-item-name'>version</td>
83
- <td class='context-item-value'>[R]</td>
84
- <td class='context-item-desc'></td>
85
- </tr>
86
- <tr class='top-aligned-row context-row'>
87
- <td class='context-item-name'>xmlns</td>
88
- <td class='context-item-value'>[R]</td>
89
- <td class='context-item-desc'></td>
90
- </tr>
91
- </table>
92
- </div>
93
- </div>
94
- <div id='methods'>
95
- <h2>Public class methods</h2>
96
- <div class='public-class method' id='method-M000018'>
97
- <a name='M000018'> </a>
98
- <div class='synopsis'>
99
- <span class='name'>new</span>
100
- <span class='arguments'>(source, options = {})</span>
101
- </div>
102
- <div class='description'>
103
- <p>
104
- source parameter is required (string describing the original sender)
105
- </p>
106
- </div>
107
- <div class='source'>
108
- <a class='source-toggle' href='#' onclick="toggleCode('M000018-source'); return false">
109
- [show source]
110
- </a>
111
- <pre id='M000018-source'> <span class="ruby-comment cmt"># File lib/siffer/messages/message.rb, line 11</span>&#x000A;11: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">source</span>, <span class="ruby-identifier">options</span> = {})&#x000A;12: <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-value str">&quot;Source not provided.&quot;</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">source</span>.<span class="ruby-identifier">nil?</span>&#x000A;13: <span class="ruby-ivar">@xmlns</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:xmlns</span>] <span class="ruby-operator">||</span> <span class="ruby-constant">Siffer</span>.<span class="ruby-identifier">sif_xmlns</span>&#x000A;14: <span class="ruby-ivar">@version</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:version</span>] <span class="ruby-operator">||</span> <span class="ruby-constant">Siffer</span>.<span class="ruby-identifier">sif_version</span>&#x000A;15: <span class="ruby-ivar">@header</span> = <span class="ruby-constant">Header</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">source</span>)&#x000A;16: <span class="ruby-ivar">@body</span> = <span class="ruby-constant">Builder</span><span class="ruby-operator">::</span><span class="ruby-constant">XmlMarkup</span>.<span class="ruby-identifier">new</span>&#x000A;17: <span class="ruby-keyword kw">end</span></pre>
112
- </div>
113
- </div>
114
- <h2>Public instance methods</h2>
115
- <div class='public-instance method' id='method-M000022'>
116
- <a name='M000022'> </a>
117
- <div class='synopsis'>
118
- <span class='name'>body</span>
119
- <span class='arguments'>()</span>
120
- </div>
121
- <div class='description'>
122
- <p>
123
- Alias for <a href="Message.html#M000019">content</a>
124
- </p>
125
- </div>
126
- </div>
127
- <div class='public-instance method' id='method-M000019'>
128
- <a name='M000019'> </a>
129
- <div class='synopsis'>
130
- <span class='name'>content</span>
131
- <span class='arguments'>() {|xml if block_given?| ...}</span>
132
- </div>
133
- <div class='description'>
134
- <p>
135
- Builds the xml for this message. Accepts a block if nested elements are
136
- required.
137
- </p>
138
- </div>
139
- <div class='source'>
140
- <a class='source-toggle' href='#' onclick="toggleCode('M000019-source'); return false">
141
- [show source]
142
- </a>
143
- <pre id='M000019-source'> <span class="ruby-comment cmt"># File lib/siffer/messages/message.rb, line 21</span>&#x000A;21: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">content</span>&#x000A;22: <span class="ruby-ivar">@xml</span> <span class="ruby-operator">||=</span> <span class="ruby-ivar">@body</span>.<span class="ruby-constant">SIF_Message</span>(<span class="ruby-identifier">:version</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-ivar">@version</span>, <span class="ruby-identifier">:xmlns</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-ivar">@xmlns</span>) { <span class="ruby-operator">|</span><span class="ruby-identifier">xml</span><span class="ruby-operator">|</span>&#x000A;23: <span class="ruby-keyword kw">yield</span> <span class="ruby-identifier">xml</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>&#x000A;24: }&#x000A;25: <span class="ruby-keyword kw">end</span></pre>
144
- </div>
145
- </div>
146
- <div class='public-instance method' id='method-M000021'>
147
- <a name='M000021'> </a>
148
- <div class='synopsis'>
149
- <span class='name'>msg_id</span>
150
- <span class='arguments'>()</span>
151
- </div>
152
- <div class='description'>
153
- <p>
154
- Alias method to the <a href="Message/Header.html">Header</a> MsgId
155
- </p>
156
- </div>
157
- <div class='source'>
158
- <a class='source-toggle' href='#' onclick="toggleCode('M000021-source'); return false">
159
- [show source]
160
- </a>
161
- <pre id='M000021-source'> <span class="ruby-comment cmt"># File lib/siffer/messages/message.rb, line 30</span>&#x000A;30: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">msg_id</span>() <span class="ruby-identifier">header</span>.<span class="ruby-identifier">msg_id</span>; <span class="ruby-keyword kw">end</span></pre>
162
- </div>
163
- </div>
164
- <div class='public-instance method' id='method-M000023'>
165
- <a name='M000023'> </a>
166
- <div class='synopsis'>
167
- <span class='name'>put_header_into</span>
168
- <span class='arguments'>(xml)</span>
169
- </div>
170
- <div class='source'>
171
- <a class='source-toggle' href='#' onclick="toggleCode('M000023-source'); return false">
172
- [show source]
173
- </a>
174
- <pre id='M000023-source'> <span class="ruby-comment cmt"># File lib/siffer/messages/message.rb, line 36</span>&#x000A;36: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">put_header_into</span>(<span class="ruby-identifier">xml</span>)&#x000A;37: <span class="ruby-identifier">xml</span>.<span class="ruby-constant">SIF_Header</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">head</span><span class="ruby-operator">|</span>&#x000A;38: <span class="ruby-identifier">head</span>.<span class="ruby-constant">SIF_MsgId</span>(<span class="ruby-ivar">@header</span>.<span class="ruby-identifier">msg_id</span>)&#x000A;39: <span class="ruby-identifier">head</span>.<span class="ruby-constant">SIF_Timestamp</span>(<span class="ruby-ivar">@header</span>.<span class="ruby-identifier">timestamp</span>)&#x000A;40: <span class="ruby-identifier">head</span>.<span class="ruby-constant">SIF_SourceId</span>(<span class="ruby-ivar">@header</span>.<span class="ruby-identifier">source_id</span>)&#x000A;41: }&#x000A;42: <span class="ruby-keyword kw">end</span></pre>
175
- </div>
176
- </div>
177
- <div class='public-instance method' id='method-M000024'>
178
- <a name='M000024'> </a>
179
- <div class='synopsis'>
180
- <span class='name'>read</span>
181
- <span class='arguments'>()</span>
182
- </div>
183
- <div class='description'>
184
- <p>
185
- Returns the content of the message
186
- </p>
187
- </div>
188
- <div class='source'>
189
- <a class='source-toggle' href='#' onclick="toggleCode('M000024-source'); return false">
190
- [show source]
191
- </a>
192
- <pre id='M000024-source'> <span class="ruby-comment cmt"># File lib/siffer/messages/message.rb, line 45</span>&#x000A;45: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">read</span>&#x000A;46: <span class="ruby-comment cmt"># this construct prevents the xml from being built</span>&#x000A;47: <span class="ruby-comment cmt"># over and over again for every read made to this</span>&#x000A;48: <span class="ruby-comment cmt"># message.</span>&#x000A;49: <span class="ruby-ivar">@xml</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">content</span>&#x000A;50: <span class="ruby-keyword kw">end</span></pre>
193
- </div>
194
- </div>
195
- <div class='public-instance method' id='method-M000020'>
196
- <a name='M000020'> </a>
197
- <div class='synopsis'>
198
- <span class='name'>source_id</span>
199
- <span class='arguments'>()</span>
200
- </div>
201
- <div class='description'>
202
- <p>
203
- Alias method to the <a href="Message/Header.html">Header</a> SourceId
204
- </p>
205
- </div>
206
- <div class='source'>
207
- <a class='source-toggle' href='#' onclick="toggleCode('M000020-source'); return false">
208
- [show source]
209
- </a>
210
- <pre id='M000020-source'> <span class="ruby-comment cmt"># File lib/siffer/messages/message.rb, line 28</span>&#x000A;28: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">source_id</span>() <span class="ruby-identifier">header</span>.<span class="ruby-identifier">source_id</span>; <span class="ruby-keyword kw">end</span></pre>
211
- </div>
212
- </div>
213
- <div class='public-instance method' id='method-M000025'>
214
- <a name='M000025'> </a>
215
- <div class='synopsis'>
216
- <span class='name'>to_str</span>
217
- <span class='arguments'>()</span>
218
- </div>
219
- <div class='description'>
220
- <p>
221
- Alias for <a href="Message.html#M000024">read</a>
222
- </p>
223
- </div>
224
- </div>
225
- </div>
226
- </div>
227
- </div>
228
- </div>
229
- <div id='footer-push'></div>
230
- </div>
231
- <div id='footer'>
232
- <a href="http://github.com/mislav/hanna/tree/master"><strong>Hanna</strong> RDoc template</a>
233
- </div>
234
- </body>
235
- </html>
data/doc/rdoc/classes/Siffer/Messages/Message/Header.html DELETED
@@ -1,107 +0,0 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
2
- <html lang='en'>
3
- <head>
4
- <title>Class: Siffer::Messages::Message::Header [Siffer == h3o(software) SIF]</title>
5
- <meta content='text/html; charset=UTF-8' http-equiv='Content-Type'>
6
- <link href='../../../.././rdoc-style.css' media='screen' rel='stylesheet' type='text/css'>
7
- <script type='text/javascript'>
8
- //<![CDATA[
9
- function popupCode(url) {
10
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
11
- }
12
-
13
- function toggleCode(id) {
14
- var code = document.getElementById(id)
15
-
16
- code.style.display = code.style.display != 'block' ? 'block' : 'none'
17
- return true
18
- }
19
-
20
- // Make codeblocks hidden by default
21
- document.writeln('<' + 'style type="text/css">.method .source pre { display: none }<\/style>')
22
- //]]>
23
- </script>
24
- </head>
25
- <body class='page'>
26
- <div class='class' id='wrapper'>
27
- <div class='header'>
28
- <h1 class='name'>
29
- <span class='type'>Class</span>
30
- Siffer::Messages::Message::Header
31
- </h1>
32
- <ol class='paths'>
33
- <li>
34
- <a href="../../../../files/lib/siffer/messages/message_rb.html">lib/siffer/messages/message.rb</a>
35
- </li>
36
- </ol>
37
- <div class='parent'>
38
- Parent:
39
- <strong>Object</strong>
40
- </div>
41
- </div>
42
- <div id='content'>
43
- <div id='text'>
44
- <div id='description'>
45
- <p>
46
- Each <a href="../Message.html">Message</a> requires a <a
47
- href="Header.html">Header</a> to identify the source. You shouldn&#8217;t
48
- need to initialize this by itself, it is used by <a
49
- href="../Message.html">Message</a>.
50
- </p>
51
- </div>
52
- <div id='method-list'>
53
- <h2>Methods</h2>
54
- <h3>public class</h3>
55
- <ol>
56
- <li><a href="#M000026">new</a></li>
57
- </ol>
58
- </div>
59
- <div id='section'>
60
- <div id='attribute-list'>
61
- <h2 class='section-bar'>Attributes</h2>
62
- <div class='name-list'>
63
- <table>
64
- <tr class='top-aligned-row context-row'>
65
- <td class='context-item-name'>msg_id</td>
66
- <td class='context-item-value'>[R]</td>
67
- <td class='context-item-desc'></td>
68
- </tr>
69
- <tr class='top-aligned-row context-row'>
70
- <td class='context-item-name'>source_id</td>
71
- <td class='context-item-value'>[R]</td>
72
- <td class='context-item-desc'></td>
73
- </tr>
74
- <tr class='top-aligned-row context-row'>
75
- <td class='context-item-name'>timestamp</td>
76
- <td class='context-item-value'>[R]</td>
77
- <td class='context-item-desc'></td>
78
- </tr>
79
- </table>
80
- </div>
81
- </div>
82
- <div id='methods'>
83
- <h2>Public class methods</h2>
84
- <div class='public-class method' id='method-M000026'>
85
- <a name='M000026'> </a>
86
- <div class='synopsis'>
87
- <span class='name'>new</span>
88
- <span class='arguments'>(source)</span>
89
- </div>
90
- <div class='source'>
91
- <a class='source-toggle' href='#' onclick="toggleCode('M000026-source'); return false">
92
- [show source]
93
- </a>
94
- <pre id='M000026-source'> <span class="ruby-comment cmt"># File lib/siffer/messages/message.rb, line 60</span>&#x000A;60: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">source</span>)&#x000A;61: <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-value str">&quot;Source not provided.&quot;</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">source</span>.<span class="ruby-identifier">nil?</span>&#x000A;62: <span class="ruby-ivar">@timestamp</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>&#x000A;63: <span class="ruby-ivar">@msg_id</span> = <span class="ruby-constant">UUID</span>.<span class="ruby-identifier">generate</span>(<span class="ruby-identifier">:compact</span>).<span class="ruby-identifier">upcase</span>&#x000A;64: <span class="ruby-ivar">@source_id</span> = <span class="ruby-identifier">source</span>&#x000A;65: <span class="ruby-keyword kw">end</span></pre>
95
- </div>
96
- </div>
97
- </div>
98
- </div>
99
- </div>
100
- </div>
101
- <div id='footer-push'></div>
102
- </div>
103
- <div id='footer'>
104
- <a href="http://github.com/mislav/hanna/tree/master"><strong>Hanna</strong> RDoc template</a>
105
- </div>
106
- </body>
107
- </html>
data/doc/rdoc/classes/Siffer/Messages/Register.html DELETED
@@ -1,154 +0,0 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
2
- <html lang='en'>
3
- <head>
4
- <title>Class: Siffer::Messages::Register [Siffer == h3o(software) SIF]</title>
5
- <meta content='text/html; charset=UTF-8' http-equiv='Content-Type'>
6
- <link href='../../.././rdoc-style.css' media='screen' rel='stylesheet' type='text/css'>
7
- <script type='text/javascript'>
8
- //<![CDATA[
9
- function popupCode(url) {
10
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
11
- }
12
-
13
- function toggleCode(id) {
14
- var code = document.getElementById(id)
15
-
16
- code.style.display = code.style.display != 'block' ? 'block' : 'none'
17
- return true
18
- }
19
-
20
- // Make codeblocks hidden by default
21
- document.writeln('<' + 'style type="text/css">.method .source pre { display: none }<\/style>')
22
- //]]>
23
- </script>
24
- </head>
25
- <body class='page'>
26
- <div class='class' id='wrapper'>
27
- <div class='header'>
28
- <h1 class='name'>
29
- <span class='type'>Class</span>
30
- Siffer::Messages::Register
31
- </h1>
32
- <ol class='paths'>
33
- <li>
34
- <a href="../../../files/lib/siffer/messages/register_rb.html">lib/siffer/messages/register.rb</a>
35
- </li>
36
- </ol>
37
- <div class='parent'>
38
- Parent:
39
- <strong><a href="Message.html">Siffer::Messages::Message</a></strong>
40
- </div>
41
- </div>
42
- <div id='content'>
43
- <div id='text'>
44
- <div id='description'>
45
- <p>
46
- <a href="Message.html">Message</a> used by Agents to register themselves
47
- with the ZIS.
48
- </p>
49
- </div>
50
- <div id='method-list'>
51
- <h2>Methods</h2>
52
- <h3>public class</h3>
53
- <ol>
54
- <li><a href="#M000027">new</a></li>
55
- <li><a href="#M000029">parse</a></li>
56
- </ol>
57
- <h3>public instance</h3>
58
- <ol>
59
- <li><a href="#M000028">content</a></li>
60
- </ol>
61
- </div>
62
- <div id='section'>
63
- <div id='attribute-list'>
64
- <h2 class='section-bar'>Attributes</h2>
65
- <div class='name-list'>
66
- <table>
67
- <tr class='top-aligned-row context-row'>
68
- <td class='context-item-name'>max_buffer</td>
69
- <td class='context-item-value'>[R]</td>
70
- <td class='context-item-desc'></td>
71
- </tr>
72
- <tr class='top-aligned-row context-row'>
73
- <td class='context-item-name'>mode</td>
74
- <td class='context-item-value'>[R]</td>
75
- <td class='context-item-desc'></td>
76
- </tr>
77
- <tr class='top-aligned-row context-row'>
78
- <td class='context-item-name'>name</td>
79
- <td class='context-item-value'>[R]</td>
80
- <td class='context-item-desc'></td>
81
- </tr>
82
- <tr class='top-aligned-row context-row'>
83
- <td class='context-item-name'>vendor</td>
84
- <td class='context-item-value'>[R]</td>
85
- <td class='context-item-desc'></td>
86
- </tr>
87
- <tr class='top-aligned-row context-row'>
88
- <td class='context-item-name'>version</td>
89
- <td class='context-item-value'>[R]</td>
90
- <td class='context-item-desc'></td>
91
- </tr>
92
- </table>
93
- </div>
94
- </div>
95
- <div id='methods'>
96
- <h2>Public class methods</h2>
97
- <div class='public-class method' id='method-M000027'>
98
- <a name='M000027'> </a>
99
- <div class='synopsis'>
100
- <span class='name'>new</span>
101
- <span class='arguments'>(source, name, options = {})</span>
102
- </div>
103
- <div class='source'>
104
- <a class='source-toggle' href='#' onclick="toggleCode('M000027-source'); return false">
105
- [show source]
106
- </a>
107
- <pre id='M000027-source'> <span class="ruby-comment cmt"># File lib/siffer/messages/register.rb, line 9</span>&#x000A; 9: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">source</span>, <span class="ruby-identifier">name</span>, <span class="ruby-identifier">options</span> = {})&#x000A;10: <span class="ruby-keyword kw">super</span>(<span class="ruby-identifier">source</span>, <span class="ruby-identifier">options</span>)&#x000A;11: <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-value str">&quot;Agent name required&quot;</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">name</span>&#x000A;12: <span class="ruby-ivar">@name</span> = <span class="ruby-identifier">name</span>&#x000A;13: <span class="ruby-ivar">@version</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:version</span>] <span class="ruby-operator">||</span> <span class="ruby-constant">Siffer</span>.<span class="ruby-identifier">sif_version</span>&#x000A;14: <span class="ruby-ivar">@max_buffer</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:max_buffer</span>] <span class="ruby-operator">||</span> <span class="ruby-value">1024</span>&#x000A;15: <span class="ruby-ivar">@mode</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:mode</span>] <span class="ruby-operator">||</span> <span class="ruby-value str">'Pull'</span>&#x000A;16: <span class="ruby-ivar">@vendor</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:vendor</span>] <span class="ruby-operator">||</span> <span class="ruby-constant">Siffer</span>.<span class="ruby-identifier">vendor</span>&#x000A;17: <span class="ruby-keyword kw">end</span></pre>
108
- </div>
109
- </div>
110
- <div class='public-class method' id='method-M000029'>
111
- <a name='M000029'> </a>
112
- <div class='synopsis'>
113
- <span class='name'>parse</span>
114
- <span class='arguments'>(body)</span>
115
- </div>
116
- <div class='description'>
117
- <p>
118
- Parses the body passed as a <a href="Register.html">Register</a> message
119
- and returns a <a href="RequestBody.html">RequestBody</a> that provides
120
- access to <a href="Register.html">Register</a> properties.
121
- </p>
122
- </div>
123
- <div class='source'>
124
- <a class='source-toggle' href='#' onclick="toggleCode('M000029-source'); return false">
125
- [show source]
126
- </a>
127
- <pre id='M000029-source'> <span class="ruby-comment cmt"># File lib/siffer/messages/register.rb, line 33</span>&#x000A;33: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">body</span>)&#x000A;34: <span class="ruby-constant">RegisterBody</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">body</span>)&#x000A;35: <span class="ruby-keyword kw">end</span></pre>
128
- </div>
129
- </div>
130
- <h2>Public instance methods</h2>
131
- <div class='public-instance method' id='method-M000028'>
132
- <a name='M000028'> </a>
133
- <div class='synopsis'>
134
- <span class='name'>content</span>
135
- <span class='arguments'>()</span>
136
- </div>
137
- <div class='source'>
138
- <a class='source-toggle' href='#' onclick="toggleCode('M000028-source'); return false">
139
- [show source]
140
- </a>
141
- <pre id='M000028-source'> <span class="ruby-comment cmt"># File lib/siffer/messages/register.rb, line 19</span>&#x000A;19: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">content</span>&#x000A;20: <span class="ruby-identifier">body</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">reg</span><span class="ruby-operator">|</span>&#x000A;21: <span class="ruby-identifier">reg</span>.<span class="ruby-constant">SIF_Register</span>() { <span class="ruby-operator">|</span><span class="ruby-identifier">xml</span><span class="ruby-operator">|</span>&#x000A;22: <span class="ruby-identifier">put_header_into</span> <span class="ruby-identifier">xml</span>&#x000A;23: <span class="ruby-identifier">reg</span>.<span class="ruby-constant">SIF_Name</span>(<span class="ruby-ivar">@name</span>)&#x000A;24: <span class="ruby-identifier">reg</span>.<span class="ruby-constant">SIF_Version</span>(<span class="ruby-ivar">@version</span>)&#x000A;25: <span class="ruby-identifier">reg</span>.<span class="ruby-constant">SIF_MaxBufferSize</span>(<span class="ruby-ivar">@max_buffer</span>)&#x000A;26: <span class="ruby-identifier">reg</span>.<span class="ruby-constant">SIF_Mode</span>(<span class="ruby-ivar">@mode</span>)&#x000A;27: }&#x000A;28: <span class="ruby-keyword kw">end</span>&#x000A;29: <span class="ruby-keyword kw">end</span></pre>
142
- </div>
143
- </div>
144
- </div>
145
- </div>
146
- </div>
147
- </div>
148
- <div id='footer-push'></div>
149
- </div>
150
- <div id='footer'>
151
- <a href="http://github.com/mislav/hanna/tree/master"><strong>Hanna</strong> RDoc template</a>
152
- </div>
153
- </body>
154
- </html>