Jon Portnoy > POEx-IRC-Backend > POEx::IRC::Backend::Connect

Download:
POEx-IRC-Backend-0.024006.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.024006   Source  

NAME ^

POEx::IRC::Backend::Connect - A connectoed socket wheel

SYNOPSIS ^

Typically created by POEx::IRC::Backend to represent an established connection.

DESCRIPTION ^

These objects contain details regarding connected socket POE::Wheel::ReadWrite wheels managed by POEx::IRC::Backend.

Consumes POEx::IRC::Backend::Role::HasWheel and adds the following attributes:

alarm_id

Connected socket wheels normally have a POE alarm ID attached for an idle timer. Writable attribute.

Predicate: has_alarm_id

compressed

Set to true if the Zlib filter has been added.

set_compressed

Change the boolean value of the "compressed" attrib.

idle

Idle time used for connection check alarms.

is_disconnecting

Boolean false if the Connect is not in a disconnecting state; if it is true, it is the disconnect message:

  $obj->is_disconnecting("Client quit")

is_client

Boolean true if the connection wheel has been marked as a client.

is_peer

Boolean true if the connection wheel has been marked as a peer.

is_pending_compress

Boolean true if the Wheel needs a Zlib filter.

  $obj->is_pending_compress(1)

peeraddr

The remote peer address.

peerport

The remote peer port.

protocol

The protocol in use (4 or 6).

seen

Timestamp; should be updated when traffic is seen from this Connect:

  ## In an input handler
  $obj->seen( time )

sockaddr

Our socket address.

sockport

Our socket port.

AUTHOR ^

Jon Portnoy <avenj@cobaltirc.org>

syntax highlighting: