README

A ZF module for PAMI library.

Configuration

First, you should define connection and client options in your configuration. Client options are all optional.

return [
    'pami_module' => [
        'connection' => [
            'default' => [
                'host' => '', // IP or hostname of asterisk server
                'port' => 5038, // (optional) Asterisk AMI port (default: 5038)
                'username' => '', // Username for asterisk AMI
                'secret' => '', // Password for asterisk AMI
                'scheme' => 'tcp://', // (optional) Connection scheme (default: tcp://)
                'connect_timeout' => 10000, // (optional) Connection timeout in ms (default: 10000)
                'read_timeout' => 10000 // (optional) Read timeout in ms (default: 10000)
            ]
        ],
        'client' => [
            'default' => []
        ]
    ]
]

Then you can retrieve two services from the service locator:

pami.client.default: PamiModule client

PamiModule Client

You can get the client from the service locator.

use PamiModule\Service\Client;
use PAMI\Client\Impl\ClientImpl;

// Getting the PamiModule client
/** @var Client $client */
$client = $serviceLocator->get('pami.client.default');

Methods

The original Pami client (the connection) is injected into the PamiModule, and the PamiModule actions delegates the original client.

Mapped Actions:

Events

The PamiModule client has an EventManager instance injected into it.
The following methods will trigger events with the same name of the method and .pre and .post suffix:

connect()
disconnect()
process()
sendAction()

The sendAction() events have action param in sendAction.pre event and action and response params in sendAction.post event, allowing you to modify the action before it will be dispatched or to cache responses.

PAMI events

All PAMI events are forwarded to the event manager that will trigger an event (PamiModule\Event\PamiEvent).
The name of the event will be event.<name> (example: event.ExtensionStatus).
Of course, you can acces to the original event to retrieve event data (see example below).
The event target is the PamiModule client.

Example:

use PamiModule\Service\Client;
use PamiModule\Event\PamiEvent;

/* @var Client $client */
$client = $serviceLocator->get('pami.client.default');
$client->getEventManager()->attach('event.Bridge', function(PamiEvent $event) {
    // Getting the client
    /* @var Client $client */
    $client = $event->getTarget();
    
    // Getting the original Event
    /* @var \PAMI\Message\Event\BridgeEvent $pamiEvent */
    $pamiEvent = $event->getEvent();
});

Multiple clients

return [
    'pami_module' => [
        'connection' => [
            'default' => [
                // configuration
            ],
            'asterisk2' => [
                // configuration
            ]
        ],
        'client' => [
            'default' => [],
            'asterisk2 => []
        ]
    ]
]

You can retrieve clients with service names:

pami.client.default
pami.client.asterisk2

Multiple clients sharing the same connection

You can create another client with the same connection of another one:

return [
    'pami_module' => [
        'connection' => [
            'default' => [
                // configuration
            ]
        ],
        'client' => [
            'default' => [
                'connection' => 'default'
            ],
            'client2' => [
                'connection' => 'default'
            ]
        ]
    ]
]

$client1 = $serviceLocator->get('pami.client.default');
$client2 = $serviceLocator->get('pami.client.client2');

$client1->getConnection() === $client2->getConnection(); // true

Getting the original PAMI client

You can retrieve the original PAMI client in two ways:

From service locator:

use PAMI\Client\Impl\ClientImpl;

/* @var ClientImpl $connection */
$connection = $serviceLocator->get('pami.connection.default');

From the PamiModule client:

use PamiModule\Service\Client;
use PAMI\Client\Impl\ClientImpl;

// Getting the PamiModule client
/* @var Client $client */
$client = $serviceLocator->get('pami.client.default');
// Getting the PAMI client
/* @var ClientImpl $connection */
$connection = $client->getConnection();

Available Listeners

There are listeners ready to be used.

PamiModule\Listener\ConnectionStatusListener
PamiModule\Listener\CacheListener

ConnectionStatusListener

This listener takes care to maintain a connection status, and to call connect() method when is required.
It can be useful when you share the client between some services, because you don't need to call connect() methods without to know the connection status. You can call directly process() and sendAction() methods and it will automatically calls connect() if a connection is not already opened.
You can also use connect() and disconnect() methods at any point of your application, the listener takes care to open or close connection only if is really necessary.
In order to use this listener, you can't use the connection (the original PAMI client) directly, because the connection status is maintained listening the PamiModule client events.

If you want to use the listener in multiple clients, you need to attach a new instance of it for every client.

You have to attach it to the client before to call any methods, so the best way is to use a delegator factory. This library provide a ready to use delegator factory:

return [
    'service_manager' => [
        'delegators' => [
            'pami.client.default' => [
                'PamiModule\\Service\\ConnectionStatusDelegatorFactory'
            ]
        ]
    ]
];

Note: if you share some connection between clients, you must attach the same listener to the clients, so you need to create your custom DelegatorFactory.

CacheListener

You can use the CacheListener to cache results of some actions. The constructor require a cache storage instance and the action names that listener can cache response.

use PamiModule\Listener\CacheListener;
use Zend\Cache\Storage\StorageInterface;

$client = $serviceLocator->get('pami.client.default')
/* @var StorageInterface $cache */
$cache = $serviceLocator->get('asterisk_sippeers_cache');

$actionsToCache = ['SIPPeers', 'ShowPeer'];
$cacheListener = new CacheListener($cache, $actionsToCache);

$client->getEventManager()->attachAggregate($cacheListener);

thomasvargiu / pami-module

Maintainers

Details