Document IO::Socket getsockopt and setsockopt
authorSlaven Rezic <srezic@iconmobile.com>
Thu, 29 Apr 2010 14:04:35 +0000 (16:04 +0200)
committerDavid Golden <dagolden@cpan.org>
Tue, 1 Jun 2010 00:18:00 +0000 (20:18 -0400)
get/setsockopt are not explicitly documented. Note that the documented
sockopt() method is a wrapper around get/setsockopt, but does not cover
all cases because of the hardcoded level (= SOL_SOCKET).

dist/IO/lib/IO/Socket.pm

index 9938c78..6d4f6ab 100644 (file)
@@ -493,6 +493,16 @@ an AF_INET socket the value of &AF_INET will be returned.
 Unified method to both set and get options in the SOL_SOCKET level. If called
 with one argument then getsockopt is called, otherwise setsockopt is called.
 
+=item getsockopt(LEVEL, OPT)
+
+Get option associated with the socket. Other levels than SOL_SOCKET
+may be specified here.
+
+=item setsockopt(LEVEL, OPT, VAL)
+
+Set option associated with the socket. Other levels than SOL_SOCKET
+may be specified here.
+
 =item socktype
 
 Returns the numerical number for the socket type. For example, for