Phergie
[ class tree: Phergie ] [ index: Phergie ] [ all elements ]

Class: Phergie_Process_Abstract

Source Location: /Phergie/Process/Abstract.php

Class Overview


Base class for obtaining and processing incoming events.


Author(s):

Variables

Methods


Child classes:

Phergie_Process_Async
Connection data processor which polls to handle input in an asynchronous manner. Will also cause the application tick at the user-defined wait time.
Phergie_Process_Standard
Connection data processor which reads all connections looking for a response.

Class Details

[line 31]
Base class for obtaining and processing incoming events.



Tags:

author:  Phergie Development Team <team@phergie.org>
link:  http://pear.phergie.org/package/Phergie
abstract:  
license:  New BSD License


[ Top ]


Class Variables

$connections =

[line 45]

Current connection handler instance



Tags:

access:  protected



[ Top ]

$driver =

[line 38]

Current driver instance



Tags:

access:  protected



[ Top ]

$events =

[line 59]

Current event handler instance



Tags:

access:  protected



[ Top ]

$options = array()

[line 73]

List of arguments for use within the instance



Tags:

access:  protected

Type:   array


[ Top ]

$plugins =

[line 52]

Current plugin handler instance



Tags:

access:  protected



[ Top ]

$ui =

[line 66]

Current end-user interface instance



Tags:

access:  protected



[ Top ]



Class Methods


constructor __construct [line 83]

void __construct( Phergie_Bot $bot, [ $options = array()])

Gets the required class refences from Phergie_Bot.



Tags:

access:  public


Overridden in child classes as:

Phergie_Process_Async::__construct()
Overrides the parent class to set the poll time.

Parameters:

Phergie_Bot   $bot   Current bot instance in use
array   $options   Optional processor arguments

[ Top ]

method handleEvents [line 129]

void handleEvents( )

Obtains and processes incoming events.



Tags:

abstract:  
access:  public


Overridden in child classes as:

Phergie_Process_Async::handleEvents()
Waits for stream activity and performs event processing on connections with data to read.
Phergie_Process_Standard::handleEvents()
Obtains and processes incoming events, then sends resulting outgoing events.

[ Top ]

method processEvents [line 100]

void processEvents( Phergie_Connection $connection)

Sends resulting outgoing events from earlier processing in handleEvents().



Tags:

access:  protected


Parameters:

Phergie_Connection   $connection   Active connection

[ Top ]


Documentation generated on Mon, 27 Sep 2010 23:03:45 -0500 by phpDocumentor 1.4.3