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/Container.html DELETED
@@ -1,165 +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::Container [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::Container
31
- </h1>
32
- <ol class='paths'>
33
- <li>
34
- <a href="../../files/lib/siffer/container_rb.html">lib/siffer/container.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='method-list'>
45
- <h2>Methods</h2>
46
- <h3>public class</h3>
47
- <ol>
48
- <li><a href="#M000053">new</a></li>
49
- </ol>
50
- <h3>public instance</h3>
51
- <ol>
52
- <li><a href="#M000054">daemonized?</a></li>
53
- <li><a href="#M000055">run</a></li>
54
- <li><a href="#M000056">stop</a></li>
55
- </ol>
56
- </div>
57
- <div id='section'>
58
- <div id='attribute-list'>
59
- <h2 class='section-bar'>Attributes</h2>
60
- <div class='name-list'>
61
- <table>
62
- <tr class='top-aligned-row context-row'>
63
- <td class='context-item-name'>component</td>
64
- <td class='context-item-value'>[R]</td>
65
- <td class='context-item-desc'></td>
66
- </tr>
67
- <tr class='top-aligned-row context-row'>
68
- <td class='context-item-name'>environment</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'>host</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'>log</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'>name</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'>pid</td>
89
- <td class='context-item-value'>[R]</td>
90
- <td class='context-item-desc'></td>
91
- </tr>
92
- <tr class='top-aligned-row context-row'>
93
- <td class='context-item-name'>port</td>
94
- <td class='context-item-value'>[R]</td>
95
- <td class='context-item-desc'></td>
96
- </tr>
97
- </table>
98
- </div>
99
- </div>
100
- <div id='methods'>
101
- <h2>Public class methods</h2>
102
- <div class='public-class method' id='method-M000053'>
103
- <a name='M000053'> </a>
104
- <div class='synopsis'>
105
- <span class='name'>new</span>
106
- <span class='arguments'>(options = {})</span>
107
- </div>
108
- <div class='source'>
109
- <a class='source-toggle' href='#' onclick="toggleCode('M000053-source'); return false">
110
- [show source]
111
- </a>
112
- <pre id='M000053-source'> <span class="ruby-comment cmt"># File lib/siffer/container.rb, line 7</span>&#x000A; 7: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">options</span> = {})&#x000A; 8: <span class="ruby-identifier">raise</span> <span class="ruby-value str">&quot;Component Configuration missing&quot;</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:config</span>].<span class="ruby-identifier">nil?</span>&#x000A; 9: <span class="ruby-identifier">raise</span> <span class="ruby-value str">&quot;Environment missing&quot;</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:environment</span>].<span class="ruby-identifier">nil?</span>&#x000A;10: <span class="ruby-ivar">@environment</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:environment</span>]&#x000A;11: <span class="ruby-identifier">config</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:config</span>]&#x000A;12: <span class="ruby-identifier">type</span> = <span class="ruby-identifier">config</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-value str">&quot;agent&quot;</span>) <span class="ruby-operator">?</span> <span class="ruby-value str">&quot;agent&quot;</span> <span class="ruby-operator">:</span> <span class="ruby-value str">&quot;server&quot;</span>&#x000A;13: <span class="ruby-ivar">@component</span> = (<span class="ruby-identifier">type</span> <span class="ruby-operator">==</span> <span class="ruby-value str">&quot;agent&quot;</span>) <span class="ruby-operator">?</span> &#x000A;14: <span class="ruby-constant">Siffer</span><span class="ruby-operator">::</span><span class="ruby-constant">Agent</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">config</span>[<span class="ruby-value str">&quot;agent&quot;</span>]) <span class="ruby-operator">:</span> &#x000A;15: <span class="ruby-constant">Siffer</span><span class="ruby-operator">::</span><span class="ruby-constant">Server</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">config</span>[<span class="ruby-value str">&quot;server&quot;</span>])&#x000A;16: <span class="ruby-ivar">@name</span> = <span class="ruby-identifier">config</span>[<span class="ruby-identifier">type</span>][<span class="ruby-value str">&quot;name&quot;</span>]&#x000A;17: <span class="ruby-identifier">uri</span> = <span class="ruby-constant">URI</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">config</span>[<span class="ruby-identifier">type</span>][<span class="ruby-value str">&quot;host&quot;</span>])&#x000A;18: <span class="ruby-ivar">@host</span> = <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">host</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-value">? </span><span class="ruby-identifier">uri</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">uri</span>.<span class="ruby-identifier">host</span>&#x000A;19: <span class="ruby-ivar">@port</span> = <span class="ruby-identifier">config</span>[<span class="ruby-identifier">type</span>][<span class="ruby-value str">&quot;port&quot;</span>]&#x000A;20: <span class="ruby-ivar">@daemonize</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:daemonize</span>]&#x000A;21: <span class="ruby-ivar">@pid</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:pid</span>]&#x000A;22: <span class="ruby-ivar">@log</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:log</span>]&#x000A;23: <span class="ruby-keyword kw">end</span></pre>
113
- </div>
114
- </div>
115
- <h2>Public instance methods</h2>
116
- <div class='public-instance method' id='method-M000054'>
117
- <a name='M000054'> </a>
118
- <div class='synopsis'>
119
- <span class='name'>daemonized?</span>
120
- <span class='arguments'>()</span>
121
- </div>
122
- <div class='source'>
123
- <a class='source-toggle' href='#' onclick="toggleCode('M000054-source'); return false">
124
- [show source]
125
- </a>
126
- <pre id='M000054-source'> <span class="ruby-comment cmt"># File lib/siffer/container.rb, line 25</span>&#x000A;25: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">daemonized?</span>&#x000A;26: <span class="ruby-ivar">@daemonize</span>&#x000A;27: <span class="ruby-keyword kw">end</span></pre>
127
- </div>
128
- </div>
129
- <div class='public-instance method' id='method-M000055'>
130
- <a name='M000055'> </a>
131
- <div class='synopsis'>
132
- <span class='name'>run</span>
133
- <span class='arguments'>()</span>
134
- </div>
135
- <div class='source'>
136
- <a class='source-toggle' href='#' onclick="toggleCode('M000055-source'); return false">
137
- [show source]
138
- </a>
139
- <pre id='M000055-source'> <span class="ruby-comment cmt"># File lib/siffer/container.rb, line 29</span>&#x000A;29: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">run</span>&#x000A;30: <span class="ruby-identifier">daemonize</span>&#x000A;31: <span class="ruby-identifier">server</span> = <span class="ruby-identifier">best_available_server</span>&#x000A;32: <span class="ruby-identifier">options</span> = { <span class="ruby-identifier">:Host</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">host</span>, <span class="ruby-identifier">:Port</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">port</span> }&#x000A;33: <span class="ruby-identifier">component</span>.<span class="ruby-identifier">wake_up</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">component</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value str">&quot;wake_up&quot;</span>)&#x000A;34: <span class="ruby-identifier">app</span> = <span class="ruby-identifier">component_wrapped_in_environment</span>&#x000A;35: <span class="ruby-identifier">server</span>.<span class="ruby-identifier">run</span> <span class="ruby-identifier">app</span>, <span class="ruby-identifier">options</span>&#x000A;36: <span class="ruby-keyword kw">end</span></pre>
140
- </div>
141
- </div>
142
- <div class='public-instance method' id='method-M000056'>
143
- <a name='M000056'> </a>
144
- <div class='synopsis'>
145
- <span class='name'>stop</span>
146
- <span class='arguments'>()</span>
147
- </div>
148
- <div class='source'>
149
- <a class='source-toggle' href='#' onclick="toggleCode('M000056-source'); return false">
150
- [show source]
151
- </a>
152
- <pre id='M000056-source'> <span class="ruby-comment cmt"># File lib/siffer/container.rb, line 38</span>&#x000A;38: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">stop</span>&#x000A;39: <span class="ruby-identifier">pid_id</span> = <span class="ruby-identifier">open</span>(<span class="ruby-node">&quot;#{@pid}&quot;</span>).<span class="ruby-identifier">read</span>.<span class="ruby-identifier">to_i</span>&#x000A;40: <span class="ruby-constant">Process</span>.<span class="ruby-identifier">kill</span>(<span class="ruby-value">15</span>,<span class="ruby-identifier">pid_id</span>)&#x000A;41: <span class="ruby-constant">File</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-ivar">@pid</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-ivar">@pid</span>)&#x000A;42: <span class="ruby-keyword kw">end</span></pre>
153
- </div>
154
- </div>
155
- </div>
156
- </div>
157
- </div>
158
- </div>
159
- <div id='footer-push'></div>
160
- </div>
161
- <div id='footer'>
162
- <a href="http://github.com/mislav/hanna/tree/master"><strong>Hanna</strong> RDoc template</a>
163
- </div>
164
- </body>
165
- </html>
data/doc/rdoc/classes/Siffer/Messages.html DELETED
@@ -1,81 +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>Module: Siffer::Messages [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'>Module</span>
30
- Siffer::Messages
31
- </h1>
32
- <ol class='paths'>
33
- <li>
34
- <a href="../../files/lib/siffer/messages/ack_rb.html">lib/siffer/messages/ack.rb</a>
35
- </li>
36
- <li class='other'>
37
- <a href="../../files/lib/siffer/messages/acl_rb.html">lib/siffer/messages/acl.rb</a>
38
- </li>
39
- <li class='other'>
40
- <a href="../../files/lib/siffer/messages/error_rb.html">lib/siffer/messages/error.rb</a>
41
- </li>
42
- <li class='other'>
43
- <a href="../../files/lib/siffer/messages/message_rb.html">lib/siffer/messages/message.rb</a>
44
- </li>
45
- <li class='other'>
46
- <a href="../../files/lib/siffer/messages/register_rb.html">lib/siffer/messages/register.rb</a>
47
- </li>
48
- <li class='other'>
49
- <a href="../../files/lib/siffer/messages/request_body_rb.html">lib/siffer/messages/request_body.rb</a>
50
- </li>
51
- <li class='other'>
52
- <a href="../../files/lib/siffer/messages/status_rb.html">lib/siffer/messages/status.rb</a>
53
- </li>
54
- <li>
55
- <a class='show' href='#' onclick='this.parentNode.parentNode.className += " expanded"; this.parentNode.removeChild(this); return false'>show all</a>
56
- </li>
57
- </ol>
58
- </div>
59
- <div id='content'>
60
- <div id='text'>
61
- <div id='section'>
62
- <div id='class-list'>
63
- <h2>Classes and Modules</h2>
64
- Class <a href="Messages/Ack.html" class="link">Siffer::Messages::Ack</a><br />
65
- Class <a href="Messages/Acl.html" class="link">Siffer::Messages::Acl</a><br />
66
- Class <a href="Messages/Error.html" class="link">Siffer::Messages::Error</a><br />
67
- Class <a href="Messages/Message.html" class="link">Siffer::Messages::Message</a><br />
68
- Class <a href="Messages/Register.html" class="link">Siffer::Messages::Register</a><br />
69
- Class <a href="Messages/RequestBody.html" class="link">Siffer::Messages::RequestBody</a><br />
70
- Class <a href="Messages/Status.html" class="link">Siffer::Messages::Status</a><br />
71
- </div>
72
- </div>
73
- </div>
74
- </div>
75
- <div id='footer-push'></div>
76
- </div>
77
- <div id='footer'>
78
- <a href="http://github.com/mislav/hanna/tree/master"><strong>Hanna</strong> RDoc template</a>
79
- </div>
80
- </body>
81
- </html>
data/doc/rdoc/classes/Siffer/Messages/Ack.html DELETED
@@ -1,115 +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::Ack [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::Ack
31
- </h1>
32
- <ol class='paths'>
33
- <li>
34
- <a href="../../../files/lib/siffer/messages/ack_rb.html">lib/siffer/messages/ack.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
- Acknowledge <a href="Message.html">Message</a> Used by <a
47
- href="../Server.html">Server</a> and <a href="../Agent.html">Agent</a> to
48
- &#8220;acknowledge&#8221; receipt of a message. Allows Erorr and <a
49
- href="Status.html">Status</a> messages to be injected into the body.
50
- </p>
51
- </div>
52
- <div id='method-list'>
53
- <h2>Methods</h2>
54
- <h3>public class</h3>
55
- <ol>
56
- <li><a href="#M000033">new</a></li>
57
- </ol>
58
- <h3>public instance</h3>
59
- <ol>
60
- <li><a href="#M000034">content</a></li>
61
- </ol>
62
- </div>
63
- <div id='section'>
64
- <div id='attribute-list'>
65
- <h2 class='section-bar'>Attributes</h2>
66
- <div class='name-list'>
67
- <table>
68
- <tr class='top-aligned-row context-row'>
69
- <td class='context-item-name'>original_msg</td>
70
- <td class='context-item-value'>[R]</td>
71
- <td class='context-item-desc'></td>
72
- </tr>
73
- </table>
74
- </div>
75
- </div>
76
- <div id='methods'>
77
- <h2>Public class methods</h2>
78
- <div class='public-class method' id='method-M000033'>
79
- <a name='M000033'> </a>
80
- <div class='synopsis'>
81
- <span class='name'>new</span>
82
- <span class='arguments'>(source, original, options = {})</span>
83
- </div>
84
- <div class='source'>
85
- <a class='source-toggle' href='#' onclick="toggleCode('M000033-source'); return false">
86
- [show source]
87
- </a>
88
- <pre id='M000033-source'> <span class="ruby-comment cmt"># File lib/siffer/messages/ack.rb, line 12</span>&#x000A;12: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">source</span>, <span class="ruby-identifier">original</span>, <span class="ruby-identifier">options</span> = {})&#x000A;13: <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-value str">&quot;Original message is required&quot;</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">original</span>&#x000A;14: <span class="ruby-keyword kw">super</span>(<span class="ruby-identifier">source</span>, <span class="ruby-identifier">options</span>)&#x000A;15: <span class="ruby-ivar">@original_msg</span> = <span class="ruby-identifier">original</span>&#x000A;16: <span class="ruby-ivar">@error</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:error</span>] <span class="ruby-operator">||</span> <span class="ruby-keyword kw">nil</span>&#x000A;17: <span class="ruby-ivar">@status</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">:status</span>] <span class="ruby-operator">||</span> <span class="ruby-keyword kw">nil</span>&#x000A;18: <span class="ruby-keyword kw">end</span></pre>
89
- </div>
90
- </div>
91
- <h2>Public instance methods</h2>
92
- <div class='public-instance method' id='method-M000034'>
93
- <a name='M000034'> </a>
94
- <div class='synopsis'>
95
- <span class='name'>content</span>
96
- <span class='arguments'>()</span>
97
- </div>
98
- <div class='source'>
99
- <a class='source-toggle' href='#' onclick="toggleCode('M000034-source'); return false">
100
- [show source]
101
- </a>
102
- <pre id='M000034-source'> <span class="ruby-comment cmt"># File lib/siffer/messages/ack.rb, line 20</span>&#x000A;20: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">content</span>&#x000A;21: <span class="ruby-identifier">body</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ack</span><span class="ruby-operator">|</span>&#x000A;22: <span class="ruby-identifier">ack</span>.<span class="ruby-constant">SIF_Ack</span>() { <span class="ruby-operator">|</span><span class="ruby-identifier">xml</span><span class="ruby-operator">|</span>&#x000A;23: <span class="ruby-identifier">put_header_into</span> <span class="ruby-identifier">xml</span>&#x000A;24: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@original_msg</span>.<span class="ruby-identifier">source_id</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-keyword kw">or</span> <span class="ruby-ivar">@original_msg</span>.<span class="ruby-identifier">source_id</span> <span class="ruby-operator">==</span> <span class="ruby-value str">&quot;&quot;</span>&#x000A;25: <span class="ruby-identifier">xml</span>.<span class="ruby-constant">SIF_OriginalSourceId</span>&#x000A;26: <span class="ruby-keyword kw">else</span>&#x000A;27: <span class="ruby-identifier">xml</span>.<span class="ruby-constant">SIF_OriginalSourceId</span>(<span class="ruby-ivar">@original_msg</span>.<span class="ruby-identifier">source_id</span>)&#x000A;28: <span class="ruby-keyword kw">end</span>&#x000A;29: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@original_msg</span>.<span class="ruby-identifier">msg_id</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-keyword kw">or</span> <span class="ruby-ivar">@original_msg</span>.<span class="ruby-identifier">msg_id</span> <span class="ruby-operator">==</span> <span class="ruby-value str">&quot;&quot;</span>&#x000A;30: <span class="ruby-identifier">xml</span>.<span class="ruby-constant">SIF_OriginalMsgId</span>&#x000A;31: <span class="ruby-keyword kw">else</span>&#x000A;32: <span class="ruby-identifier">xml</span>.<span class="ruby-constant">SIF_OriginalMsgId</span>(<span class="ruby-ivar">@original_msg</span>.<span class="ruby-identifier">msg_id</span>)&#x000A;33: <span class="ruby-keyword kw">end</span>&#x000A;34: <span class="ruby-identifier">xml</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-ivar">@error</span>.<span class="ruby-identifier">read</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@error</span>.<span class="ruby-identifier">nil?</span>&#x000A;35: <span class="ruby-identifier">xml</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-ivar">@status</span>.<span class="ruby-identifier">read</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@status</span>.<span class="ruby-identifier">nil?</span>&#x000A;36: }&#x000A;37: <span class="ruby-keyword kw">end</span>&#x000A;38: <span class="ruby-keyword kw">end</span></pre>
103
- </div>
104
- </div>
105
- </div>
106
- </div>
107
- </div>
108
- </div>
109
- <div id='footer-push'></div>
110
- </div>
111
- <div id='footer'>
112
- <a href="http://github.com/mislav/hanna/tree/master"><strong>Hanna</strong> RDoc template</a>
113
- </div>
114
- </body>
115
- </html>
data/doc/rdoc/classes/Siffer/Messages/Acl.html DELETED
@@ -1,83 +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::Acl [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::Acl
31
- </h1>
32
- <ol class='paths'>
33
- <li>
34
- <a href="../../../files/lib/siffer/messages/acl_rb.html">lib/siffer/messages/acl.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='method-list'>
45
- <h2>Methods</h2>
46
- <h3>public instance</h3>
47
- <ol>
48
- <li><a href="#M000040">read</a></li>
49
- </ol>
50
- </div>
51
- <div id='section'>
52
- <div id='methods'>
53
- <h2>Public instance methods</h2>
54
- <div class='public-instance method' id='method-M000040'>
55
- <a name='M000040'> </a>
56
- <div class='synopsis'>
57
- <span class='name'>read</span>
58
- <span class='arguments'>()</span>
59
- </div>
60
- <div class='description'>
61
- <p>
62
- This class roles through all the objects in all the contexts in the zone to
63
- provide a list of allowed actions on each object per registered agent
64
- </p>
65
- </div>
66
- <div class='source'>
67
- <a class='source-toggle' href='#' onclick="toggleCode('M000040-source'); return false">
68
- [show source]
69
- </a>
70
- <pre id='M000040-source'> <span class="ruby-comment cmt"># File lib/siffer/messages/acl.rb, line 9</span>&#x000A; 9: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">read</span>&#x000A;10: <span class="ruby-identifier">xml</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;11: <span class="ruby-identifier">xml</span>.<span class="ruby-constant">SIF_AgentAcl</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">xml</span><span class="ruby-operator">|</span>&#x000A;12: <span class="ruby-comment cmt"># each one of these would collect all objects for each context</span>&#x000A;13: <span class="ruby-identifier">xml</span>.<span class="ruby-constant">SIF_ProvideAccess</span>&#x000A;14: <span class="ruby-identifier">xml</span>.<span class="ruby-constant">SIF_SubscribeAccess</span>&#x000A;15: <span class="ruby-identifier">xml</span>.<span class="ruby-constant">SIF_PublishAddAccess</span>&#x000A;16: <span class="ruby-identifier">xml</span>.<span class="ruby-constant">SIF_PublishChangeAccess</span>&#x000A;17: <span class="ruby-identifier">xml</span>.<span class="ruby-constant">SIF_PublishDeleteAccess</span>&#x000A;18: <span class="ruby-identifier">xml</span>.<span class="ruby-constant">SIF_RequestAccess</span>&#x000A;19: <span class="ruby-identifier">xml</span>.<span class="ruby-constant">SIF_RespondAccess</span>&#x000A;20: }&#x000A;21: <span class="ruby-keyword kw">end</span></pre>
71
- </div>
72
- </div>
73
- </div>
74
- </div>
75
- </div>
76
- </div>
77
- <div id='footer-push'></div>
78
- </div>
79
- <div id='footer'>
80
- <a href="http://github.com/mislav/hanna/tree/master"><strong>Hanna</strong> RDoc template</a>
81
- </div>
82
- </body>
83
- </html>
data/doc/rdoc/classes/Siffer/Messages/Error.html DELETED
@@ -1,157 +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::Error [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::Error
31
- </h1>
32
- <ol class='paths'>
33
- <li>
34
- <a href="../../../files/lib/siffer/messages/error_rb.html">lib/siffer/messages/error.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='method-list'>
45
- <h2>Methods</h2>
46
- <h3>public class</h3>
47
- <ol>
48
- <li><a href="#M000030">new</a></li>
49
- </ol>
50
- <h3>public instance</h3>
51
- <ol>
52
- <li><a href="#M000031">read</a></li>
53
- <li><a href="#M000032">to_str</a></li>
54
- </ol>
55
- </div>
56
- <div id='section'>
57
- <div id='constants-list'>
58
- <h2>Constants</h2>
59
- <div class='name-list'>
60
- <table summary='Constants'>
61
- <tr class='top-aligned-row context-row'>
62
- <td class='context-item-name'>CATEGORY</td>
63
- <td>=</td>
64
- <td class='context-item-value'>[ &quot;Unknown (This should NEVER be used if possible)&quot;, &quot;XML Validation&quot;, &quot;Encryption&quot;, &quot;Authentication&quot;, &quot;Access and Permissions&quot;, &quot;Registration&quot;, &quot;Provision&quot;, &quot;Subscription&quot;, &quot;Request and Response&quot;, &quot;Event Reporting and Processing&quot;, &quot;Transport&quot;, &quot;System (OS, Database, Vendor localized, etc.)&quot;, &quot;Generic Message Handling&quot;, &quot;SMB Handling&quot; ]</td>
65
- <td>&nbsp;</td>
66
- <td class='context-item-desc'>
67
-
68
- Categories of Errors specified by SIF
69
- </td>
70
- </tr>
71
- <tr class='top-aligned-row context-row'>
72
- <td class='context-item-name'>CODE</td>
73
- <td>=</td>
74
- <td class='context-item-value'>{ CATEGORY[1] =&gt; [ # Xml Validation &quot;&quot;, &quot;Generic error&quot;, &quot;Message is not well-formed&quot;, &quot;Generic validation error&quot;, &quot;Invalid value for element/attribute&quot;, &quot;&quot;, &quot;Missing mandatory element/attribute&quot; ], CATEGORY[2] =&gt; [ # Encryption &quot;&quot;, &quot;Generic error&quot;</td>
75
- <td>&nbsp;</td>
76
- <td class='context-item-desc'>
77
-
78
- Codes related to CATEGORY Some codes are blank to match the SIF Spec
79
- </td>
80
- </tr>
81
- </table>
82
- </div>
83
- </div>
84
- <div id='attribute-list'>
85
- <h2 class='section-bar'>Attributes</h2>
86
- <div class='name-list'>
87
- <table>
88
- <tr class='top-aligned-row context-row'>
89
- <td class='context-item-name'>category</td>
90
- <td class='context-item-value'>[R]</td>
91
- <td class='context-item-desc'></td>
92
- </tr>
93
- <tr class='top-aligned-row context-row'>
94
- <td class='context-item-name'>code</td>
95
- <td class='context-item-value'>[R]</td>
96
- <td class='context-item-desc'></td>
97
- </tr>
98
- <tr class='top-aligned-row context-row'>
99
- <td class='context-item-name'>description</td>
100
- <td class='context-item-value'>[R]</td>
101
- <td class='context-item-desc'></td>
102
- </tr>
103
- </table>
104
- </div>
105
- </div>
106
- <div id='methods'>
107
- <h2>Public class methods</h2>
108
- <div class='public-class method' id='method-M000030'>
109
- <a name='M000030'> </a>
110
- <div class='synopsis'>
111
- <span class='name'>new</span>
112
- <span class='arguments'>(category, code, desc = nil)</span>
113
- </div>
114
- <div class='source'>
115
- <a class='source-toggle' href='#' onclick="toggleCode('M000030-source'); return false">
116
- [show source]
117
- </a>
118
- <pre id='M000030-source'> <span class="ruby-comment cmt"># File lib/siffer/messages/error.rb, line 7</span>&#x000A; 7: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">category</span>, <span class="ruby-identifier">code</span>, <span class="ruby-identifier">desc</span> = <span class="ruby-keyword kw">nil</span>)&#x000A; 8: <span class="ruby-ivar">@category</span> = <span class="ruby-constant">CATEGORY</span>[<span class="ruby-identifier">category</span>]&#x000A; 9: <span class="ruby-ivar">@category_index</span> = <span class="ruby-identifier">category</span>&#x000A;10: <span class="ruby-ivar">@code</span> = <span class="ruby-constant">CODE</span>[<span class="ruby-ivar">@category</span>][<span class="ruby-identifier">code</span>]&#x000A;11: <span class="ruby-ivar">@code_index</span> = <span class="ruby-identifier">code</span>&#x000A;12: <span class="ruby-ivar">@description</span> = <span class="ruby-identifier">desc</span>&#x000A;13: <span class="ruby-keyword kw">end</span></pre>
119
- </div>
120
- </div>
121
- <h2>Public instance methods</h2>
122
- <div class='public-instance method' id='method-M000031'>
123
- <a name='M000031'> </a>
124
- <div class='synopsis'>
125
- <span class='name'>read</span>
126
- <span class='arguments'>()</span>
127
- </div>
128
- <div class='source'>
129
- <a class='source-toggle' href='#' onclick="toggleCode('M000031-source'); return false">
130
- [show source]
131
- </a>
132
- <pre id='M000031-source'> <span class="ruby-comment cmt"># File lib/siffer/messages/error.rb, line 15</span>&#x000A;15: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">read</span>&#x000A;16: <span class="ruby-identifier">xml</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-identifier">xml</span>.<span class="ruby-constant">SIF_Error</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">error</span><span class="ruby-operator">|</span>&#x000A;18: <span class="ruby-identifier">error</span>.<span class="ruby-constant">SIF_Category</span>(<span class="ruby-ivar">@category_index</span>)&#x000A;19: <span class="ruby-identifier">error</span>.<span class="ruby-constant">SIF_Code</span>(<span class="ruby-ivar">@code_index</span>)&#x000A;20: <span class="ruby-identifier">error</span>.<span class="ruby-constant">SIF_Desc</span>(<span class="ruby-ivar">@code</span>)&#x000A;21: <span class="ruby-identifier">error</span>.<span class="ruby-constant">SIF_ExtendedDesc</span>(<span class="ruby-ivar">@description</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@description</span>.<span class="ruby-identifier">nil?</span>&#x000A;22: }&#x000A;23: <span class="ruby-keyword kw">end</span></pre>
133
- </div>
134
- </div>
135
- <div class='public-instance method' id='method-M000032'>
136
- <a name='M000032'> </a>
137
- <div class='synopsis'>
138
- <span class='name'>to_str</span>
139
- <span class='arguments'>()</span>
140
- </div>
141
- <div class='description'>
142
- <p>
143
- Alias for <a href="Error.html#M000031">read</a>
144
- </p>
145
- </div>
146
- </div>
147
- </div>
148
- </div>
149
- </div>
150
- </div>
151
- <div id='footer-push'></div>
152
- </div>
153
- <div id='footer'>
154
- <a href="http://github.com/mislav/hanna/tree/master"><strong>Hanna</strong> RDoc template</a>
155
- </div>
156
- </body>
157
- </html>