Joshua Harding > AOL-TOC-0.340 > AOL::TOC

Download:
AOL-TOC-0.340.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  1
View/Report Bugs
Module Version: 0.34   Source  

NAME ^

AOL::TOC - Perl extension for interfacing with AOL's AIM service

SYNOPSIS ^

  use AOL::TOC;
  $toc = AOL::TOC::new($toc_server, $login_server, $port,
         $screenname, $password); 
  $toc->connect();

DESCRIPTION ^

This module implements SFLAP, which I presume to be AOL's authenticiation protocol, and TOC, which is the actual "meat" of the AIM protocol.

INTERFACE ^

connect

connects to the AIM server

register_callback

This function takes two arguments, the EVENT and the subroutine reference. Callbacks are similar to the ones found in Net::IRC. The module defines several AIM "events": ERROR, CLOSED, SIGN_ON, IM_IN, CHAT_IN, UPDATE_BUDDY. These events can be bound to subroutines.

dispatch

This flushes all messages to the server, and retreives all current messages.

add_buddy

Takes one arguement, the nick of the buddy. This adds a buddy to your buddy list.

send_im

Takes two arguments, the name of the buddy and the name of the message, and sends the IM.

get_info

Takes one argument, the name of the buddy, and returns the info.

chat_join

Takes one argument, the name of the chat room to join

chat_send

Takes two arguments, the name of the chat room, and the message.

AUTHOR ^

xjharding@newbedford.k12.ma.us cleaned it up and added DOC james@foo.org was the original author

SEE ALSO ^

Net::AIM, a new module, but it doesn't have the features of this one

syntax highlighting: