ionian 0.2.0 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,286 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta charset="UTF-8">
6
+
7
+ <title>module Ionian::Extension::Socket - RDoc Documentation</title>
8
+
9
+ <link href="../../fonts.css" rel="stylesheet">
10
+ <link href="../../rdoc.css" rel="stylesheet">
11
+
12
+ <script type="text/javascript">
13
+ var rdoc_rel_prefix = "../../";
14
+ </script>
15
+
16
+ <script src="../../js/jquery.js"></script>
17
+ <script src="../../js/navigation.js"></script>
18
+ <script src="../../js/search_index.js"></script>
19
+ <script src="../../js/search.js"></script>
20
+ <script src="../../js/searcher.js"></script>
21
+ <script src="../../js/darkfish.js"></script>
22
+
23
+
24
+ <body id="top" role="document" class="module">
25
+ <nav role="navigation">
26
+ <div id="project-navigation">
27
+ <div id="home-section" role="banner" class="nav-section">
28
+ <h2>
29
+ <a href="../../index.html" rel="home">Home</a>
30
+ </h2>
31
+
32
+ <h3>
33
+ <a href="../../table_of_contents.html#pages">Pages</a>
34
+ <a href="../../table_of_contents.html#classes">Classes</a>
35
+ <a href="../../table_of_contents.html#methods">Methods</a>
36
+ </h3>
37
+ </div>
38
+
39
+ <div id="search-section" role="search" class="project-section initially-hidden">
40
+ <form action="#" method="get" accept-charset="utf-8">
41
+ <div id="search-field-wrapper">
42
+ <input id="search-field" role="combobox" aria-label="Search"
43
+ aria-autocomplete="list" aria-controls="search-results"
44
+ type="text" name="search" placeholder="Search"
45
+ title="Type to search, Up and Down to navigate, Enter to load">
46
+ </div>
47
+
48
+ <ul id="search-results" aria-label="Search Results"
49
+ aria-busy="false" aria-expanded="false"
50
+ aria-atomic="false" aria-live="polite"
51
+ aria-relevant="all" class="initially-hidden"></ul>
52
+ </form>
53
+ </div>
54
+
55
+ </div>
56
+
57
+
58
+
59
+ <div id="class-metadata">
60
+
61
+
62
+
63
+ <div id="extends-section" class="nav-section">
64
+ <h3>Extended With Modules</h3>
65
+
66
+ <ul class="link-list">
67
+
68
+
69
+ <li><a class="extend" href="IO.html">Ionian::Extension::IO</a>
70
+
71
+
72
+ </ul>
73
+ </div>
74
+
75
+ <!-- Method Quickref -->
76
+ <div id="method-list-section" class="nav-section">
77
+ <h3>Methods</h3>
78
+
79
+ <ul class="link-list" role="directory">
80
+
81
+ <li ><a href="#method-c-extended">::extended</a>
82
+
83
+ <li ><a href="#method-i-initialize_ionian_socket">#initialize_ionian_socket</a>
84
+
85
+ <li ><a href="#method-i-no_delay">#no_delay</a>
86
+
87
+ <li ><a href="#method-i-no_delay-3D">#no_delay=</a>
88
+
89
+ </ul>
90
+ </div>
91
+
92
+ </div>
93
+ </nav>
94
+
95
+ <main role="main" aria-labelledby="module-Ionian::Extension::Socket">
96
+ <h1 id="module-Ionian::Extension::Socket" class="module">
97
+ module Ionian::Extension::Socket
98
+ </h1>
99
+
100
+ <section class="description">
101
+
102
+ <p>A mixin for <a href="Socket.html">Socket</a> objects.</p>
103
+
104
+ <p>This module was designed to be extended by instantiated objects that
105
+ implement the standard library <a href="Socket.html">Socket</a> class.
106
+ my_socket.extend <a href="../Socket.html">Ionian::Socket</a></p>
107
+
108
+ <p>Extending this module also extends Ionian::IO.</p>
109
+
110
+ </section>
111
+
112
+
113
+
114
+
115
+ <section id="5Buntitled-5D" class="documentation-section">
116
+
117
+
118
+
119
+
120
+
121
+
122
+
123
+
124
+
125
+ <section id="public-class-5Buntitled-5D-method-details" class="method-section">
126
+ <header>
127
+ <h3>Public Class Methods</h3>
128
+ </header>
129
+
130
+
131
+ <div id="method-c-extended" class="method-detail ">
132
+
133
+ <div class="method-heading">
134
+ <span class="method-name">extended</span><span
135
+ class="method-args">(obj)</span>
136
+
137
+ <span class="method-click-advice">click to toggle source</span>
138
+
139
+ </div>
140
+
141
+
142
+ <div class="method-description">
143
+
144
+ <p>Called automaticallly when the object is extended with extend.</p>
145
+
146
+
147
+
148
+
149
+ <div class="method-source-code" id="extended-source">
150
+ <pre><span class="ruby-comment"># File lib/ionian/extension/socket.rb, line 16</span>
151
+ <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">extended</span>(<span class="ruby-identifier">obj</span>)
152
+ <span class="ruby-identifier">obj</span>.<span class="ruby-identifier">extend</span> <span class="ruby-constant">Ionian</span><span class="ruby-operator">::</span><span class="ruby-constant">Extension</span><span class="ruby-operator">::</span><span class="ruby-constant">IO</span>
153
+ <span class="ruby-identifier">obj</span>.<span class="ruby-identifier">initialize_ionian_socket</span>
154
+ <span class="ruby-keyword">end</span></pre>
155
+ </div>
156
+
157
+ </div>
158
+
159
+
160
+
161
+
162
+ </div>
163
+
164
+
165
+ </section>
166
+
167
+ <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
168
+ <header>
169
+ <h3>Public Instance Methods</h3>
170
+ </header>
171
+
172
+
173
+ <div id="method-i-initialize_ionian_socket" class="method-detail ">
174
+
175
+ <div class="method-heading">
176
+ <span class="method-name">initialize_ionian_socket</span><span
177
+ class="method-args">()</span>
178
+
179
+ <span class="method-click-advice">click to toggle source</span>
180
+
181
+ </div>
182
+
183
+
184
+ <div class="method-description">
185
+
186
+
187
+
188
+
189
+
190
+
191
+ <div class="method-source-code" id="initialize_ionian_socket-source">
192
+ <pre><span class="ruby-comment"># File lib/ionian/extension/socket.rb, line 21</span>
193
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize_ionian_socket</span>
194
+ <span class="ruby-keyword">end</span></pre>
195
+ </div>
196
+
197
+ </div>
198
+
199
+
200
+
201
+
202
+ </div>
203
+
204
+
205
+ <div id="method-i-no_delay" class="method-detail ">
206
+
207
+ <div class="method-heading">
208
+ <span class="method-name">no_delay</span><span
209
+ class="method-args">()</span>
210
+
211
+ <span class="method-click-advice">click to toggle source</span>
212
+
213
+ </div>
214
+
215
+
216
+ <div class="method-description">
217
+
218
+ <p>Returns true if the TCP_NODELAY flag is enabled (Nagle disabled). Otherwise
219
+ false.</p>
220
+
221
+
222
+
223
+
224
+ <div class="method-source-code" id="no_delay-source">
225
+ <pre><span class="ruby-comment"># File lib/ionian/extension/socket.rb, line 26</span>
226
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">no_delay</span>
227
+ <span class="ruby-identifier">nagle_disabled</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">getsockopt</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">IPPROTO_TCP</span>, <span class="ruby-operator">::</span><span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">TCP_NODELAY</span>).<span class="ruby-identifier">data</span>.<span class="ruby-identifier">ord</span>
228
+ <span class="ruby-identifier">nagle_disabled</span> <span class="ruby-operator">&gt;</span> <span class="ruby-value">0</span> <span class="ruby-operator">?</span> <span class="ruby-keyword">true</span> <span class="ruby-operator">:</span> <span class="ruby-keyword">false</span>
229
+ <span class="ruby-keyword">end</span></pre>
230
+ </div>
231
+
232
+ </div>
233
+
234
+
235
+
236
+
237
+ </div>
238
+
239
+
240
+ <div id="method-i-no_delay-3D" class="method-detail ">
241
+
242
+ <div class="method-heading">
243
+ <span class="method-name">no_delay=</span><span
244
+ class="method-args">(value)</span>
245
+
246
+ <span class="method-click-advice">click to toggle source</span>
247
+
248
+ </div>
249
+
250
+
251
+ <div class="method-description">
252
+
253
+ <p>Setting to true enables the TCP_NODELAY flag (disables Nagle). Setting to
254
+ false disables the flag (enables Nagle).</p>
255
+
256
+
257
+
258
+
259
+ <div class="method-source-code" id="no_delay-3D-source">
260
+ <pre><span class="ruby-comment"># File lib/ionian/extension/socket.rb, line 33</span>
261
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">no_delay=</span>(<span class="ruby-identifier">value</span>)
262
+ <span class="ruby-identifier">disable_nagle</span> = <span class="ruby-identifier">value</span> <span class="ruby-operator">?</span> <span class="ruby-value">1</span> <span class="ruby-operator">:</span> <span class="ruby-value">0</span>
263
+ <span class="ruby-keyword">self</span>.<span class="ruby-identifier">setsockopt</span> <span class="ruby-operator">::</span><span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">IPPROTO_TCP</span>, <span class="ruby-operator">::</span><span class="ruby-constant">Socket</span><span class="ruby-operator">::</span><span class="ruby-constant">TCP_NODELAY</span>, <span class="ruby-identifier">disable_nagle</span>
264
+ <span class="ruby-keyword">end</span></pre>
265
+ </div>
266
+
267
+ </div>
268
+
269
+
270
+
271
+
272
+ </div>
273
+
274
+
275
+ </section>
276
+
277
+ </section>
278
+ </main>
279
+
280
+
281
+ <footer id="validator-badges" role="contentinfo">
282
+ <p><a href="http://validator.w3.org/check/referer">Validate</a>
283
+ <p>Generated by <a href="http://rdoc.rubyforge.org">RDoc</a> 4.1.0.preview.1.
284
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
285
+ </footer>
286
+
@@ -0,0 +1,99 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta charset="UTF-8">
6
+
7
+ <title>module Ionian::Extension - RDoc Documentation</title>
8
+
9
+ <link href="../fonts.css" rel="stylesheet">
10
+ <link href="../rdoc.css" rel="stylesheet">
11
+
12
+ <script type="text/javascript">
13
+ var rdoc_rel_prefix = "../";
14
+ </script>
15
+
16
+ <script src="../js/jquery.js"></script>
17
+ <script src="../js/navigation.js"></script>
18
+ <script src="../js/search_index.js"></script>
19
+ <script src="../js/search.js"></script>
20
+ <script src="../js/searcher.js"></script>
21
+ <script src="../js/darkfish.js"></script>
22
+
23
+
24
+ <body id="top" role="document" class="module">
25
+ <nav role="navigation">
26
+ <div id="project-navigation">
27
+ <div id="home-section" role="banner" class="nav-section">
28
+ <h2>
29
+ <a href="../index.html" rel="home">Home</a>
30
+ </h2>
31
+
32
+ <h3>
33
+ <a href="../table_of_contents.html#pages">Pages</a>
34
+ <a href="../table_of_contents.html#classes">Classes</a>
35
+ <a href="../table_of_contents.html#methods">Methods</a>
36
+ </h3>
37
+ </div>
38
+
39
+ <div id="search-section" role="search" class="project-section initially-hidden">
40
+ <form action="#" method="get" accept-charset="utf-8">
41
+ <div id="search-field-wrapper">
42
+ <input id="search-field" role="combobox" aria-label="Search"
43
+ aria-autocomplete="list" aria-controls="search-results"
44
+ type="text" name="search" placeholder="Search"
45
+ title="Type to search, Up and Down to navigate, Enter to load">
46
+ </div>
47
+
48
+ <ul id="search-results" aria-label="Search Results"
49
+ aria-busy="false" aria-expanded="false"
50
+ aria-atomic="false" aria-live="polite"
51
+ aria-relevant="all" class="initially-hidden"></ul>
52
+ </form>
53
+ </div>
54
+
55
+ </div>
56
+
57
+
58
+
59
+ <div id="class-metadata">
60
+
61
+
62
+
63
+
64
+
65
+ </div>
66
+ </nav>
67
+
68
+ <main role="main" aria-labelledby="module-Ionian::Extension">
69
+ <h1 id="module-Ionian::Extension" class="module">
70
+ module Ionian::Extension
71
+ </h1>
72
+
73
+ <section class="description">
74
+
75
+ </section>
76
+
77
+
78
+
79
+
80
+ <section id="5Buntitled-5D" class="documentation-section">
81
+
82
+
83
+
84
+
85
+
86
+
87
+
88
+
89
+
90
+ </section>
91
+ </main>
92
+
93
+
94
+ <footer id="validator-badges" role="contentinfo">
95
+ <p><a href="http://validator.w3.org/check/referer">Validate</a>
96
+ <p>Generated by <a href="http://rdoc.rubyforge.org">RDoc</a> 4.1.0.preview.1.
97
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
98
+ </footer>
99
+
data/doc/Ionian/IO.html CHANGED
@@ -103,7 +103,7 @@
103
103
  <p>A mixin for <a href="IO.html">IO</a> objects that allows regular expression
104
104
  matching and convenient notification of received data.</p>
105
105
 
106
- <p>This module was designed to be EXTENDED by instantiated objects that
106
+ <p>This module was designed to be extended by instantiated objects that
107
107
  implement the standard library <a href="IO.html">IO</a> class.
108
108
  my_socket.extend <a href="IO.html">Ionian::IO</a></p>
109
109
 
@@ -436,7 +436,7 @@ build_methods: Build method accessors from named captures.
436
436
  <span class="ruby-ivar">@ionian_buf</span> = <span class="ruby-node">$&#39;</span> <span class="ruby-comment"># Leave post match data in the buffer.</span>
437
437
  <span class="ruby-keyword">end</span>
438
438
 
439
- <span class="ruby-comment"># Convert match parameters to methods.</span>
439
+ <span class="ruby-comment"># Convert named captures to methods.</span>
440
440
  <span class="ruby-keyword">if</span> <span class="ruby-identifier">build_methods</span>
441
441
  <span class="ruby-ivar">@matches</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">match</span><span class="ruby-operator">|</span>
442
442
  <span class="ruby-identifier">match</span>.<span class="ruby-identifier">names</span>