Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

tcp: getsockname() returns its address family name #3103

Closed
wants to merge 2 commits into from

3 participants

@shigeki
Collaborator

TCP.getsockname() return an object of which property has an integer of its address family as
{ port: 12345, family: 2, address: '127.0.0.1' }
and its description in the doc was missing. This patch changes its value to a string as
{ port: 12345, family: 'AF_INET', address: '127.0.0.1' }
for easy to be recognized. And it also adds the doc.

@bnoordhuis
Owner

LGTM. Other committers, aye or nay?

@AndreasMadsen

Is the cryptic text AF_INET required, will ipv4 and ipv6 not be better?

@shigeki
Collaborator

I don't think ipv4 and ipv6 are better because this property name is family which is related to the name of the address family widely used in socket() system call. Please refer socket(2) on Linux and http://msdn.microsoft.com/en-us/library/windows/desktop/ms740506%28v=vs.85%29.aspx on Windows.
If ipv4 and ipv6 are better, its property name should not be family but IP_name or other proper name, although it would hardly be associated with the returned value of uv_tcp_getsockname().

@shigeki
Collaborator

@AndreasMadsen Correction: dns.lookup() has an argument named as family. It takes an integer of either 4 or 6. But I still think it's better to use address family name with the same reason above.

@bnoordhuis Thanks for reviewing. I've made correction on my patch for I missed to use const char* not char* on family_name and I also removed try-catch in the unit test because it catches assert(). Please review it again. Sorry for bothering you. I'm ready to submit a new PR of the same case for udp.getsockname().

@bnoordhuis
Owner

@AndreasMadsen has a point, os.networkInterfaces() returns IPv4 or IPv6. To wit:

$ out/Release/node -pe 'require("os").networkInterfaces()'
{ lo: 
   [ { address: '127.0.0.1', family: 'IPv4', internal: true },
     { address: '::1', family: 'IPv6', internal: true } ],
  wlan0: 
   [ { address: '192.168.1.6', family: 'IPv4', internal: false },
     { address: 'fe80::21e:65ff:fe5d:cfd6',
       family: 'IPv6',
       internal: false } ],
  tap0: 
   [ { address: '10.0.0.1', family: 'IPv4', internal: false },
     { address: 'fe80::f86f:3fff:fe7a:244d',
       family: 'IPv6',
       internal: false } ] }

Personally I like AF_INET and AF_INET6 better but I'm loath to change the existing interface. Let's go with IPv4 and IPv6.

@shigeki
Collaborator

What the hell! https://github.com/joyent/node/blob/master/src/node_os.cc#L218

family = String::New("IPv4");

Compatibility with other APIs is necessary. Reluctantly I made a new commit in a9d034e

@bnoordhuis
Owner

Thanks Shigeki, merged in 0d13142. Just goes to show that the life of an open source programmer is not all glamour and groupies. :-)

@bnoordhuis bnoordhuis closed this
@shigeki
Collaborator

@bnoordhuis Thanks, Ben. Don't worry, I'm still an ardent fan of Node and I'm always admiring your elaboration on the code of Node.
In the next, please review #3111 .

@shigeki
Collaborator

