forked from lunarmodules/copas
/
index.html
213 lines (172 loc) · 6.5 KB
/
index.html
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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Copas - Coroutine Oriented Portable Asynchronous Services for Lua</title>
<link rel="stylesheet" href="http://www.keplerproject.org/doc.css" type="text/css"/>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
</head>
<body>
<div id="container">
<div id="product">
<div id="product_logo"><a href="http://www.keplerproject.org">
<img alt="Copas logo" src="copas.png"/>
</a></div>
<div id="product_name"><big><strong>Copas</strong></big></div>
<div id="product_description">Coroutine Oriented Portable Asynchronous Services for Lua</div>
</div> <!-- id="product" -->
<div id="main">
<div id="navigation">
<h1>Copas</h1>
<ul>
<li><strong>Home</strong>
<ul>
<li><a href="index.html#over">Overview</a></li>
<li><a href="index.html#status">Status</a></li>
<li><a href="index.html#download">Download</a></li>
<li><a href="index.html#dependencies">Dependencies</a></li>
<li><a href="index.html#history">History</a></li>
<li><a href="index.html#credits">Credits</a></li>
<li><a href="index.html#contact">Contact us</a></li>
</ul>
</li>
<li><a href="manual.html">Manual</a>
<ul>
<li><a href="manual.html#install">Installing</a></li>
<li><a href="manual.html#introduction">Introduction</a></li>
<li><a href="manual.html#why">Why use Copas?</a></li>
<li><a href="manual.html#using">Using Copas</a></li>
<li><a href="manual.html#udp">UDP support</a></li>
<li><a href="manual.html#tasks">Adding tasks</a></li>
<li><a href="manual.html#timers">Creating timers</a></li>
<li><a href="manual.html#control">Controlling Copas</a></li>
</ul>
</li>
<li><a href="reference.html">Reference</a></li>
<li><a href="http://github.com/keplerproject/copas/">Project</a>
<ul>
<li><a href="http://github.com/keplerproject/copas/issues">Bug Tracker</a></li>
</ul>
</li>
<li><a href="license.html">License</a></li>
</ul>
</div> <!-- id="navigation" -->
<div id="content">
<h2><a name="over"></a>Overview</h2>
<p>
Copas is a dispatcher based on coroutines that can be used by
TCP/IP servers. It uses
<a href="http://www.cs.princeton.edu/~diego/professional/luasocket/">LuaSocket</a>
as the interface with the TCP/IP stack.
</p>
<p>
A server registered with Copas should provide a handler for requests and use
Copas socket functions to send the response. Copas loops through requests and
invokes the corresponding handlers. For a full implementation of a Copas HTTP
server you can refer to <a href="http://www.keplerproject.org/xavante">Xavante</a>
as an example.
</p>
<p>Copas is free software and uses the same <a href="license.html">license</a>
as Lua 5.1 and 5.2</p>
<h2><a name="status"></a>Status</h2>
<p>Current version is 1.2.1 and was developed for Lua 5.1 and 5.2.</p>
<h2><a name="download"></a>Download</h2>
<p>
Copas can be downloaded from its
<a href="http://github.com/keplerproject/copas">Github</a> page, in
the "Downloads" tab.
</p>
<p>You can also install Copas using <a href="http://www.luarocks.org">LuaRocks</a>:</p>
<pre class="example">
luarocks install copas
</pre>
<h2><a name="dependencies"></a>Dependencies</h2>
<p>Copas depends on
LuaSocket and <a href="http://keplerproject.github.io/coxpcall/">Coxpcall</a>.
</p>
<h2><a name="history"></a>History</h2>
<dl class="history">
<dt><strong>Copas 1.2.1</strong> [2013]</dt>
<dd><ul>
<li>Fixed bad version constant</li>
<li>Fixed timer issue</li>
<li>updated documentation</li>
</ul></dd>
<dt><strong>Copas 1.2.0</strong> [2013]</dt>
<dd><ul>
<li>Support for Lua 5.2</li>
<li>UDP support</li>
<li>suspending threads</li>
<li>other minor updates</li>
</ul></dd>
<dt><strong>Copas 1.1.6</strong> [18/Mar/2010]</dt>
<dd><ul>
<li>Now checks to see if socket.http was required before copas
</li>
</ul></dd>
<dt><strong>Copas 1.1.5</strong> [07/Apr/2009]</dt>
<dd><ul>
<li>Fixed bug reported by Sam Roberts on the
Kepler list
(found due to Xavante locking up on some POST requests)
</li>
</ul></dd>
<dt><strong>Copas 1.1.4</strong> [10/Dec/2008]</dt>
<dd><ul>
<li>Fixed bug [#5372]
- copas.connect is semi-broken (found by Gary NG)</li>
</ul></dd>
<dt><strong>Copas 1.1.3</strong> [19/May/2008]</dt>
<dd><ul>
<li>Using <code>copcall</code> instead of <code>pcall</code> in <code>socket.protect</code>
(feature request [#5274] by Gary NG)</li>
</ul></dd>
<dt><strong>Copas 1.1.2</strong> [15/May/2008]</dt>
<dd><ul>
<li>Fixed Bug [#4249]
- bugs in copas.receive (found by Gary NG)</li>
</ul></dd>
<dt><strong>Copas 1.1.1</strong> [13/Aug/2007]</dt>
<dd>
<ul>
<li>Compatible with Lua 5.1</li>
<li>Refactored by Thomas Harning Jr. (for more details check
Bug 766)</li>
<li>Patch by Gary NG concerning the handling of stopped sockets</li>
</ul>
</dd>
<dt><strong>Copas 1.1</strong> [20/Sep/2006]</dt>
<dd><ul>
<li><a href="reference.html">copas.addthread()</a> added</li>
</ul></dd>
<dt><strong><a href="http://www.keplerproject.org/copas/1.0">Copas 1.0</a></strong> [17/May/2005]</dt>
<dd><ul>
<li><a href="reference.html">copas.step()</a> added</li>
</ul></dd>
<dt><strong>Copas 1.0 Beta</strong>[17/Feb/2005]</dt>
<dd><ul>
<li>First public version</li>
</ul></dd>
</dl>
<h2><a name="credits"></a>Credits</h2>
<p>Copas was designed and implemented by André Carregal and
Javier Guerra as part of the
<a href="http://www.keplerproject.org">Kepler Project</a> which
holds its copyright. Copas development had significative contributions from Diego Nehab,
Mike Pall, David Burgess, Leonardo Godinho, Thomas Harning Jr. and Gary NG.</p>
<h2><a name="contact"></a>Contact us</h2>
<p>For more information please
<a href="mailto:info-NO-SPAM-THANKS@keplerproject.org">contact us</a>.
Comments are welcome!</p>
<p>
You can also reach other Kepler developers and users on the Kepler Project
<a href="https://groups.google.com/forum/#!forum/kepler-project">mailing list</a>.
</p>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<p><a href="http://validator.w3.org/check?uri=referer">Valid XHTML 1.0!</a></p>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>