rfc:socket_getaddrinfo

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Next revision Both sides next revision
rfc:socket_getaddrinfo [2016/08/10 01:59]
bp1222
rfc:socket_getaddrinfo [2016/09/01 00:02]
bp1222
Line 3: Line 3:
   * Date: 2016-08-08   * Date: 2016-08-08
   * Author: David Walker (dave@mudsite.com)   * Author: David Walker (dave@mudsite.com)
-  * Status: Draft+  * Status: Accepted
   * First Published at: http://wiki.php.net/rfc/socket_getaddrinfo   * First Published at: http://wiki.php.net/rfc/socket_getaddrinfo
  
 ===== Introduction ===== ===== Introduction =====
-This RFC targets a reported feature request in [[https://bugs.php.net/bug.php?id=72733|#72733]].  The request is that PHP expose the C level function getaddrinfo().  This is a missing nice piece to the current socket library.  When dealing with IP variable networks it would be beneficial to allow libc to tell us what methods of connecting/listening would be most appropriate given a set of hints.+This RFC targets a reported feature request in [[https://bugs.php.net/bug.php?id=72733|#72733]].  The request is that PHP expose the C level function getaddrinfo().  This is a missing nice piece to the current socket library.  When dealing with variable networks it would be beneficial to allow libc to tell us what methods of connecting/listening would be most appropriate given a set of hints.
  
 ===== Proposal ===== ===== Proposal =====
-The implementation[1] I'm proposing implements 4 new socket_* functions.  socket_getaddrinfo() will return an array of resources, with each resource corresponding to each returned addrinfo sockaddr.  The next two implemented methods socket_addrinfo_bind(), and socket_addrinfo_connect(), would be used to bind, or connect, to a given resource rather than make the user go through the process of creating the socket and connect/binding themselves.  The fourth function is a free'r if you'd want to free the resources before end of script.+The implementation[[https://wiki.php.net/rfc/socket_getaddrinfo#references|[1]]] I'm proposing implements 4 new functions.  ''socket_addrinfo_lookup()'' will return an array of resources, with each resource corresponding to each returned addrinfo.  The next two implemented methods ''socket_addrinfo_bind()'', and ''socket_addrinfo_connect()'', would be used to bind, or connect, to a given resource rather than make the user go through the process of creating the socket and connect/binding themselves.  The last, ``socket_addrinfo_explain`` is to convert the resource to an array for examination.
 <file php> <file php>
-array    socket_getaddrinfo(string node[, mixed service, array hints]) +socket_addrinfo_lookup(string node[, mixed service, array hints]) : array 
-resource socket_addrinfo_connect(sockaddrresource sockaddr) +socket_addrinfo_connect(resource $addrinforesource 
-resource socket_addrinfo_bind(sockaddrresource sockaddr+socket_addrinfo_bind(resource $addrinfo: resource 
-null     socket_addrinfo_close(sockaddrresource sockaddr)+socket_addrinfo_explain(resource $addrinfo: array
 </file> </file>
  
 +IPv4 Example
 <file php> <file php>
 <?php <?php
-$addrinfo = socket_getaddrinfo('127.0.0.1', 2000, array('ai_family' => AI_INET, 'ai_socktype' => SOCK_STREAM)); +$addrinfo = socket_addrinfo_lookup('localhost', 2000, array('ai_family' => AF_INET, 'ai_socktype' => SOCK_STREAM)); 
-$sockaddr = array_shift($addrinfo);+$sockaddr = reset($addrinfo);
 if (!$sockaddr) die ("No Valid Socket Types"); if (!$sockaddr) die ("No Valid Socket Types");
 $sock = socket_addrinfo_bind($sockaddr); $sock = socket_addrinfo_bind($sockaddr);
 // ^^ $sock is a socket resource that is bound to 127.0.0.1:2000 using TCP/IP ready for reading // ^^ $sock is a socket resource that is bound to 127.0.0.1:2000 using TCP/IP ready for reading
-foreach ($addrinfo as $sockaddr) { + 
-    socket_addrinfo_close($sockaddr);+var_dump(socket_addrinfo_explain($sockaddr)); 
 +/* Outputs: 
 +array(5) { 
 +  ["ai_flags"]=> 
 +  int(0) 
 +  ["ai_family"]=> 
 +  int(2) 
 +  ["ai_socktype"]=> 
 +  int(1) 
 +  ["ai_protocol"]=> 
 +  int(6) 
 +  ["ai_addr"]=> 
 +  array(2) { 
 +    ["sin_port"]=> 
 +    int(2000) 
 +    ["sin_addr"]=> 
 +    string(9) "127.0.0.1" 
 +  }
 } }
 +*/
 </file> </file>
  
 +IPv6 Example
 +<file php>
 +<?php
 +$addrinfo = socket_addrinfo_lookup('localhost', 2000, array('ai_family' => AF_INET6, 'ai_socktype' => SOCK_STREAM));
 +$sockaddr = reset($addrinfo);
 +if (!$sockaddr) die ("No Valid Socket Types");
 +$sock = socket_addrinfo_bind($sockaddr);
 +// ^^ $sock is a socket resource that is bound to [::1]:2000 using TCP/IP ready for reading
 +
 +var_dump(socket_addrinfo_explain($sockaddr));
 +/* Outputs:
 +array(5) {
 +  ["ai_flags"]=>
 +  int(0)
 +  ["ai_family"]=>
 +  int(10)
 +  ["ai_socktype"]=>
 +  int(1)
 +  ["ai_protocol"]=>
 +  int(6)
 +  ["ai_addr"]=>
 +  array(2) {
 +    ["sin6_port"]=>
 +    int(2000)
 +    ["sin6_addr"]=>
 +    string(3) "::1"
 +  }
 +}
 +*/
 +</file>
  
 ===== Backward Incompatible Changes ===== ===== Backward Incompatible Changes =====
-New functionality; no BC problems here.+New functionality; no BC issues.
  
 ===== Proposed PHP Version(s) ===== ===== Proposed PHP Version(s) =====
Line 51: Line 100:
  
 ===== Proposed Voting Choices ===== ===== Proposed Voting Choices =====
-Vote to implement the new functions, would require a 2/3 majority.+Vote to implement the new functionality, would require a 2/3 majority. 
 +<doodle title="Implement socket_getaddrinfo family" auth="bp1222" voteType="single" closed="true"> 
 +   * Yes 
 +   * No 
 +</doodle> 
 +Vote Start: 2016-08-24 15:23 UTC
  
-===== Implementation =====+Vote End:   2016-08-31 23:59 UTC
  
 ===== References ===== ===== References =====
-[1] - [[https://github.com/php/php-src/compare/master...bp1222:fix-72733|Proposed RFC Implementation]]+  * [1] - [[https://github.com/php/php-src/pull/2078|Proposed Implementation]]
rfc/socket_getaddrinfo.txt · Last modified: 2017/09/22 13:28 (external edit)