diff options
Diffstat (limited to 'doc/html/tqsocketdevice.html')
| -rw-r--r-- | doc/html/tqsocketdevice.html | 34 |
1 files changed, 17 insertions, 17 deletions
diff --git a/doc/html/tqsocketdevice.html b/doc/html/tqsocketdevice.html index 95cc06b50..46d9f4f22 100644 --- a/doc/html/tqsocketdevice.html +++ b/doc/html/tqsocketdevice.html @@ -193,8 +193,8 @@ value is available. <h3 class=fn>bool <a name="addressReusable"></a>TQSocketDevice::addressReusable () const </h3> -Returns TRUE if the address of this socket can be used by other -sockets at the same time, and FALSE if this socket claims +Returns true if the address of this socket can be used by other +sockets at the same time, and false if this socket claims exclusive ownership. <p> <p>See also <a href="#setAddressReusable">setAddressReusable</a>(). @@ -202,17 +202,17 @@ exclusive ownership. </h3> Assigns a name to an unnamed socket. The name is the host address <em>address</em> and the port number <em>port</em>. If the operation succeeds, -<a href="#bind">bind</a>() returns TRUE; otherwise it returns FALSE without changing +<a href="#bind">bind</a>() returns true; otherwise it returns false without changing what <a href="#port">port</a>() and <a href="#address">address</a>() return. <p> bind() is used by servers for setting up incoming connections. Call bind() before <a href="#listen">listen</a>(). <h3 class=fn>bool <a name="blocking"></a>TQSocketDevice::blocking () const </h3> -Returns TRUE if the socket is valid and in blocking mode; -otherwise returns FALSE. +Returns true if the socket is valid and in blocking mode; +otherwise returns false. <p> Note that this function does not set <a href="#error">error</a>(). -<p> <b>Warning:</b> On Windows, this function always returns TRUE since the +<p> <b>Warning:</b> On Windows, this function always returns true since the ioctlsocket() function is broken. <p> <p>See also <a href="#setBlocking">setBlocking</a>() and <a href="#isValid">isValid</a>(). @@ -229,8 +229,8 @@ workarounds to deal with this problem. <h3 class=fn>bool <a name="connect"></a>TQSocketDevice::connect ( const <a href="tqhostaddress.html">TQHostAddress</a> & addr, TQ_UINT16 port )<tt> [virtual]</tt> </h3> -Connects to the IP address and port specified by <em>addr</em> and <em>port</em>. Returns TRUE if it establishes a connection; otherwise returns FALSE. -If it returns FALSE, <a href="#error">error</a>() explains why. +Connects to the IP address and port specified by <em>addr</em> and <em>port</em>. Returns true if it establishes a connection; otherwise returns false. +If it returns false, <a href="#error">error</a>() explains why. <p> Note that error() commonly returns NoError for non-blocking sockets; this just means that you can call <a href="#connect">connect</a>() again in a little while and it'll probably succeed. @@ -241,14 +241,14 @@ Returns the first error seen. <h3 class=fn>bool <a name="isValid"></a>TQSocketDevice::isValid () const </h3> -Returns TRUE if this is a valid socket; otherwise returns FALSE. +Returns true if this is a valid socket; otherwise returns false. <p> <p>See also <a href="#socket">socket</a>(). <h3 class=fn>bool <a name="listen"></a>TQSocketDevice::listen ( int backlog )<tt> [virtual]</tt> </h3> Specifies how many pending connections a server socket can have. -Returns TRUE if the operation was successful; otherwise returns -FALSE. A <em>backlog</em> value of 50 is quite common. +Returns true if the operation was successful; otherwise returns +false. A <em>backlog</em> value of 50 is quite common. <p> The <a href="#listen">listen</a>() call only applies to sockets where <a href="#type">type</a>() is <a href="#Type-enum">Stream</a>, i.e. not to <a href="#Type-enum">Datagram</a> sockets. listen() must not be called before <a href="#bind">bind</a>() or after <a href="#accept">accept</a>(). <p> <p>See also <a href="#bind">bind</a>() and <a href="#accept">accept</a>(). @@ -310,8 +310,8 @@ Returns the size of the operating system send buffer. <h3 class=fn>void <a name="setAddressReusable"></a>TQSocketDevice::setAddressReusable ( bool enable )<tt> [virtual]</tt> </h3> Sets the address of this socket to be usable by other sockets too -if <em>enable</em> is TRUE, and to be used exclusively by this socket if -<em>enable</em> is FALSE. +if <em>enable</em> is true, and to be used exclusively by this socket if +<em>enable</em> is false. <p> When a socket is reusable, other sockets can use the same port number (and IP address), which is generally useful. Of course other sockets cannot use the same @@ -321,8 +321,8 @@ there is no risk of confusing the two TCP connections. <h3 class=fn>void <a name="setBlocking"></a>TQSocketDevice::setBlocking ( bool enable )<tt> [virtual]</tt> </h3> -Makes the socket blocking if <em>enable</em> is TRUE or nonblocking if -<em>enable</em> is FALSE. +Makes the socket blocking if <em>enable</em> is true or nonblocking if +<em>enable</em> is false. <p> Sockets are blocking by default, but we recommend using nonblocking socket operations, especially for GUI programs that need to be responsive. @@ -382,9 +382,9 @@ Wait up to <em>msecs</em> milliseconds for more data to be available. If <p> Returns the number of bytes available for reading, or -1 if an error occurred. <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. |