siffer 0.0.4 → 0.0.5
Sign up to get free protection for your applications and to get access to all the features.
- data/Rakefile +2 -2
- data/doc/rdoc/classes/Siffer.html +253 -368
- data/doc/rdoc/classes/Siffer/Agent.html +169 -288
- data/doc/rdoc/classes/Siffer/Container.html +158 -279
- data/doc/rdoc/classes/Siffer/Messages.html +79 -139
- data/doc/rdoc/classes/Siffer/Messages/Ack.html +109 -210
- data/doc/rdoc/classes/Siffer/Messages/Acl.html +78 -155
- data/doc/rdoc/classes/Siffer/Messages/Error.html +151 -242
- data/doc/rdoc/classes/Siffer/Messages/Message.html +227 -351
- data/doc/rdoc/classes/Siffer/Messages/Message/Header.html +102 -176
- data/doc/rdoc/classes/Siffer/Messages/Register.html +147 -250
- data/doc/rdoc/classes/Siffer/Messages/RequestBody.html +177 -292
- data/doc/rdoc/classes/Siffer/Messages/Status.html +149 -262
- data/doc/rdoc/classes/Siffer/Messaging.html +204 -323
- data/doc/rdoc/classes/Siffer/Protocol.html +246 -380
- data/doc/rdoc/classes/Siffer/Protocol/NonPostRequest.html +53 -110
- data/doc/rdoc/classes/Siffer/Protocol/UnknownPath.html +53 -110
- data/doc/rdoc/classes/Siffer/Registration.html +243 -383
- data/doc/rdoc/classes/Siffer/Request.html +97 -203
- data/doc/rdoc/classes/Siffer/RequestLogger.html +102 -204
- data/doc/rdoc/classes/Siffer/Response.html +85 -176
- data/doc/rdoc/classes/Siffer/Server.html +150 -236
- data/doc/rdoc/created.rid +1 -1
- data/doc/rdoc/files/LICENSE.html +75 -128
- data/doc/rdoc/files/README_rdoc.html +130 -183
- data/doc/rdoc/files/lib/siffer/agent_rb.html +49 -0
- data/doc/rdoc/files/lib/siffer/container_rb.html +57 -0
- data/doc/rdoc/files/lib/siffer/messages/ack_rb.html +49 -0
- data/doc/rdoc/files/lib/siffer/messages/acl_rb.html +49 -0
- data/doc/rdoc/files/lib/siffer/messages/error_rb.html +49 -0
- data/doc/rdoc/files/lib/siffer/messages/message_rb.html +49 -0
- data/doc/rdoc/files/lib/siffer/messages/register_rb.html +49 -0
- data/doc/rdoc/files/lib/siffer/messages/request_body_rb.html +49 -0
- data/doc/rdoc/files/lib/siffer/messages/status_rb.html +49 -0
- data/doc/rdoc/files/lib/siffer/messages_rb.html +63 -0
- data/doc/rdoc/files/lib/siffer/messaging_rb.html +49 -0
- data/doc/rdoc/files/lib/siffer/protocol_rb.html +49 -0
- data/doc/rdoc/files/lib/siffer/registration_rb.html +49 -0
- data/doc/rdoc/files/lib/siffer/request_logger_rb.html +49 -0
- data/doc/rdoc/files/lib/siffer/request_rb.html +49 -0
- data/doc/rdoc/files/lib/siffer/response_rb.html +49 -0
- data/doc/rdoc/files/lib/siffer/server_rb.html +49 -0
- data/doc/rdoc/files/lib/siffer_rb.html +62 -113
- data/doc/rdoc/fr_class_index.html +25 -47
- data/doc/rdoc/fr_file_index.html +39 -46
- data/doc/rdoc/fr_method_index.html +4539 -96
- data/doc/rdoc/index.html +14 -23
- data/doc/rdoc/rdoc-style.css +314 -203
- data/lib/siffer.rb +6 -6
- data/lib/{agent.rb → siffer/agent.rb} +5 -3
- data/lib/{container.rb → siffer/container.rb} +3 -5
- data/lib/siffer/messages.rb +7 -0
- data/lib/{messages → siffer/messages}/ack.rb +0 -0
- data/lib/{messages → siffer/messages}/acl.rb +0 -0
- data/lib/{messages → siffer/messages}/error.rb +0 -0
- data/lib/{messages → siffer/messages}/message.rb +0 -0
- data/lib/{messages → siffer/messages}/register.rb +0 -0
- data/lib/{messages → siffer/messages}/request_body.rb +0 -0
- data/lib/{messages → siffer/messages}/status.rb +0 -0
- data/lib/{messaging.rb → siffer/messaging.rb} +8 -5
- data/lib/{protocol.rb → siffer/protocol.rb} +37 -32
- data/lib/{registration.rb → siffer/registration.rb} +2 -2
- data/lib/siffer/request.rb +28 -0
- data/lib/{request_logger.rb → siffer/request_logger.rb} +8 -7
- data/lib/{response.rb → siffer/response.rb} +1 -1
- data/lib/{server.rb → siffer/server.rb} +5 -3
- data/spec/agent_spec.rb +6 -11
- data/spec/container_spec.rb +2 -2
- data/spec/default_agent +1 -1
- data/spec/messaging_spec.rb +3 -6
- data/spec/protocol_spec.rb +27 -26
- data/spec/registration_spec.rb +2 -2
- data/spec/request_logger_spec.rb +22 -9
- data/spec/request_spec.rb +15 -0
- data/spec/response_spec.rb +2 -2
- data/spec/server_spec.rb +0 -5
- data/spec/spec_helper.rb +9 -0
- metadata +40 -38
- data/doc/rdoc/files/lib/agent_rb.html +0 -101
- data/doc/rdoc/files/lib/container_rb.html +0 -108
- data/doc/rdoc/files/lib/messages/ack_rb.html +0 -101
- data/doc/rdoc/files/lib/messages/acl_rb.html +0 -101
- data/doc/rdoc/files/lib/messages/error_rb.html +0 -101
- data/doc/rdoc/files/lib/messages/message_rb.html +0 -101
- data/doc/rdoc/files/lib/messages/register_rb.html +0 -101
- data/doc/rdoc/files/lib/messages/request_body_rb.html +0 -101
- data/doc/rdoc/files/lib/messages/status_rb.html +0 -101
- data/doc/rdoc/files/lib/messages_rb.html +0 -114
- data/doc/rdoc/files/lib/messaging_rb.html +0 -101
- data/doc/rdoc/files/lib/protocol_rb.html +0 -101
- data/doc/rdoc/files/lib/registration_rb.html +0 -101
- data/doc/rdoc/files/lib/request_logger_rb.html +0 -101
- data/doc/rdoc/files/lib/request_rb.html +0 -101
- data/doc/rdoc/files/lib/response_rb.html +0 -101
- data/doc/rdoc/files/lib/server_rb.html +0 -101
- data/lib/messages.rb +0 -7
- data/lib/request.rb +0 -25
|
@@ -1,248 +1,157 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
<
|
|
7
|
-
<
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
// ]]>
|
|
42
|
-
</script>
|
|
43
|
-
|
|
44
|
-
</head>
|
|
45
|
-
<body>
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
<div id="classHeader">
|
|
50
|
-
<table class="header-table">
|
|
51
|
-
<tr class="top-aligned-row">
|
|
52
|
-
<td><strong>Class</strong></td>
|
|
53
|
-
<td class="class-name-in-header">Siffer::Messages::Error</td>
|
|
54
|
-
</tr>
|
|
55
|
-
<tr class="top-aligned-row">
|
|
56
|
-
<td><strong>In:</strong></td>
|
|
57
|
-
<td>
|
|
58
|
-
<a href="../../../files/lib/messages/error_rb.html">
|
|
59
|
-
lib/messages/error.rb
|
|
60
|
-
</a>
|
|
61
|
-
<br />
|
|
62
|
-
</td>
|
|
63
|
-
</tr>
|
|
64
|
-
|
|
65
|
-
<tr class="top-aligned-row">
|
|
66
|
-
<td><strong>Parent:</strong></td>
|
|
67
|
-
<td>
|
|
68
|
-
Object
|
|
69
|
-
</td>
|
|
70
|
-
</tr>
|
|
71
|
-
</table>
|
|
72
|
-
</div>
|
|
73
|
-
<!-- banner header -->
|
|
74
|
-
|
|
75
|
-
<div id="bodyContent">
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
<div id="contextContent">
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
</div>
|
|
84
|
-
|
|
85
|
-
<div id="method-list">
|
|
86
|
-
<h3 class="section-bar">Methods</h3>
|
|
87
|
-
|
|
88
|
-
<div class="name-list">
|
|
89
|
-
<a href="#M000029">new</a>
|
|
90
|
-
<a href="#M000030">read</a>
|
|
91
|
-
<a href="#M000031">to_str</a>
|
|
92
|
-
</div>
|
|
93
|
-
</div>
|
|
94
|
-
|
|
95
|
-
</div>
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
<!-- if includes -->
|
|
99
|
-
|
|
100
|
-
<div id="section">
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
<div id="constants-list">
|
|
104
|
-
<h3 class="section-bar">Constants</h3>
|
|
105
|
-
|
|
106
|
-
<div class="name-list">
|
|
107
|
-
<table summary="Constants">
|
|
108
|
-
<tr class="top-aligned-row context-row">
|
|
109
|
-
<td class="context-item-name">CATEGORY</td>
|
|
110
|
-
<td>=</td>
|
|
111
|
-
<td class="context-item-value">[ "Unknown (This should NEVER be used if possible)", "XML Validation", "Encryption", "Authentication", "Access and Permissions", "Registration", "Provision", "Subscription", "Request and Response", "Event Reporting and Processing", "Transport", "System (OS, Database, Vendor localized, etc.)", "Generic Message Handling", "SMB Handling"</td>
|
|
112
|
-
<td width="3em"> </td>
|
|
113
|
-
<td class="context-item-desc">
|
|
114
|
-
Categories of Errors specified by SIF
|
|
115
|
-
|
|
116
|
-
</td>
|
|
117
|
-
</tr>
|
|
118
|
-
<tr class="top-aligned-row context-row">
|
|
119
|
-
<td class="context-item-name">CODE</td>
|
|
120
|
-
<td>=</td>
|
|
121
|
-
<td class="context-item-value">{ CATEGORY[1] => [ # Xml Validation "", "Generic error", "Message is not well-formed", "Generic validation error", "Invalid value for element/attribute", "", "Missing mandatory element/attribute"</td>
|
|
122
|
-
<td width="3em"> </td>
|
|
123
|
-
<td class="context-item-desc">
|
|
124
|
-
Codes related to CATEGORY Some codes are blank to match the SIF Spec
|
|
125
|
-
|
|
126
|
-
</td>
|
|
127
|
-
</tr>
|
|
128
|
-
</table>
|
|
129
|
-
</div>
|
|
130
|
-
</div>
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
<div id="attribute-list">
|
|
135
|
-
<h3 class="section-bar">Attributes</h3>
|
|
136
|
-
|
|
137
|
-
<div class="name-list">
|
|
138
|
-
<table>
|
|
139
|
-
<tr class="top-aligned-row context-row">
|
|
140
|
-
<td class="context-item-name">category</td>
|
|
141
|
-
<td class="context-item-value"> [R] </td>
|
|
142
|
-
<td class="context-item-desc"></td>
|
|
143
|
-
</tr>
|
|
144
|
-
<tr class="top-aligned-row context-row">
|
|
145
|
-
<td class="context-item-name">code</td>
|
|
146
|
-
<td class="context-item-value"> [R] </td>
|
|
147
|
-
<td class="context-item-desc"></td>
|
|
148
|
-
</tr>
|
|
149
|
-
<tr class="top-aligned-row context-row">
|
|
150
|
-
<td class="context-item-name">description</td>
|
|
151
|
-
<td class="context-item-value"> [R] </td>
|
|
152
|
-
<td class="context-item-desc"></td>
|
|
153
|
-
</tr>
|
|
154
|
-
</table>
|
|
155
|
-
</div>
|
|
156
|
-
</div>
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
<!-- if method_list -->
|
|
161
|
-
<div id="methods">
|
|
162
|
-
<h3 class="section-bar">Public Class methods</h3>
|
|
163
|
-
|
|
164
|
-
<div id="method-M000029" class="method-detail">
|
|
165
|
-
<a name="M000029"></a>
|
|
166
|
-
|
|
167
|
-
<div class="method-heading">
|
|
168
|
-
<a href="#M000029" class="method-signature">
|
|
169
|
-
<span class="method-name">new</span><span class="method-args">(category, code, desc = nil)</span>
|
|
170
|
-
</a>
|
|
171
|
-
</div>
|
|
172
|
-
|
|
173
|
-
<div class="method-description">
|
|
174
|
-
<p><a class="source-toggle" href="#"
|
|
175
|
-
onclick="toggleCode('M000029-source');return false;">[Source]</a></p>
|
|
176
|
-
<div class="method-source-code" id="M000029-source">
|
|
177
|
-
<pre>
|
|
178
|
-
<span class="ruby-comment cmt"># File lib/messages/error.rb, line 7</span>
|
|
179
|
-
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>)
|
|
180
|
-
8: <span class="ruby-ivar">@category</span> = <span class="ruby-constant">CATEGORY</span>[<span class="ruby-identifier">category</span>]
|
|
181
|
-
9: <span class="ruby-ivar">@category_index</span> = <span class="ruby-identifier">category</span>
|
|
182
|
-
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>]
|
|
183
|
-
11: <span class="ruby-ivar">@code_index</span> = <span class="ruby-identifier">code</span>
|
|
184
|
-
12: <span class="ruby-ivar">@description</span> = <span class="ruby-identifier">desc</span>
|
|
185
|
-
13: <span class="ruby-keyword kw">end</span>
|
|
186
|
-
</pre>
|
|
187
|
-
</div>
|
|
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>
|
|
188
40
|
</div>
|
|
189
41
|
</div>
|
|
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
|
-
</
|
|
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'>[ "Unknown (This should NEVER be used if possible)", "XML Validation", "Encryption", "Authentication", "Access and Permissions", "Registration", "Provision", "Subscription", "Request and Response", "Event Reporting and Processing", "Transport", "System (OS, Database, Vendor localized, etc.)", "Generic Message Handling", "SMB Handling" ]</td>
|
|
65
|
+
<td> </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] => [ # Xml Validation "", "Generic error", "Message is not well-formed", "Generic validation error", "Invalid value for element/attribute", "", "Missing mandatory element/attribute" ], CATEGORY[2] => [ # Encryption "", "Generic error"</td>
|
|
75
|
+
<td> </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>
 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>)
 8: <span class="ruby-ivar">@category</span> = <span class="ruby-constant">CATEGORY</span>[<span class="ruby-identifier">category</span>]
 9: <span class="ruby-ivar">@category_index</span> = <span class="ruby-identifier">category</span>
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>]
11: <span class="ruby-ivar">@code_index</span> = <span class="ruby-identifier">code</span>
12: <span class="ruby-ivar">@description</span> = <span class="ruby-identifier">desc</span>
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>
15: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">read</span>
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>
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>
18: <span class="ruby-identifier">error</span>.<span class="ruby-constant">SIF_Category</span>(<span class="ruby-ivar">@category_index</span>)
19: <span class="ruby-identifier">error</span>.<span class="ruby-constant">SIF_Code</span>(<span class="ruby-ivar">@code_index</span>)
20: <span class="ruby-identifier">error</span>.<span class="ruby-constant">SIF_Desc</span>(<span class="ruby-ivar">@code</span>)
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>
22: }
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>
|
|
218
148
|
</div>
|
|
219
149
|
</div>
|
|
220
150
|
</div>
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
<div class="method-heading">
|
|
226
|
-
<span class="method-name">to_str</span><span class="method-args">()</span>
|
|
227
|
-
</div>
|
|
228
|
-
|
|
229
|
-
<div class="method-description">
|
|
230
|
-
<p>
|
|
231
|
-
Alias for <a href="Error.html#M000030">read</a>
|
|
232
|
-
</p>
|
|
233
|
-
</div>
|
|
234
|
-
</div>
|
|
235
|
-
|
|
236
|
-
|
|
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>
|
|
237
155
|
</div>
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
</div>
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
<div id="validator-badges">
|
|
244
|
-
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
|
|
245
|
-
</div>
|
|
246
|
-
|
|
247
|
-
</body>
|
|
248
|
-
</html>
|
|
156
|
+
</body>
|
|
157
|
+
</html>
|
|
@@ -1,359 +1,235 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
<
|
|
7
|
-
<
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
// ]]>
|
|
42
|
-
</script>
|
|
43
|
-
|
|
44
|
-
</head>
|
|
45
|
-
<body>
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
<div id="classHeader">
|
|
50
|
-
<table class="header-table">
|
|
51
|
-
<tr class="top-aligned-row">
|
|
52
|
-
<td><strong>Class</strong></td>
|
|
53
|
-
<td class="class-name-in-header">Siffer::Messages::Message</td>
|
|
54
|
-
</tr>
|
|
55
|
-
<tr class="top-aligned-row">
|
|
56
|
-
<td><strong>In:</strong></td>
|
|
57
|
-
<td>
|
|
58
|
-
<a href="../../../files/lib/messages/message_rb.html">
|
|
59
|
-
lib/messages/message.rb
|
|
60
|
-
</a>
|
|
61
|
-
<br />
|
|
62
|
-
</td>
|
|
63
|
-
</tr>
|
|
64
|
-
|
|
65
|
-
<tr class="top-aligned-row">
|
|
66
|
-
<td><strong>Parent:</strong></td>
|
|
67
|
-
<td>
|
|
68
|
-
Object
|
|
69
|
-
</td>
|
|
70
|
-
</tr>
|
|
71
|
-
</table>
|
|
72
|
-
</div>
|
|
73
|
-
<!-- banner header -->
|
|
74
|
-
|
|
75
|
-
<div id="bodyContent">
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
<div id="contextContent">
|
|
80
|
-
|
|
81
|
-
<div id="description">
|
|
82
|
-
<p>
|
|
83
|
-
Base class for all <a href="../Messages.html">Messages</a> in the
|
|
84
|
-
framework. Embeds the XMLNS as well as the version of SIF implemented.
|
|
85
|
-
</p>
|
|
86
|
-
|
|
87
|
-
</div>
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
</div>
|
|
91
|
-
|
|
92
|
-
<div id="method-list">
|
|
93
|
-
<h3 class="section-bar">Methods</h3>
|
|
94
|
-
|
|
95
|
-
<div class="name-list">
|
|
96
|
-
<a href="#M000021">body</a>
|
|
97
|
-
<a href="#M000018">content</a>
|
|
98
|
-
<a href="#M000020">msg_id</a>
|
|
99
|
-
<a href="#M000017">new</a>
|
|
100
|
-
<a href="#M000022">put_header_into</a>
|
|
101
|
-
<a href="#M000023">read</a>
|
|
102
|
-
<a href="#M000019">source_id</a>
|
|
103
|
-
<a href="#M000024">to_str</a>
|
|
104
|
-
</div>
|
|
105
|
-
</div>
|
|
106
|
-
|
|
107
|
-
</div>
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
<!-- if includes -->
|
|
111
|
-
|
|
112
|
-
<div id="section">
|
|
113
|
-
|
|
114
|
-
<div id="class-list">
|
|
115
|
-
<h3 class="section-bar">Classes and Modules</h3>
|
|
116
|
-
|
|
117
|
-
Class <a href="Message/Header.html" class="link">Siffer::Messages::Message::Header</a><br />
|
|
118
|
-
|
|
119
|
-
</div>
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
<div id="attribute-list">
|
|
125
|
-
<h3 class="section-bar">Attributes</h3>
|
|
126
|
-
|
|
127
|
-
<div class="name-list">
|
|
128
|
-
<table>
|
|
129
|
-
<tr class="top-aligned-row context-row">
|
|
130
|
-
<td class="context-item-name">header</td>
|
|
131
|
-
<td class="context-item-value"> [R] </td>
|
|
132
|
-
<td class="context-item-desc"></td>
|
|
133
|
-
</tr>
|
|
134
|
-
<tr class="top-aligned-row context-row">
|
|
135
|
-
<td class="context-item-name">version</td>
|
|
136
|
-
<td class="context-item-value"> [R] </td>
|
|
137
|
-
<td class="context-item-desc"></td>
|
|
138
|
-
</tr>
|
|
139
|
-
<tr class="top-aligned-row context-row">
|
|
140
|
-
<td class="context-item-name">xmlns</td>
|
|
141
|
-
<td class="context-item-value"> [R] </td>
|
|
142
|
-
<td class="context-item-desc"></td>
|
|
143
|
-
</tr>
|
|
144
|
-
</table>
|
|
145
|
-
</div>
|
|
146
|
-
</div>
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
<!-- if method_list -->
|
|
151
|
-
<div id="methods">
|
|
152
|
-
<h3 class="section-bar">Public Class methods</h3>
|
|
153
|
-
|
|
154
|
-
<div id="method-M000017" class="method-detail">
|
|
155
|
-
<a name="M000017"></a>
|
|
156
|
-
|
|
157
|
-
<div class="method-heading">
|
|
158
|
-
<a href="#M000017" class="method-signature">
|
|
159
|
-
<span class="method-name">new</span><span class="method-args">(source, options = {})</span>
|
|
160
|
-
</a>
|
|
161
|
-
</div>
|
|
162
|
-
|
|
163
|
-
<div class="method-description">
|
|
164
|
-
<p>
|
|
165
|
-
source parameter is required (string describing the original sender)
|
|
166
|
-
</p>
|
|
167
|
-
<p><a class="source-toggle" href="#"
|
|
168
|
-
onclick="toggleCode('M000017-source');return false;">[Source]</a></p>
|
|
169
|
-
<div class="method-source-code" id="M000017-source">
|
|
170
|
-
<pre>
|
|
171
|
-
<span class="ruby-comment cmt"># File lib/messages/message.rb, line 11</span>
|
|
172
|
-
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> = {})
|
|
173
|
-
12: <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-value str">"Source not provided."</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">source</span>.<span class="ruby-identifier">nil?</span>
|
|
174
|
-
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>
|
|
175
|
-
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>
|
|
176
|
-
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>)
|
|
177
|
-
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>
|
|
178
|
-
17: <span class="ruby-keyword kw">end</span>
|
|
179
|
-
</pre>
|
|
180
|
-
</div>
|
|
181
|
-
</div>
|
|
182
|
-
</div>
|
|
183
|
-
|
|
184
|
-
<h3 class="section-bar">Public Instance methods</h3>
|
|
185
|
-
|
|
186
|
-
<div id="method-M000021" class="method-detail">
|
|
187
|
-
<a name="M000021"></a>
|
|
188
|
-
|
|
189
|
-
<div class="method-heading">
|
|
190
|
-
<span class="method-name">body</span><span class="method-args">()</span>
|
|
191
|
-
</div>
|
|
192
|
-
|
|
193
|
-
<div class="method-description">
|
|
194
|
-
<p>
|
|
195
|
-
Alias for <a href="Message.html#M000018">content</a>
|
|
196
|
-
</p>
|
|
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>
|
|
197
40
|
</div>
|
|
198
41
|
</div>
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
</a>
|
|
207
|
-
</div>
|
|
208
|
-
|
|
209
|
-
<div class="method-description">
|
|
210
|
-
<p>
|
|
211
|
-
Builds the xml for this message. Accepts a block if nested elements are
|
|
212
|
-
required.
|
|
213
|
-
</p>
|
|
214
|
-
<p><a class="source-toggle" href="#"
|
|
215
|
-
onclick="toggleCode('M000018-source');return false;">[Source]</a></p>
|
|
216
|
-
<div class="method-source-code" id="M000018-source">
|
|
217
|
-
<pre>
|
|
218
|
-
<span class="ruby-comment cmt"># File lib/messages/message.rb, line 21</span>
|
|
219
|
-
21: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">content</span>
|
|
220
|
-
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">></span> <span class="ruby-ivar">@version</span>, <span class="ruby-identifier">:xmlns</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@xmlns</span>) { <span class="ruby-operator">|</span><span class="ruby-identifier">xml</span><span class="ruby-operator">|</span>
|
|
221
|
-
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>
|
|
222
|
-
24: }
|
|
223
|
-
25: <span class="ruby-keyword kw">end</span>
|
|
224
|
-
</pre>
|
|
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>
|
|
225
49
|
</div>
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
</
|
|
242
|
-
<p><a class="source-toggle" href="#"
|
|
243
|
-
onclick="toggleCode('M000020-source');return false;">[Source]</a></p>
|
|
244
|
-
<div class="method-source-code" id="M000020-source">
|
|
245
|
-
<pre>
|
|
246
|
-
<span class="ruby-comment cmt"># File lib/messages/message.rb, line 30</span>
|
|
247
|
-
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>
|
|
248
|
-
</pre>
|
|
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>
|
|
249
66
|
</div>
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
<
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
</
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
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>
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> = {})
12: <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-value str">"Source not provided."</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">source</span>.<span class="ruby-identifier">nil?</span>
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>
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>
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>)
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>
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>
21: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">content</span>
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">></span> <span class="ruby-ivar">@version</span>, <span class="ruby-identifier">:xmlns</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@xmlns</span>) { <span class="ruby-operator">|</span><span class="ruby-identifier">xml</span><span class="ruby-operator">|</span>
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>
24: }
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>
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>
36: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">put_header_into</span>(<span class="ruby-identifier">xml</span>)
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>
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>)
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>)
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>)
41: }
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>
45: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">read</span>
46: <span class="ruby-comment cmt"># this construct prevents the xml from being built</span>
47: <span class="ruby-comment cmt"># over and over again for every read made to this</span>
48: <span class="ruby-comment cmt"># message.</span>
49: <span class="ruby-ivar">@xml</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">content</span>
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>
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>
|
|
305
226
|
</div>
|
|
306
227
|
</div>
|
|
307
228
|
</div>
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
<div class="method-heading">
|
|
313
|
-
<a href="#M000019" class="method-signature">
|
|
314
|
-
<span class="method-name">source_id</span><span class="method-args">()</span>
|
|
315
|
-
</a>
|
|
316
|
-
</div>
|
|
317
|
-
|
|
318
|
-
<div class="method-description">
|
|
319
|
-
<p>
|
|
320
|
-
Alias method to the <a href="Message/Header.html">Header</a> SourceId
|
|
321
|
-
</p>
|
|
322
|
-
<p><a class="source-toggle" href="#"
|
|
323
|
-
onclick="toggleCode('M000019-source');return false;">[Source]</a></p>
|
|
324
|
-
<div class="method-source-code" id="M000019-source">
|
|
325
|
-
<pre>
|
|
326
|
-
<span class="ruby-comment cmt"># File lib/messages/message.rb, line 28</span>
|
|
327
|
-
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>
|
|
328
|
-
</pre>
|
|
329
|
-
</div>
|
|
330
|
-
</div>
|
|
331
|
-
</div>
|
|
332
|
-
|
|
333
|
-
<div id="method-M000024" class="method-detail">
|
|
334
|
-
<a name="M000024"></a>
|
|
335
|
-
|
|
336
|
-
<div class="method-heading">
|
|
337
|
-
<span class="method-name">to_str</span><span class="method-args">()</span>
|
|
338
|
-
</div>
|
|
339
|
-
|
|
340
|
-
<div class="method-description">
|
|
341
|
-
<p>
|
|
342
|
-
Alias for <a href="Message.html#M000023">read</a>
|
|
343
|
-
</p>
|
|
344
|
-
</div>
|
|
345
|
-
</div>
|
|
346
|
-
|
|
347
|
-
|
|
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>
|
|
348
233
|
</div>
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
</div>
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
<div id="validator-badges">
|
|
355
|
-
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
|
|
356
|
-
</div>
|
|
357
|
-
|
|
358
|
-
</body>
|
|
359
|
-
</html>
|
|
234
|
+
</body>
|
|
235
|
+
</html>
|