Protoco...nection(3)

💖 NAME 💖

okay so, bestie, welcome to Protoco...nection(3) from User Contributed Perl Documentation — this is the page for X11::Protocol::Connection, a Perl module abstract base class for X11 client to server connections. It's literally the base-class blueprint for connection modules, and I'm obsessed 💅.

✨ SYNOPSIS ✨

Here's the whole group-chat screenshot of how it's used — code stays exactly as-is, no cap:

# 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 🌸

Okay so 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's giving "foundation of the friend group" energy 👑. 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. That's the whole assignment, bestie ✨.

🎀 give

$conn->give($data)

Send the given data to the server. Normally, this method is used only by the protocol module itself. So yeah, it's mostly backstage main-character energy 💅.

🍓 get

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

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

🧚 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. It's the "hey OS, look at this handle" move, iykyk 🌈.

👑 AUTHOR 👑

Stephen McCamant <SMCCAM@cpan.org>. Legend behavior, honestly 💖.

💀 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

---

perl v5.42.0 • 2024-03-04 • this page is out, mwah 💋🫶