Interface Swift_Events_EventDispatcher

Implemented bySwift_Events_SimpleEventDispatcher

Interface for the EventDispatcher which handles the event dispatching layer.

Public Methods

Hide inherited methods

MethodDescriptionDefined By
bindEventListener() Bind an event listener to this dispatcher. Swift_Events_EventDispatcher
createCommandEvent() Create a new CommandEvent for $source and $command. Swift_Events_EventDispatcher
createResponseEvent() Create a new ResponseEvent for $source and $response. Swift_Events_EventDispatcher
createSendEvent() Create a new SendEvent for $source and $message. Swift_Events_EventDispatcher
createTransportChangeEvent() Create a new TransportChangeEvent for $source. Swift_Events_EventDispatcher
createTransportExceptionEvent() Create a new TransportExceptionEvent for $source. Swift_Events_EventDispatcher
dispatchEvent() Dispatch the given Event to all suitable listeners. Swift_Events_EventDispatcher

Method Details

bindEventListener() public abstract method

Bind an event listener to this dispatcher.

public abstract void bindEventListener ( Swift_Events_EventListener $listener )
$listener Swift_Events_EventListener
createCommandEvent() public abstract method

Create a new CommandEvent for $source and $command.

public abstract Swift_Events_CommandEvent createCommandEvent ( Swift_Transport $source, $command, $successCodes = [] )
$source Swift_Transport
$command string

That will be executed

$successCodes array

That are needed

createResponseEvent() public abstract method

Create a new ResponseEvent for $source and $response.

public abstract Swift_Events_ResponseEvent createResponseEvent ( Swift_Transport $source, $response, $valid )
$source Swift_Transport
$response string
$valid bool

If the response is valid

createSendEvent() public abstract method

Create a new SendEvent for $source and $message.

public abstract Swift_Events_SendEvent createSendEvent ( Swift_Transport $source, Swift_Mime_Message $message )
$source Swift_Transport
$message
createTransportChangeEvent() public abstract method

Create a new TransportChangeEvent for $source.

public abstract Swift_Events_TransportChangeEvent createTransportChangeEvent ( Swift_Transport $source )
$source Swift_Transport
createTransportExceptionEvent() public abstract method

Create a new TransportExceptionEvent for $source.

public abstract Swift_Events_TransportExceptionEvent createTransportExceptionEvent ( Swift_Transport $source, Swift_TransportException $ex )
$source Swift_Transport
$ex Swift_TransportException
dispatchEvent() public abstract method

Dispatch the given Event to all suitable listeners.

public abstract void dispatchEvent ( Swift_Events_EventObject $evt, $target )
$evt Swift_Events_EventObject
$target string

Method