PEIP_Pipe Class Reference

Inheritance diagram for PEIP_Pipe:

PEIP_ABS_Reply_Producing_Message_Handler PEIP_INF_Channel PEIP_INF_Subscribable_Channel PEIP_INF_Connectable PEIP_ABS_Message_Handler PEIP_INF_Message_Builder PEIP_INF_Handler PEIP_ABS_Event_Pipe PEIP_ABS_Message_Splitter PEIP_ABS_Router PEIP_ABS_Service_Activator PEIP_Event_Pipe PEIP_Service_Activator PEIP_Command_Pipe PEIP_Fixed_Event_Pipe PEIP_Simple_Event_Pipe PEIP_String_Service_Activator PEIP_Wiretap List of all members.

Public Member Functions

 setName ($name)
 getName ()
 send (PEIP_INF_Message $message, $timeout=-1)
 subscribe (PEIP_INF_Handler $handler)
 unsubscribe (PEIP_INF_Handler $handler)
 setMessageDispatcher (PEIP_INF_Dispatcher $dispatcher, $transferListeners=true)
 getMessageDispatcher ()
 connect ($name, PEIP_INF_Handler $listener)
 disconnect ($name, PEIP_INF_Handler $listener)
 hasListeners ($name)
 getListeners ($name)
 connectCall ($eventName, $callable)
 disconnectCall ($eventName, $callable)
 command (PEIP_INF_Message $cmdMessage)
 setEventDispatcher (PEIP_Object_Event_Dispatcher $dispatcher, $transferListners=true)
 getEventDispatcher ()

Protected Member Functions

 doSend (PEIP_INF_Message $message)
 replyMessage ($content)
 doReply (PEIP_INF_Message $message)
 registerCommand ($commandName, $callable)
 doFireEvent ($name, array $headers=array(), $eventClass=false)

Static Protected Member Functions

static getSharedEventDispatcher ()

Protected Attributes

 $eventDispatcher
 $messageDispatcher
 $name
 $commands = array()

Static Protected Attributes

static $sharedEventDispatcher

Detailed Description

Definition at line 22 of file PEIP_Pipe.php.

Member Function Documentation

PEIP_Pipe::setName ( $  name  ) 

public

Parameters:
$name 
Returns:

Definition at line 44 of file PEIP_Pipe.php.

References $name.

PEIP_Pipe::getName (  ) 

public

Returns:

Implements PEIP_INF_Channel.

Definition at line 53 of file PEIP_Pipe.php.

PEIP_Pipe::send ( PEIP_INF_Message $  message,
$  timeout = -1 
)

public

Parameters:
$message 
$timeout 
Returns:

Implements PEIP_INF_Channel.

Definition at line 64 of file PEIP_Pipe.php.

References PEIP_ABS_Message_Handler::handle().

PEIP_Pipe::doSend ( PEIP_INF_Message $  message  )  [protected]

protected

Parameters:
$message 
Returns:

Definition at line 74 of file PEIP_Pipe.php.

References doFireEvent(), and getMessageDispatcher().

Referenced by replyMessage().

PEIP_Pipe::replyMessage ( $  content  )  [protected]

protected

Parameters:
$content 
Returns:

Reimplemented from PEIP_ABS_Reply_Producing_Message_Handler.

Reimplemented in PEIP_Command_Pipe.

Definition at line 87 of file PEIP_Pipe.php.

References doSend(), PEIP_ABS_Reply_Producing_Message_Handler::ensureMessage(), and PEIP_ABS_Reply_Producing_Message_Handler::getOutputChannel().

Referenced by PEIP_Wiretap::doReply(), doReply(), PEIP_Event_Pipe::doReply(), PEIP_ABS_Service_Activator::doReply(), PEIP_ABS_Router::doReply(), and PEIP_ABS_Message_Splitter::doReply().

PEIP_Pipe::doReply ( PEIP_INF_Message $  message  )  [protected]

protected

Parameters:
$message 
Returns:

Reimplemented from PEIP_ABS_Reply_Producing_Message_Handler.

Reimplemented in PEIP_ABS_Router, PEIP_ABS_Service_Activator, PEIP_ABS_Message_Splitter, PEIP_Wiretap, and PEIP_Event_Pipe.

Definition at line 102 of file PEIP_Pipe.php.

References replyMessage().

PEIP_Pipe::subscribe ( PEIP_INF_Handler $  handler  ) 

public

Parameters:
$handler 
Returns:

Implements PEIP_INF_Subscribable_Channel.

Definition at line 112 of file PEIP_Pipe.php.

References doFireEvent(), and getMessageDispatcher().

PEIP_Pipe::unsubscribe ( PEIP_INF_Handler $  handler  ) 

public

Parameters:
$handler 
Returns:

Implements PEIP_INF_Subscribable_Channel.

