diff options
| author | Diego Nehab <diego.nehab@gmail.com> | 2015-10-06 11:33:50 +0800 |
|---|---|---|
| committer | Diego Nehab <diego.nehab@gmail.com> | 2015-10-06 11:33:50 +0800 |
| commit | be67f63f4e11e53690bf1431a236f86b484c9bf0 (patch) | |
| tree | 2a9e3de162711f3453d238eb49155c4c488189ec /doc | |
| parent | fd729b32a8966291f007567f72f3dc0158bdab35 (diff) | |
| download | luasocket-be67f63f4e11e53690bf1431a236f86b484c9bf0.tar.gz luasocket-be67f63f4e11e53690bf1431a236f86b484c9bf0.tar.bz2 luasocket-be67f63f4e11e53690bf1431a236f86b484c9bf0.zip | |
Changed buffer-per-socket to buffer-per-operation.
This is a difficult tradeoff to measure. I think large
datagrams won't be used very frequently. So it is better to
not lock a large buffer to each socket object and instead
allocate and deallocate for each operation receiving a
datagram larger than UDP_DATAGRAMSIZE.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/reference.html | 2 | ||||
| -rw-r--r-- | doc/socket.html | 25 | ||||
| -rw-r--r-- | doc/udp.html | 33 |
3 files changed, 33 insertions, 27 deletions
diff --git a/doc/reference.html b/doc/reference.html index 6067ba6..878e7d2 100644 --- a/doc/reference.html +++ b/doc/reference.html | |||
| @@ -147,6 +147,7 @@ Support, Manual"> | |||
| 147 | <a href="socket.html#connect">connect</a>, | 147 | <a href="socket.html#connect">connect</a>, |
| 148 | <a href="socket.html#connect">connect4</a>, | 148 | <a href="socket.html#connect">connect4</a>, |
| 149 | <a href="socket.html#connect">connect6</a>, | 149 | <a href="socket.html#connect">connect6</a>, |
| 150 | <a href="socket.html#datagramsize">_DATAGRAMSIZE</a>, | ||
| 150 | <a href="socket.html#debug">_DEBUG</a>, | 151 | <a href="socket.html#debug">_DEBUG</a>, |
| 151 | <a href="dns.html#dns">dns</a>, | 152 | <a href="dns.html#dns">dns</a>, |
| 152 | <a href="socket.html#gettime">gettime</a>, | 153 | <a href="socket.html#gettime">gettime</a>, |
| @@ -158,6 +159,7 @@ Support, Manual"> | |||
| 158 | <a href="socket.html#skip">skip</a>, | 159 | <a href="socket.html#skip">skip</a>, |
| 159 | <a href="socket.html#sleep">sleep</a>, | 160 | <a href="socket.html#sleep">sleep</a>, |
| 160 | <a href="socket.html#setsize">_SETSIZE</a>, | 161 | <a href="socket.html#setsize">_SETSIZE</a>, |
| 162 | <a href="socket.html#socketinvalid">_SOCKETINVALID</a>, | ||
| 161 | <a href="socket.html#source">source</a>, | 163 | <a href="socket.html#source">source</a>, |
| 162 | <a href="tcp.html#socket.tcp">tcp</a>, | 164 | <a href="tcp.html#socket.tcp">tcp</a>, |
| 163 | <a href="tcp.html#socket.tcp4">tcp4</a>, | 165 | <a href="tcp.html#socket.tcp4">tcp4</a>, |
diff --git a/doc/socket.html b/doc/socket.html index e6a9bf8..8a81414 100644 --- a/doc/socket.html +++ b/doc/socket.html | |||
| @@ -90,7 +90,7 @@ of connect are defined as simple helper functions that restrict the | |||
| 90 | 90 | ||
| 91 | <!-- debug ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | 91 | <!-- debug ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> |
| 92 | 92 | ||
| 93 | <p class=name id=debug> | 93 | <p class=name id=debug> |
| 94 | socket.<b>_DEBUG</b> | 94 | socket.<b>_DEBUG</b> |
| 95 | </p> | 95 | </p> |
| 96 | 96 | ||
| @@ -99,6 +99,19 @@ This constant is set to <tt><b>true</b></tt> if the library was compiled | |||
| 99 | with debug support. | 99 | with debug support. |
| 100 | </p> | 100 | </p> |
| 101 | 101 | ||
| 102 | <!-- datagramsize +++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | ||
| 103 | |||
| 104 | <p class=name id=debug> | ||
| 105 | socket.<b>_DATAGRAMSIZE</b> | ||
| 106 | </p> | ||
| 107 | |||
| 108 | <p class=description> | ||
| 109 | Default datagram size used by calls to | ||
| 110 | <a href="udp.html#receive"<tt>receive</tt></a> and | ||
| 111 | <a href="udp.html#receivefrom"><tt>receivefrom</tt></a>. | ||
| 112 | (Unless changed in compile time, the value is 8192.) | ||
| 113 | </p> | ||
| 114 | |||
| 102 | <!-- get time +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | 115 | <!-- get time +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> |
| 103 | 116 | ||
| 104 | <p class=name id=gettime> | 117 | <p class=name id=gettime> |
| @@ -393,6 +406,16 @@ The maximum number of sockets that the <a | |||
| 393 | href=#select><tt>select</tt></a> function can handle. | 406 | href=#select><tt>select</tt></a> function can handle. |
| 394 | </p> | 407 | </p> |
| 395 | 408 | ||
| 409 | <!-- socketinvalid ++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | ||
| 410 | |||
| 411 | <p class=name id=socketinvalid> | ||
| 412 | socket.<b>_SOCKETINVALID</b> | ||
| 413 | </p> | ||
| 414 | |||
| 415 | <p class=description> | ||
| 416 | The OS value for an invalid socket. | ||
| 417 | </p> | ||
| 418 | |||
| 396 | <!-- try ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | 419 | <!-- try ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> |
| 397 | 420 | ||
| 398 | <p class=name id=try> | 421 | <p class=name id=try> |
diff --git a/doc/udp.html b/doc/udp.html index 22d7c72..9437c51 100644 --- a/doc/udp.html +++ b/doc/udp.html | |||
| @@ -42,7 +42,7 @@ | |||
| 42 | <!-- socket.udp ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | 42 | <!-- socket.udp ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> |
| 43 | 43 | ||
| 44 | <p class="name" id="socket.udp"> | 44 | <p class="name" id="socket.udp"> |
| 45 | socket.<b>udp(</b>[buffersize]<b>)</b> | 45 | socket.<b>udp()</b> |
| 46 | </p> | 46 | </p> |
| 47 | 47 | ||
| 48 | <p class="description"> | 48 | <p class="description"> |
| @@ -62,13 +62,6 @@ The <a href="#setpeername"><tt>setpeername</tt></a> | |||
| 62 | is used to connect the object. | 62 | is used to connect the object. |
| 63 | </p> | 63 | </p> |
| 64 | 64 | ||
| 65 | <p class="parameters"> | ||
| 66 | The optional <tt>buffersize</tt> parameter | ||
| 67 | specifies the size of the largest datagram that will | ||
| 68 | ever be received by the UDP object. The default value is | ||
| 69 | 8192. | ||
| 70 | </p> | ||
| 71 | |||
| 72 | <p class="return"> | 65 | <p class="return"> |
| 73 | In case of success, a new unconnected UDP object | 66 | In case of success, a new unconnected UDP object |
| 74 | returned. In case of error, <b><tt>nil</tt></b> is returned, followed by | 67 | returned. In case of error, <b><tt>nil</tt></b> is returned, followed by |
| @@ -92,7 +85,7 @@ href=#setoption><tt>setoption</tt></a> will fail. | |||
| 92 | <!-- socket.udp4 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | 85 | <!-- socket.udp4 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> |
| 93 | 86 | ||
| 94 | <p class="name" id="socket.udp"> | 87 | <p class="name" id="socket.udp"> |
| 95 | socket.<b>udp4(</b>[buffersize]<b>)</b> | 88 | socket.<b>udp4()</b> |
| 96 | </p> | 89 | </p> |
| 97 | 90 | ||
| 98 | <p class="description"> | 91 | <p class="description"> |
| @@ -112,13 +105,6 @@ The <a href="#setpeername"><tt>setpeername</tt></a> | |||
| 112 | is used to connect the object. | 105 | is used to connect the object. |
| 113 | </p> | 106 | </p> |
| 114 | 107 | ||
| 115 | <p class="parameters"> | ||
| 116 | The optional <tt>buffersize</tt> parameter | ||
| 117 | specifies the size of the largest datagram that will | ||
| 118 | ever be received by the UDP object. The default value is | ||
| 119 | 8192. | ||
| 120 | </p> | ||
| 121 | |||
| 122 | <p class="return"> | 108 | <p class="return"> |
| 123 | In case of success, a new unconnected UDP object | 109 | In case of success, a new unconnected UDP object |
| 124 | returned. In case of error, <b><tt>nil</tt></b> is returned, followed by | 110 | returned. In case of error, <b><tt>nil</tt></b> is returned, followed by |
| @@ -128,7 +114,7 @@ an error message. | |||
| 128 | <!-- socket.udp ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | 114 | <!-- socket.udp ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> |
| 129 | 115 | ||
| 130 | <p class="name" id="socket.udp6"> | 116 | <p class="name" id="socket.udp6"> |
| 131 | socket.<b>udp6(</b>[buffersize]<b>)</b> | 117 | socket.<b>udp6()</b> |
| 132 | </p> | 118 | </p> |
| 133 | 119 | ||
| 134 | <p class="description"> | 120 | <p class="description"> |
| @@ -148,13 +134,6 @@ The <a href="#setpeername"><tt>setpeername</tt></a> | |||
| 148 | is used to connect the object. | 134 | is used to connect the object. |
| 149 | </p> | 135 | </p> |
| 150 | 136 | ||
| 151 | <p class="parameters"> | ||
| 152 | The optional <tt>buffersize</tt> parameter | ||
| 153 | specifies the size of the largest datagram that will | ||
| 154 | ever be received by the UDP object. The default value is | ||
| 155 | 8192. | ||
| 156 | </p> | ||
| 157 | |||
| 158 | <p class="return"> | 137 | <p class="return"> |
| 159 | In case of success, a new unconnected UDP object | 138 | In case of success, a new unconnected UDP object |
| 160 | returned. In case of error, <b><tt>nil</tt></b> is returned, followed by | 139 | returned. In case of error, <b><tt>nil</tt></b> is returned, followed by |
| @@ -261,8 +240,10 @@ the excess bytes are discarded. If there are less then | |||
| 261 | <tt>size</tt> bytes available in the current datagram, the | 240 | <tt>size</tt> bytes available in the current datagram, the |
| 262 | available bytes are returned. | 241 | available bytes are returned. |
| 263 | If <tt>size</tt> is omitted, the | 242 | If <tt>size</tt> is omitted, the |
| 264 | <tt>buffersize</tt> argument at creation time is used | 243 | compile-time constant <a |
| 265 | (which defaults to 8192 bytes). | 244 | href=socket.html#datagramsize><tt>socket._DATAGRAMSIZE</tt></a> is used |
| 245 | (it defaults to 8192 bytes). Larger sizes will cause a | ||
| 246 | temporary buffer to be allocated for the operation. | ||
| 266 | </p> | 247 | </p> |
| 267 | 248 | ||
| 268 | <p class="return"> | 249 | <p class="return"> |
