Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
AIM::Connection(3)    User Contributed Perl Documentation   AIM::Connection(3)

NAME
       Net::AIM::Connection - Interface	to an AIM connection

SYNOPSIS
DESCRIPTION
       This module handles the connection and communications between us	and
       the server.  It parses the incoming data	and hands it off to handler
       methods if they are defined.  It	currently supports and follows the TOC
       protocol	and contains methods to	send out our information and messages.

METHODS
	   Net::AIM::Connection->new($hash_ref)

		 Net::AIM::Connection-E<gt>new(	{
		    Screenname => 'perlaim',
		    Password =>	'yaddayadda',
		    TocServer => 'toc.oscar.aol.com',
		    TocPort => 80,
		    AuthServer => 'login.oscar.aol.com',
		    AuthPort =>	5159
		}

	   Creates a new Connection object and tries to	connect	to the	AIM
	   TOC server.	This method creates and	objet and calls	connect	with
	   all the arguments passed to it.

	   $aim_conn->new($hash_ref)

	      $aim_conn-E<gt>new( {
		    Screenname => 'perlaim',  #required
		    Password =>	'ilyegk',  #required
		    TocServer => 'toc.oscar.aol.com',
		    TocPort => 9898,
		    AuthServer => 'login.oscar.aol.com',
		    AutoReconnect => 1,
		    Agent => 'Net::aim mychat',	# DONT USE 'AIM'!!!
		    AuthPort =>	5159
		} );

	   Sets	up a connection	to the AOL TOC server.

	   $aim->normalize($data)

	   This	method normalizes $data	by killing all but strict alphnumeric
	   characters.	Typically used for screen_names.

	   $aim_conn->send_im($screen_name, $message)

	   This	method sends $message to $screen_name.

	   $aim_conn->set_idle($idle_time)

	   This	method sets our	idle time to $idle_time.  If $idle_time	is
	   omitted it will be set to 0.

	   $aim_conn->add_buddy(@buddies)

	   This	method adds @buddies to	our buddy list that is set on the
	   server.

	   $aim_conn->add_permit(@buddies)

	   This	method adds @buddies to	our permit list	that is	set on the
	   server.

	   $aim_conn->add_deny(@buddies)

	   This	method adds @buddies to	our deny list that is set on the
	   server.

	   $aim_conn->remove_buddy(@buddies)

	   This	method removes @buddies	from our buddy list that is set	on the
	   server.

	   $aim_conn->set_away($message)

	   This	method sets our	idle time to $idle_time.  If $idle_time	is
	   omitted it will be set to 0.

	   $aim_conn->get_info($screen_name)

	   Sends an info request to the	server for $screen_name. The server
	   should reply	with a URL which will contain the info requested about
	   the user.

	   $aim_conn->set_info($info)

	   This	method sets your info or profile information to	$info on the
	   server.

	   $aim_conn->evil($user, $anon)

	   Warn	$screen_name.  $anon: boolean value which will determine
	   whether to warn the user anonymously	or normally.  Anonymous
	   warnings are	less severe.

	   $aim_conn->send_to_AOL($message)

	   Send	$message to the	server.	 This is used internally by other
	   functions to	send commands to the server.

	      $aim_conn->send_to_AOL('toc_add_buddy perlaim')

	   $aim_conn->chat_invite($room, $msg, @buddies)

	   Invite @buddies to $room with the message $msg

	   $aim_conn->chat_accept($room_id)

	   This	will accept an invitation that was sent	to us for $room_id

	   $aim_conn->chat_leave($room_id)

	   This	method instructs the server to take you	out of the room
	   $room_id

	   $aim_conn->chat_whisper($room_id,$user,$msg)

	   Whisper $msg	to $user in the	room $room_id

	   $aim_conn->chat_send_to_AOL($room_id, $message)

	   Send	$message in chat room $room_id

	   $aim_conn->chat_join($roomname)

	   Send	a request to enter the room $roomname

	   $aim_conn->connected()

	   Returns a boolean value based on the	state of the object's socket.

	   $aim->debug($debug)

	   Set whether to print	DEBUGGING information to STDERRR.  Accepts
	   $debug which	should be a boolean value.

	   $aim_conn->set_handler($evttype, \&coderef)

	   Set a sub routine to	be called when $event is encountered:
	      $aim_conn->set_handler('error', \&on_errror);
	      $aim_conn->set_handler('im_in', \&on_im);

	   $aim_conn->encode($str)

	   This	method returns $str encoded as per the TOC specs: escaped
	   special chars ({}[]$) and enclosed in quotes	(")

	   $aim_conn->encodePass($password)

	   This	method roasts $password	according to the TOC specs. The
	   roasted password is returned.

	   $aim_conn->send_config($cfg_str)

	   Sends $cfg_str to the server	to be used as configuration values for
	   the account.

	   $aim_conn->read_and_parse()

	   Read	a chunk	of data	off the	connection to the server parse it and
	   send	it off to any defined handlers.

AUTHOR
       Aryeh Goldsmith <perlaim@aryeh.net>.

URL
       The Net::AIM project: http://www.aryeh.net/Net-AIM/

       The Net::AIM bot	list: http://www.nodoubtyo.com/aimbots/

SEE ALSO
       perl(1)

POD ERRORS
       Hey! The	above document had some	coding errors, which are explained
       below:

       Around line 21:
	   You can't have =items (as at	line 107) unless the first thing after
	   the =over is	an =item

       Around line 878:
	   You forgot a	'=back'	before '=head1'

perl v5.24.1			  2002-04-23		    AIM::Connection(3)

NAME | SYNOPSIS | DESCRIPTION | METHODS | AUTHOR | URL | SEE ALSO | POD ERRORS

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Net::AIM::Connection&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help