| Net-IRC3 documentation | Contained in the Net-IRC3 distribution. |
Net::IRC3::Connection - An IRC connection abstraction
#... $con->send_msg (undef, "PRIVMSG", "Hello there!", "yournick"); #...
NOTE: This module is DEPRECATED, please use AnyEvent::IRC for new programs, and possibly port existing Net::IRC3 applications to AnyEvent::IRC. Though the API of AnyEvent::IRC has incompatible changes, it's still fairly similar.
The connection class. Here the actual interesting stuff can be done, such as sending and receiving IRC messages.
Please note that CTCP support is available through the functions
encode_ctcp and decode_ctcp provided by Net::IRC3::Util.
This constructor does take no arguments.
Tries to open a socket to the host $host and the port $port.
If an error occured it will die (use eval to catch the exception).
This method can be used instead of connect to handle IRC messages
that are received and sent over the $socket.
In this case $host and $port are just documentation for the error messages.
Unregisters the connection in the main Net::IRC3 object, closes
the sockets and send a 'disconnect' event with $reason as argument.
Returns true when this connection is connected. Otherwise false.
Returns a hash reference that is local to this connection object that lets you store any information you want.
This method sends $ircline straight to the server without any
further processing done.
This function sends a message to the server. @ircmsg is the argumentlist
for Net::IRC3::Util::mk_msg.
This registers a callback in the connection class. These callbacks will be called by internal events and by IRC protocol commands. You can also specify multiple callback registrations.
The first argument to the callbacks is always the connection object itself.
If a callback returns a false value, it will be unregistered.
NOTE: A callback has to return true to stay alive
If $cmd starts with 'irc_' the callback $cb will be registered
for a IRC protocol command. The command is the suffix of $cmd then.
The second argument to the callback is the message hash reference
that has the layout that is returned by Net::IRC3::Util::parse_irc_msg.
With the special $cmd 'irc_*' the callback will be called on any
IRC command that is received.
EXAMPLE:
$con->reg_cb (irc_privmsg => \&privmsg_handler); # privmsg_handler will be called if an IRC message # with the command 'PRIVMSG' arrives.
If $cmd is not prefixed with a 'irc_' it will be called when an event
with the name $cmd is emitted. The arguments to the callback depend
on the event that is emitted (but remember: the first argument will always be the
connection object)
Following events are emitted by this module and shouldn't be emitted
from a module user call to event.
This event is generated when the socket was successfully connected.
This event is generated when the socket couldn't be connected successfully.
This event will be generated if the connection is somehow terminated.
It will also be emitted when disconnect is called.
The second argument to the callback is $reason, a string that contains
a clue about why the connection terminated.
If you want to reestablish a connection, call connect again.
Emitted when a message (@ircmsg) was sent to the server.
@ircmsg are the arguments to Net::IRC3::Util::mk_msg.
Emitted when a message ($msg) was read from the server.
$msg is the hash reference returned by Net::IRC3::Util::parse_irc_msg;
This function emits an event with the name $event and the arguments @args.
The registerd callback that has been registered with reg_cb will be called
with the first argument being the connection object and the rest of the arguments
being @args.
EXAMPLE
$con->reg_cb (test_event => sub { print "Yay, i love $_[1]!!\n");
$con->event (test_event => "IRC");
# will print "Yay, i love IRC!!\n"
Robin Redeker, <elmex@ta-sa.org>
Copyright 2006 Robin Redeker, all rights reserved.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
| Net-IRC3 documentation | Contained in the Net-IRC3 distribution. |
package Net::IRC3::Connection; use strict; no warnings; use AnyEvent; use POSIX; use IO::Socket::INET; use IO::Handle; use Net::IRC3::Util qw/mk_msg parse_irc_msg/;
sub new { my $this = shift; my $class = ref($this) || $this; my $self = { cbs => {}, heap => {}, outbuf => '' }; bless $self, $class; return $self; }
sub connect { my ($self, $host, $port) = @_; $self->{socket} and return; my $sock = IO::Socket::INET->new ( PeerAddr => $host, PeerPort => $port, Proto => 'tcp', Blocking => 0 ) or die "couldn't connect to irc server '$host:$port': $!\n";; $self->{socket} = $sock; $self->{host} = $host; $self->{port} = $port; $self->{cw} = AnyEvent->io (poll => 'w', fh => $self->{socket}, cb => sub { my ($w) = @_; # FIXME: handle EAGAIN ? delete $self->{cw}; if ($! = $sock->sockopt (SO_ERROR)) { $self->event ('connect_error' => $!); $self->_clear_me; } else { $self->use_socket ($host, $port, $self->{socket}); } 0 }); 1 }
sub use_socket { my ($self, $host, $port, $socket) = @_; $self->{host} = $host; $self->{port} = $port; $self->{socket} = $socket; $socket->blocking (0); $self->{connected} = 1; $self->event ('connect'); $self->_start_reader; $self->_start_writer; } sub _start_reader { my ($self) = @_; my ($host, $port) = ($self->{host}, $self->{port}); return if $self->{rw}; return unless $self->{socket}; $self->{rw} = AnyEvent->io (poll => 'r', fh => $self->{socket}, cb => sub { my $data; my $l = $self->{socket}->sysread ($data, 1024); # FIXME: handle EAGAIN if (defined $l) { if ($l == 0) { $self->disconnect ("EOF from IRC server '$host:$port'"); return } else { $self->_feed_irc_data ($data); } } else { if ($! == EAGAIN()) { return; } else { $self->disconnect ("Error while reading from IRC server '$host:$port': $!"); return; } } }); } sub _start_writer { my ($self) = @_; return unless $self->{socket} && $self->{connected} && length ($self->{outbuf}) > 0; my ($host, $port) = ($self->{host}, $self->{port}); unless (defined $self->{ww}) { $self->{ww} = AnyEvent->io (poll => 'w', fh => $self->{socket}, cb => sub { my $l = syswrite $self->{socket}, $self->{outbuf}; if (defined $l) { substr $self->{outbuf}, 0, $l, ""; if (length ($self->{outbuf}) == 0) { delete $self->{ww} } } else { if ($! == EAGAIN()) { return; } else { $self->disconnect ("Error while writing to IRC server '$self->{host}:$self->{port}': $!"); return; } } }); } }
sub disconnect { my ($self, $reason) = @_; $self->event (disconnect => $reason); $self->_clear_me; }
sub is_connected { my ($self) = @_; $self->{socket} && $self->{connected} } sub _clear_me { my ($self) = @_; delete $self->{connected}; delete $self->{rw}; delete $self->{ww}; delete $self->{cw}; delete $self->{socket}; delete $self->{cbs}; delete $self->{events}; }
sub heap { my ($self) = @_; return $self->{heap}; }
sub send_raw { my ($self, $ircline) = @_; $self->_send_raw ("$ircline\015\012"); } sub _send_raw { my ($self, $data) = @_; $self->{outbuf} .= $data; $self->_start_writer; }
sub send_msg { my ($self, @msg) = @_; $self->event (sent => @msg); $self->_send_raw (mk_msg (@msg)); }
sub reg_cb { my ($self, %regs) = @_; for my $cmd (keys %regs) { my $cb = $regs{$cmd}; if ($cmd =~ m/^irc_(\S+)/i) { push @{$self->{cbs}->{lc $1}}, $cb; } else { push @{$self->{events}->{$cmd}}, $cb; } } 1; }
sub event { my ($self, $ev, @arg) = @_; my $nxt = []; for (@{$self->{events}->{$ev}}) { $_->($self, @arg) and push @$nxt, $_; } $self->{events}->{$ev} = $nxt; } # internal function, called by the read callbacks above. sub _feed_irc_data { my ($self, $data) = @_; $self->{buffer} .= $data; my @msg; while ($self->{buffer} =~ s/^([^\015\012]*)\015?\012//) { push @msg, $1; } for (@msg) { my $m = parse_irc_msg ($_); $self->event (read => $m); my $nxt = []; for (@{$self->{cbs}->{lc $m->{command}}}) { $_->($self, $m) and push @$nxt, $_; } $self->{cbs}->{lc $m->{command}} = $nxt; $nxt = []; for (@{$self->{cbs}->{'*'}}) { $_->($self, $m) and push @$nxt, $_; } $self->{cbs}->{'*'} = $nxt; } }
1;