diff options
Diffstat (limited to 'doc/html/tqsocket.html')
| -rw-r--r-- | doc/html/tqsocket.html | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/doc/html/tqsocket.html b/doc/html/tqsocket.html index a981d31fe..b4e8034b0 100644 --- a/doc/html/tqsocket.html +++ b/doc/html/tqsocket.html @@ -186,14 +186,14 @@ device, the current read index is always zero. <h3 class=fn>bool <a name="at-2"></a>TQSocket::at ( <a href="tqiodevice.html#Offset">Offset</a> index )<tt> [virtual]</tt> </h3> This is an overloaded member function, provided for convenience. It behaves essentially like the above function. -<p> Moves the read index forward to <em>index</em> and returns TRUE if the -operation was successful; otherwise returns FALSE. Moving the +<p> Moves the read index forward to <em>index</em> and returns true if the +operation was successful; otherwise returns false. Moving the index forward means skipping incoming data. <p>Reimplemented from <a href="tqiodevice.html#at-2">TQIODevice</a>. <h3 class=fn>bool <a name="atEnd"></a>TQSocket::atEnd () const<tt> [virtual]</tt> </h3> -Returns TRUE if there is no more data to read; otherwise returns FALSE. +Returns true if there is no more data to read; otherwise returns false. <p>Reimplemented from <a href="tqiodevice.html#atEnd">TQIODevice</a>. <h3 class=fn>TQ_ULONG <a name="bytesAvailable"></a>TQSocket::bytesAvailable () const @@ -222,10 +222,10 @@ indicates how many buffered bytes there are left to write. <h3 class=fn>bool <a name="canReadLine"></a>TQSocket::canReadLine () const </h3> -Returns TRUE if it's possible to read an entire line of text from -this socket at this time; otherwise returns FALSE. +Returns true if it's possible to read an entire line of text from +this socket at this time; otherwise returns false. <p> Note that if the peer closes the connection unexpectedly, this -function returns FALSE. This means that loops such as this won't +function returns false. This means that loops such as this won't work: <p> <pre> while( !socket->canReadLine() ) // WRONG @@ -383,7 +383,7 @@ Returns the size of the read buffer. <h3 class=fn><a href="tqstring.html">TQString</a> <a name="readLine"></a>TQSocket::readLine ()<tt> [virtual]</tt> </h3> Returns a line of text including a terminating newline character -(\n). Returns "" if <a href="#canReadLine">canReadLine</a>() returns FALSE. +(\n). Returns "" if <a href="#canReadLine">canReadLine</a>() returns false. <p> <p>See also <a href="#canReadLine">canReadLine</a>(). <p>Examples: <a href="clientserver-example.html#x802">network/clientserver/client/client.cpp</a>, <a href="httpd-example.html#x730">network/httpd/httpd.cpp</a>, <a href="mail-example.html#x713">network/mail/smtp.cpp</a>, and <a href="networkprotocol-example.html#x686">network/networkprotocol/nntp.cpp</a>. @@ -468,9 +468,9 @@ Wait up to <em>msecs</em> milliseconds for more data to be available. <p> If <em>msecs</em> is -1 the call will block indefinitely. <p> Returns the number of bytes available. <p> If <em>timeout</em> is non-null and no error occurred (i.e. it does not -return -1): this function sets <em>*timeout</em> to TRUE, if the reason +return -1): this function sets <em>*timeout</em> to true, if the reason for returning was that the timeout was reached; otherwise it sets -<em>*timeout</em> to FALSE. This is useful to find out if the peer +<em>*timeout</em> to false. This is useful to find out if the peer closed the connection. <p> <b>Warning:</b> This is a blocking call and should be avoided in event driven applications. |