@bnoordhuis Thanks for your check and fix of the doc in my commit. I missed it. You are the guardian angel of Node.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
This page is out of date. Refresh to see the latest.
View
13 doc/api/net.markdown
@@ -168,9 +168,11 @@ event.
### server.address()
-Returns the bound address and port of the server as reported by the operating system.
+Returns the bound address, the address family name and port of the server
+as reported by the operating system.
Useful to find which port was assigned when giving getting an OS-assigned address.
-Returns an object with two properties, e.g. `{"address":"127.0.0.1", "port":2121}`
+Returns an object with three properties, e.g.
+`{ port: 12346, family: 'AF_INET', address: '127.0.0.1' }`
Example:
@@ -356,9 +358,10 @@ initialDelay will leave the value unchanged from the default
### socket.address()
-Returns the bound address and port of the socket as reported by the operating
-system. Returns an object with two properties, e.g.
-`{"address":"192.168.57.1", "port":62053}`
+Returns the bound address, the address family name and port of the
+socket as reported by the operating system. Returns an object with
+three properties, e.g.
+`{ port: 12346, family: 'AF_INET', address: '127.0.0.1' }`
### socket.remoteAddress
View
11 doc/api/tls.markdown
@@ -323,8 +323,8 @@ event.
### server.address()
-Returns the bound address and port of the server as reported by the operating
-system.
+Returns the bound address, the address family name and port of the
+server as reported by the operating system.
See [net.Server.address()](net.html#server.address) for more information.
### server.addContext(hostname, credentials)
@@ -414,9 +414,10 @@ information.
### cleartextStream.address()
-Returns the bound address and port of the underlying socket as reported by the
-operating system. Returns an object with two properties, e.g.
-`{"address":"192.168.57.1", "port":62053}`
+Returns the bound address, the address family name and port of the
+underlying socket as reported by the operating system. Returns an
+object with three properties, e.g.
+`{ port: 12346, family: 'AF_INET', address: '127.0.0.1' }`
### cleartextStream.remoteAddress
View
7 src/tcp_wrap.cc
@@ -170,7 +170,8 @@ Handle<Value> TCPWrap::GetSockName(const Arguments& args) {
int family;
int port;
char ip[INET6_ADDRSTRLEN];
-
+ const char *family_name;
+
UNWRAP
int addrlen = sizeof(address);
@@ -188,17 +189,19 @@ Handle<Value> TCPWrap::GetSockName(const Arguments& args) {
struct sockaddr_in* addrin = (struct sockaddr_in*)&address;
uv_inet_ntop(AF_INET, &(addrin->sin_addr), ip, INET6_ADDRSTRLEN);
port = ntohs(addrin->sin_port);
+ family_name = "IPv4";
} else if (family == AF_INET6) {
struct sockaddr_in6* addrin6 = (struct sockaddr_in6*)&address;
uv_inet_ntop(AF_INET6, &(addrin6->sin6_addr), ip, INET6_ADDRSTRLEN);
port = ntohs(addrin6->sin6_port);
+ family_name = "IPv6";
} else {
assert(0 && "bad address family");
abort();
}
sockname->Set(port_symbol, Integer::New(port));
- sockname->Set(family_symbol, Integer::New(family));
+ sockname->Set(family_symbol, String::New(family_name));
sockname->Set(address_symbol, String::New(ip));
}
View
59 test/simple/test-net-server-address.js
@@ -0,0 +1,59 @@
+// Copyright Joyent, Inc. and other Node contributors.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a
+// copy of this software and associated documentation files (the
+// "Software"), to deal in the Software without restriction, including
+// without limitation the rights to use, copy, modify, merge, publish,
+// distribute, sublicense, and/or sell copies of the Software, and to permit
+// persons to whom the Software is furnished to do so, subject to the
+// following conditions:
+//
+// The above copyright notice and this permission notice shall be included
+// in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
+// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
+// USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+var common = require('../common');
+var assert = require('assert');
+var net = require('net');
+
+// Test on IPv4 Server
+var localhost_ipv4 = '127.0.0.1';
+var family_ipv4 = 'IPv4';
+var server_ipv4 = net.createServer();
+
+server_ipv4.on('error', function(e) {
+ console.log('Error on ipv4 socket: ' + e.toString());
+});
+
+server_ipv4.listen(common.PORT, localhost_ipv4, function() {
+ var address_ipv4 = server_ipv4.address();
+ assert.strictEqual(address_ipv4.address, localhost_ipv4);
+ assert.strictEqual(address_ipv4.port, common.PORT);
+ assert.strictEqual(address_ipv4.family, family_ipv4);
+ server_ipv4.close();
+});
+
+// Test on IPv6 Server
+var localhost_ipv6 = '::1';
+var family_ipv6 = 'IPv6';
+var server_ipv6 = net.createServer();
+
+server_ipv6.on('error', function(e) {
+ console.log('Error on ipv6 socket: ' + e.toString());
+});
+
+server_ipv6.listen(common.PORT, localhost_ipv6, function() {
+ var address_ipv6 = server_ipv6.address();
+ assert.strictEqual(address_ipv6.address, localhost_ipv6);
+ assert.strictEqual(address_ipv6.port, common.PORT);
+ assert.strictEqual(address_ipv6.family, family_ipv6);
+ server_ipv6.close();
+});
+
Something went wrong with that request. Please try again.