This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Improve the setsockopt description.
authorGisle Aas <gisle@activestate.com>
Thu, 8 Dec 2005 09:53:35 +0000 (09:53 +0000)
committerGisle Aas <gisle@activestate.com>
Thu, 8 Dec 2005 09:53:35 +0000 (09:53 +0000)
Removed claim that OPTVAL might be undef as it is just treated
the same as 0 and give the usual use-of-uninitialized-value
warning.  Added an example.

p4raw-id: //depot/perl@26299

pod/perlfunc.pod

index 0127c82..2cb16d0 100644 (file)
@@ -4926,8 +4926,15 @@ that doesn't implement setpriority(2).
 X<setsockopt>
 
 Sets the socket option requested.  Returns undefined if there is an
-error.  OPTVAL may be specified as C<undef> if you don't want to pass an
-argument.
+error.  Use integer constants provided by the C<Socket> module for
+LEVEL and OPNAME.  Values for LEVEL can also be obtained from
+getprotobyname.  OPTVAL might either be a packed string or an integer.
+An integer OPTVAL is shorthand for pack("i", OPTVAL).
+
+An example disabling the Nagle's algorithm for a socket:
+
+    use Socket qw(IPPROTO_TCP TCP_NODELAY);
+    setsockopt($socket, IPPROTO_TCP, TCP_NODELAY, 1);
 
 =item shift ARRAY
 X<shift>