Definition at line 123 of file PEIP_Pipe.php.

References doFireEvent(), and getMessageDispatcher().

PEIP_Pipe::setMessageDispatcher ( PEIP_INF_Dispatcher $  dispatcher,
$  transferListeners = true 
)

public

Parameters:
$dispatcher 
$transferListeners 
Returns:

Definition at line 135 of file PEIP_Pipe.php.

References connect(), and doFireEvent().

PEIP_Pipe::getMessageDispatcher (  ) 

public

Returns:

Definition at line 151 of file PEIP_Pipe.php.

Referenced by doSend(), subscribe(), and unsubscribe().

PEIP_Pipe::connect ( $  name,
PEIP_INF_Handler $  listener 
)

public

Parameters:
$name 
$listener 
Returns:

Implements PEIP_INF_Connectable.

Definition at line 162 of file PEIP_Pipe.php.

References $name, doFireEvent(), and getEventDispatcher().

Referenced by connectCall(), setEventDispatcher(), and setMessageDispatcher().

PEIP_Pipe::disconnect ( $  name,
PEIP_INF_Handler $  listener 
)

public

Parameters:
$name 
$listener 
Returns:

Implements PEIP_INF_Connectable.

Definition at line 174 of file PEIP_Pipe.php.

References $name, doFireEvent(), and getEventDispatcher().

Referenced by disconnectCall().

PEIP_Pipe::hasListeners ( $  name  ) 

public

Parameters:
$name 
Returns:

Implements PEIP_INF_Connectable.

Definition at line 185 of file PEIP_Pipe.php.

References $name, and getEventDispatcher().

PEIP_Pipe::getListeners ( $  name  ) 

public

Parameters:
$name 
Returns:

Implements PEIP_INF_Connectable.

Definition at line 195 of file PEIP_Pipe.php.

References $name, and getEventDispatcher().

Referenced by disconnectCall().

PEIP_Pipe::connectCall ( $  eventName,
$  callable 
)

public

Parameters:
$eventName 
$callable 
Returns:

Definition at line 213 of file PEIP_Pipe.php.

References connect().

PEIP_Pipe::disconnectCall ( $  eventName,
$  callable 
)

public

Parameters:
$eventName 
$callable 
Returns:

Definition at line 231 of file PEIP_Pipe.php.

References disconnect(), getEventDispatcher(), and getListeners().

PEIP_Pipe::registerCommand ( $  commandName,
$  callable 
) [protected]

protected

Parameters:
$commandName 
$callable 
Returns:

Definition at line 246 of file PEIP_Pipe.php.

PEIP_Pipe::command ( PEIP_INF_Message $  cmdMessage  ) 

public

Parameters:
$cmdMessage 
Returns:

Definition at line 256 of file PEIP_Pipe.php.

References doFireEvent().

PEIP_Pipe::setEventDispatcher ( PEIP_Object_Event_Dispatcher $  dispatcher,
$  transferListners = true 
)

public

Parameters:
$dispatcher 
$transferListners 
Returns:

Definition at line 272 of file PEIP_Pipe.php.

References $name, connect(), and doFireEvent().

PEIP_Pipe::getEventDispatcher (  ) 

public

Returns:

Definition at line 291 of file PEIP_Pipe.php.

Referenced by connect(), disconnect(), disconnectCall(), doFireEvent(), getListeners(), and hasListeners().

static PEIP_Pipe::getSharedEventDispatcher (  )  [static, protected]

Definition at line 295 of file PEIP_Pipe.php.

PEIP_Pipe::doFireEvent ( $  name,
array $  headers = array(),
$  eventClass = false 
) [protected]

protected

Parameters:
$name 
$headers 
$eventClass 
Returns:

Definition at line 307 of file PEIP_Pipe.php.

References $name, and getEventDispatcher().

Referenced by command(), connect(), disconnect(), doSend(), setEventDispatcher(), setMessageDispatcher(), subscribe(), and unsubscribe().

Member Data Documentation

PEIP_Pipe::$eventDispatcher [protected]

Definition at line 30 of file PEIP_Pipe.php.

PEIP_Pipe::$messageDispatcher [protected]

Definition at line 30 of file PEIP_Pipe.php.

PEIP_Pipe::$name [protected]

Definition at line 30 of file PEIP_Pipe.php.

Referenced by connect(), disconnect(), doFireEvent(), getListeners(), hasListeners(), setEventDispatcher(), and setName().

PEIP_Pipe::$commands = array() [protected]

Definition at line 33 of file PEIP_Pipe.php.

PEIP_Pipe::$sharedEventDispatcher [static, protected]

Definition at line 36 of file PEIP_Pipe.php.

The documentation for this class was generated from the following file:
Generated on Mon Apr 12 11:39:02 2010 for PEIP by  doxygen 1.5.1