aboutsummaryrefslogtreecommitdiff
path: root/doc/tcp.html
diff options
context:
space:
mode:
authorSam Roberts <vieuxtech@gmail.com>2011-10-24 11:24:58 -0700
committerSam Roberts <vieuxtech@gmail.com>2012-04-11 13:45:59 -0700
commit12bde801f6a5d3a192dee29dda1266108aa98d45 (patch)
tree64c6166ae6d968f10d260ec5172de0ac1d4e576a /doc/tcp.html
parent3a0fd4744daa972e59579a753af2da9dbde36edd (diff)
downloadluasocket-12bde801f6a5d3a192dee29dda1266108aa98d45.tar.gz
luasocket-12bde801f6a5d3a192dee29dda1266108aa98d45.tar.bz2
luasocket-12bde801f6a5d3a192dee29dda1266108aa98d45.zip
Document dirty, getfd, and setfd for select and tcp.
Diffstat (limited to 'doc/tcp.html')
-rw-r--r--doc/tcp.html60
1 files changed, 60 insertions, 0 deletions
diff --git a/doc/tcp.html b/doc/tcp.html
index 602c73c..ab70f04 100644
--- a/doc/tcp.html
+++ b/doc/tcp.html
@@ -507,6 +507,66 @@ This is the default mode;
507This function returns 1. 507This function returns 1.
508</p> 508</p>
509 509
510<!-- dirty +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
511
512<p class=name id=dirty>
513master:<b>dirty()</b><br>
514client:<b>dirty()</b><br>
515server:<b>dirty()</b>
516</p>
517
518<p class=description>
519Check the read buffer status.
520</p>
521
522<p class=return>
523Returns <tt>true</tt> if there is any data in the read buffer, <tt>false</tt> otherwise.
524</p>
525
526<p class=note>
527Note: <b>This is an internal method, any use is unlikely to be portable.</b>
528</p>
529
530<!-- getfd +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
531
532<p class=name id=getfd>
533master:<b>getfd()</b><br>
534client:<b>getfd()</b><br>
535server:<b>getfd()</b>
536</p>
537
538<p class=description>
539Returns the underling socket descriptor or handle associated to the object.
540</p>
541
542<p class=return>
543The descriptor or handle. In case the object has been closed, the return will be -1.
544</p>
545
546<p class=note>
547Note: <b>This is an internal method, any use is unlikely to be portable.</b>
548</p>
549
550<!-- setfd +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
551
552<p class=name id=setfd>
553master:<b>setfd(</b>fd<b>)</b><br>
554client:<b>setfd(</b>fd<b>)</b><br>
555server:<b>setfd(</b>fd<b>)</b>
556</p>
557
558<p class=description>
559Sets the underling socket descriptor or handle associated to the object. The current one is simply replaced, not closed, and no other change to the object state is made.
560</p>
561
562<p class=return>
563No return value.
564</p>
565
566<p class=note>
567Note: <b>This is an internal method, any use is unlikely to be portable.</b>
568</p>
569
510<!-- footer +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> 570<!-- footer +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
511 571
512<div class=footer> 572<div class=footer>