man-pages/man3/X11::Protocol::Connection.3pm.html
2021-03-31 01:06:50 +01:00

172 lines
3.3 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of Protocol::Connection</TITLE>
</HEAD><BODY>
<H1>Protocol::Connection</H1>
Section: User Contributed Perl Documentation (3pm)<BR>Updated: 2003-01-27<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
X11::Protocol::Connection - Perl module abstract base class for X11 client to server connections
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<PRE>
# In connection object module
package X11::Protocol::Connection::CarrierPigeon;
use X11::Protocol::Connection;
@ISA = ('X11::Protocol::Connection');
sub open { ... }
sub give { ... }
sub get { ... }
sub fh { ... }
...
# In program
$connection = X11::Protocol::Connection::CarrierPigeon
-&gt;open($host, $display_number);
$x = X11::Protocol-&gt;new($connection);
$connection-&gt;give($data);
$reply = unpack(&quot;I&quot;, $connection-&gt;<A HREF="/cgi-bin/man/man2html?4+get">get</A>(4));
use IO::Select;
$sel = IO::select-&gt;new($connection-&gt;fh);
if ($sel-&gt;can_read == $connection-&gt;fh) ...
</PRE>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
This module is an abstract base class for the various
X11::Protocol::Connection::* modules that provide connections to X
servers for the X11::Protocol module. It provides stubs for the
following methods:
<A NAME="lbAE">&nbsp;</A>
<H3>open</H3>
<PRE>
$conn = X11::Protocol::Connection::Foo-&gt;open($host, $display_num)
</PRE>
<P>
Open a connection to the specified display (numbered from 0) on the
specified <TT>$host</TT>.
<A NAME="lbAF">&nbsp;</A>
<H3>give</H3>
<PRE>
$conn-&gt;give($data)
</PRE>
<P>
Send the given data to the server. Normally, this method is used only
by the protocol module itself.
<A NAME="lbAG">&nbsp;</A>
<H3>get</H3>
<PRE>
$data = $conn-&gt;get($n)
</PRE>
<P>
Read <TT>$n</TT> bytes of data from the server. Normally, this method is used
only by the protocol module itself.
<A NAME="lbAH">&nbsp;</A>
<H3>fh</H3>
<PRE>
$filehandle = $conn-&gt;fh
</PRE>
<P>
Return an object suitable for use as a filehandle. This is mainly
useful for doing <I>select()</I> and other such system calls.
<A NAME="lbAI">&nbsp;</A>
<H2>AUTHOR</H2>
Stephen McCamant &lt;<A HREF="mailto:SMCCAM@cpan.org">SMCCAM@cpan.org</A>&gt;.
<A NAME="lbAJ">&nbsp;</A>
<H2>SEE ALSO</H2>
<I><A HREF="/cgi-bin/man/man2html?1+perl">perl</A></I>(1),
X11::Protocol,
X11::Protocol::Connection::Socket,
X11::Protocol::Connection::FileHandle,
X11::Protocol::Connection::INETSocket,
X11::Protocol::Connection::UNIXSocket,
X11::Protocol::Connection::INETFH,
X11::Protocol::Connection::UNIXFH.
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="1"><A HREF="#lbAB">NAME</A><DD>
<DT id="2"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="3"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DL>
<DT id="4"><A HREF="#lbAE">open</A><DD>
<DT id="5"><A HREF="#lbAF">give</A><DD>
<DT id="6"><A HREF="#lbAG">get</A><DD>
<DT id="7"><A HREF="#lbAH">fh</A><DD>
</DL>
<DT id="8"><A HREF="#lbAI">AUTHOR</A><DD>
<DT id="9"><A HREF="#lbAJ">SEE ALSO</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:06:00 GMT, March 31, 2021
</BODY>
</HTML>