man pages section 3: Library Interfaces and Headers

X11::Protocol::Connection (3)

Name

X11::Protocol::Connection - Perl module abstract base class for X11 client to server connections

Synopsis

# 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
->open($host, $display_number);
$x = X11::Protocol->new($connection);

$connection->give($data);

$reply = unpack("I", $connection->get(4));

use IO::Select;
$sel = IO::select->new($connection->fh);
if ($sel->can_read == $connection->fh) ...

Description

User Contributed Perl Documentation                    Protocol::Connection(3)



NAME
       X11::Protocol::Connection - Perl module abstract base class for X11
       client to server connections

SYNOPSIS
         # 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
           ->open($host, $display_number);
         $x = X11::Protocol->new($connection);

         $connection->give($data);

         $reply = unpack("I", $connection->get(4));

         use IO::Select;
         $sel = IO::select->new($connection->fh);
         if ($sel->can_read == $connection->fh) ...

DESCRIPTION
       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:

   open
         $conn = X11::Protocol::Connection::Foo->open($host, $display_num)

       Open a connection to the specified display (numbered from 0) on the
       specified $host.

   give
         $conn->give($data)

       Send the given data to the server. Normally, this method is used only
       by the protocol module itself.

   get
         $data = $conn->get($n)

       Read $n bytes of data from the server. Normally, this method is used
       only by the protocol module itself.

   fh
         $filehandle = $conn->fh

       Return an object suitable for use as a filehandle. This is mainly
       useful for doing select() and other such system calls.

AUTHOR
       Stephen McCamant <SMCCAM@cpan.org>.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+--------------------------------------+
       |ATTRIBUTE TYPE |           ATTRIBUTE VALUE            |
       +---------------+--------------------------------------+
       |Availability   | library/perl-5/perl-x11-protocol-532 |
       +---------------+--------------------------------------+
       |Stability      | Uncommitted                          |
       +---------------+--------------------------------------+

SEE ALSO
       perl(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.



NOTES
       Source code for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This software was built from source available at
       https://github.com/oracle/solaris-userland.  The original community
       source was downloaded from
       http://search.cpan.org/CPAN/authors/id/S/SM/SMCCAM/X11-Protocol-0.56.tar.gz.

       Further information about this software can be found on the open source
       community website at http://search.cpan.org/~smccam/X11-Protocol.



perl v5.32.0                      2003-01-27           Protocol::Connection(3)