mingw/html/lib/IO/Socket/UNIX.html

   1 <?xml version="1.0" ?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4 <head>
   5 <title>IO::Socket::UNIX - Object interface for AF_UNIX domain sockets</title>
   6 <meta http-equiv="content-type" content="text/html; charset=utf-8" />
   7 <link rev="made" href="mailto:" />
   8 </head>
   9
  10 <body style="background-color: white">
  11 <table border="0" width="100%" cellspacing="0" cellpadding="3">
  12 <tr><td class="block" style="background-color: #cccccc" valign="middle">
  13 <big><strong><span class="block">&nbsp;IO::Socket::UNIX - Object interface for AF_UNIX domain sockets</span></strong></big>
  14 </td></tr>
  15 </table>
  16
  17 <p><a name="__index__"></a></p>
  18 <!-- INDEX BEGIN -->
  19
  20 <ul>
  21
  22         <li><a href="#name">NAME</a></li>
  23         <li><a href="#synopsis">SYNOPSIS</a></li>
  24         <li><a href="#description">DESCRIPTION</a></li>
  25         <li><a href="#constructor">CONSTRUCTOR</a></li>
  26         <li><a href="#methods">METHODS</a></li>
  27         <li><a href="#see_also">SEE ALSO</a></li>
  28         <li><a href="#author">AUTHOR</a></li>
  29         <li><a href="#copyright">COPYRIGHT</a></li>
  30 </ul>
  31 <!-- INDEX END -->
  32
  33 <hr />
  34 <p>
  35 </p>
  36 <h1><a name="name">NAME</a></h1>
  37 <p>IO::Socket::UNIX - Object interface for AF_UNIX domain sockets</p>
  38 <p>
  39 </p>
  40 <hr />
  41 <h1><a name="synopsis">SYNOPSIS</a></h1>
  42 <pre>
  43     use IO::Socket::UNIX;</pre>
  44 <p>
  45 </p>
  46 <hr />
  47 <h1><a name="description">DESCRIPTION</a></h1>
  48 <p><code>IO::Socket::UNIX</code> provides an object interface to creating and using sockets
  49 in the AF_UNIX domain. It is built upon the <a href="file://C|\msysgit\mingw\html/lib/IO/Socket.html">the IO::Socket manpage</a> interface and
  50 inherits all the methods defined by <a href="file://C|\msysgit\mingw\html/lib/IO/Socket.html">the IO::Socket manpage</a>.</p>
  51 <p>
  52 </p>
  53 <hr />
  54 <h1><a name="constructor">CONSTRUCTOR</a></h1>
  55 <dl>
  56 <dt><strong><a name="item_new">new ( [ARGS] )</a></strong>
  57
  58 <dd>
  59 <p>Creates an <code>IO::Socket::UNIX</code> object, which is a reference to a
  60 newly created symbol (see the <code>Symbol</code> package). <a href="#item_new"><code>new</code></a>
  61 optionally takes arguments, these arguments are in key-value pairs.</p>
  62 </dd>
  63 <dd>
  64 <p>In addition to the key-value pairs accepted by <a href="file://C|\msysgit\mingw\html/lib/IO/Socket.html">the IO::Socket manpage</a>,
  65 <code>IO::Socket::UNIX</code> provides.</p>
  66 </dd>
  67 <dd>
  68 <pre>
  69     Type        Type of socket (eg SOCK_STREAM or SOCK_DGRAM)
  70     Local       Path to local fifo
  71     Peer        Path to peer fifo
  72     Listen      Create a listen socket</pre>
  73 </dd>
  74 <dd>
  75 <p>If the constructor is only passed a single argument, it is assumed to
  76 be a <code>Peer</code> specification.</p>
  77 </dd>
  78 <dd>
  79 <pre>
  80  NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE</pre>
  81 </dd>
  82 <dd>
  83 <p>As of VERSION 1.18 all IO::Socket objects have autoflush turned on
  84 by default. This was not the case with earlier releases.</p>
  85 </dd>
  86 <dd>
  87 <pre>
  88  NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE</pre>
  89 </dd>
  90 </li>
  91 </dl>
  92 <p>
  93 </p>
  94 <hr />
  95 <h1><a name="methods">METHODS</a></h1>
  96 <dl>
  97 <dt><strong><a name="item_hostpath"><code>hostpath()</code></a></strong>
  98
  99 <dd>
 100 <p>Returns the pathname to the fifo at the local end</p>
 101 </dd>
 102 </li>
 103 <dt><strong><a name="item_peerpath"><code>peerpath()</code></a></strong>
 104
 105 <dd>
 106 <p>Returns the pathanme to the fifo at the peer end</p>
 107 </dd>
 108 </li>
 109 </dl>
 110 <p>
 111 </p>
 112 <hr />
 113 <h1><a name="see_also">SEE ALSO</a></h1>
 114 <p><a href="file://C|\msysgit\mingw\html/lib/Socket.html">the Socket manpage</a>, <a href="file://C|\msysgit\mingw\html/lib/IO/Socket.html">the IO::Socket manpage</a></p>
 115 <p>
 116 </p>
 117 <hr />
 118 <h1><a name="author">AUTHOR</a></h1>
 119 <p>Graham Barr. Currently maintained by the Perl Porters.  Please report all
 120 bugs to &lt;<a href="mailto:perl5-porters@perl.org">perl5-porters@perl.org</a>&gt;.</p>
 121 <p>
 122 </p>
 123 <hr />
 124 <h1><a name="copyright">COPYRIGHT</a></h1>
 125 <p>Copyright (c) 1996-8 Graham Barr &lt;<a href="mailto:gbarr@pobox.com">gbarr@pobox.com</a>&gt;. All rights reserved.
 126 This program is free software; you can redistribute it and/or
 127 modify it under the same terms as Perl itself.</p>
 128 <table border="0" width="100%" cellspacing="0" cellpadding="3">
 129 <tr><td class="block" style="background-color: #cccccc" valign="middle">
 130 <big><strong><span class="block">&nbsp;IO::Socket::UNIX - Object interface for AF_UNIX domain sockets</span></strong></big>
 131 </td></tr>
 132 </table>
 133
 134 </body>
 135
 136 </html>