document the limitations of protocol(), sockdomain(), socktype()
authorTony Cook <tony@develop-help.com>
Fri, 22 Jun 2012 10:25:06 +0000 (20:25 +1000)
committerTony Cook <tony@develop-help.com>
Mon, 2 Jul 2012 08:46:44 +0000 (18:46 +1000)
Determining these for a new_from_fd() socket has the following problems:

protocol() depends on SO_PROTOCOL, and socktype() on SO_TYPE, not
implemented on all systems.

sockdomain() depends on sockname(), which is documented as
unimplemented for AF_UNIX sockets on HP-UX.

I'm not sure that detail is useful in the documentation.

dist/IO/lib/IO/Socket.pm

index 9e6f769..b5fc448 100644 (file)
@@ -540,6 +540,12 @@ value returned.
 
 =back
 
+=head1 LIMITATIONS
+
+On some systems, for an IO::Socket object created with new_from_fd(),
+or created with accept() from such an object, the protocol(),
+sockdomain() and socktype() methods may return undef.
+
 =head1 SEE ALSO
 
 L<Socket>, L<IO::Handle>, L<IO::Socket::INET>, L<IO::Socket::UNIX>