From 10b667cf326cd54fd97378bf08b819b3930f08d3 Mon Sep 17 00:00:00 2001 From: Aidan Lister Date: Thu, 24 Feb 2005 07:09:27 +0000 Subject: [PATCH] Updated to new docskel. Added example. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@180649 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/sockets/functions/socket-bind.xml | 193 ++++++++++++++------ 1 file changed, 139 insertions(+), 54 deletions(-) diff --git a/reference/sockets/functions/socket-bind.xml b/reference/sockets/functions/socket-bind.xml index 9372f0782f..69a64c3a6b 100644 --- a/reference/sockets/functions/socket-bind.xml +++ b/reference/sockets/functions/socket-bind.xml @@ -1,57 +1,142 @@ - - - - - socket_bind - Binds a name to a socket - - - Description - - boolsocket_bind - resourcesocket - stringaddress - intport - - - socket_bind binds the name given in - address to the socket described by - socket, which must be a valid socket - resource created with socket_create. - - - The address parameter is either an IP - address in dotted-quad notation - (e.g. 127.0.0.1), if the socket is of the - AF_INET family; or the pathname of a - Unix-domain socket, if the socket family is - AF_UNIX. - - - The port parameter is only used when - connecting to an AF_INET socket, and - designates the port on the remote host to which a connection - should be made. - - - &return.success; The error code can be retrieved with - socket_last_error. This code may be passed to - socket_strerror to get a textual explanation of the - error. Note that socket_last_error is reported to - return an invalid error code in case you are trying to bind the socket - to a wrong address that does not belong to your Windows 9x/ME machine. - - - See also - socket_connect, - socket_listen, - socket_create, - socket_last_error and - socket_strerror. - - - + + + + socket_bind + Binds a name to a socket + + + + &reftitle.description; + + boolsocket_bind + resourcesocket + stringaddress + intport + + + Binds the name given in address to the socket + described by socket. + + + + + &reftitle.parameters; + + + + socket + + + A valid socket resource created with socket_create. + + + + + address + + + If the socket is of the AF_INET family, the + address is an IP in dotted-quad notation + (e.g. 127.0.0.1). + + + If the socket is of the AF_UNIX family, the + address is the pathname of a + Unix-domain socket (e.g. /tmp/my.sock). + + + + + port (Optional) + + + The port parameter is only used when + connecting to an AF_INET socket, and + designates the port on the remote host to which a connection + should be made. + + + + + + + + + &reftitle.returnvalues; + &return.success; + + The error code can be retrieved with socket_last_error. + This code may be passed to socket_strerror to get a + textual explanation of the error. + + + + Windows 9x/ME compatability note: + socket_last_error may return an invalid error code + if trying to bind the socket to a wrong address that does not belong to + your machine. + + + + + + &reftitle.examples; + + + Using <function>socket_bind</function> to set the source address + + +]]> + + + + + + + &reftitle.notes; + + + This function must be used on the socket before + socket_connect. + + + + + + &reftitle.seealso; + + + socket_connect + socket_listen + socket_create + socket_last_error + socket_strerror + + + + +--> \ No newline at end of file