Source of file TransportDetailEvent.php

Size: 6,712 Bytes - Last Modified: 2019-04-30T12:53:24+00:00

/data/development/sccp/sources/PAMI/src/PAMI/Message/Event/TransportDetailEvent.php

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288
<?php
/**
 * Event triggered when an agent logs in.
 *
 * PHP Version 5
 *
 * @category   Pami
 * @package    Message
 * @subpackage Event
 * @author     Niklas Larsson <niklas@tese.se>
 * @license    http://marcelog.github.com/PAMI/ Apache License 2.0
 * @version    SVN: $Id$
 * @link       http://marcelog.github.com/PAMI/
 *
 * Copyright 2015 Diederik de Groot <ddegroot@users.sf.net>, Marcelo Gornstein <marcelog@gmail.com>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */
namespace PAMI\Message\Event;

use PAMI\Message\Event\EventMessage;

/**
 * Event triggered when an agent logs in.
 *
 * PHP Version 5
 *
 * @category   Pami
 * @package    Message
 * @subpackage Event
 * @author     Niklas Larsson <niklas@tese.se>
 * @license    http://marcelog.github.com/PAMI/ Apache License 2.0
 * @link       http://marcelog.github.com/PAMI/
 */
class TransportDetailEvent extends EventMessage
{
    /**
     * Returns key: 'ObjectType'. The object's type. This will always be 'transport'.
     *
     * @return string
     */
    public function getObjectType()
    {
        return $this->getKey('ObjectType');
    }

    /**
     * Returns key: 'ObjectName'. The name of this object.
     *
     * @return string
     */
    public function getObjectName()
    {
        return $this->getKey('ObjectName');
    }

    /**
     * Returns key: 'Protocol'. Protocol to use for SIP traffic
     *
     * @return string
     */
    public function getProtocol()
    {
        return $this->getKey('Protocol');
    }

    /**
     * Returns key: 'Bind'. IP Address and optional port to bind to for this transport
     *
     * @return string
     */
    public function getBind()
    {
        return $this->getKey('Bind');
    }

    /**
     * Returns key: 'AsycOperations'. Number of simultaneous Asynchronous Operations
     *
     * @return string
     */
    public function getAsycOperations()
    {
        return $this->getKey('AsycOperations');
    }

    /**
     * Returns key: 'CaListFile'. File containing a list of certificates to read (TLS ONLY)
     *
     * @return string
     */
    public function getCaListFile()
    {
        return $this->getKey('CaListFile');
    }

    /**
     * Returns key: 'CaListPath'. Path to directory containing a list of certificates to read (TLSONLY)
     *
     * @return string
     */
    public function getCaListPath()
    {
        return $this->getKey('CaListPath');
    }

    /**
     * Returns key: 'CertFile'. Certificate file for endpoint (TLS ONLY)
     *
     * @return string
     */
    public function getCertFile()
    {
        return $this->getKey('CertFile');
    }

    /**
     * Returns key: 'PrivKeyFile'. Private key file (TLS ONLY)
     *
     * @return string
     */
    public function getPrivKeyFile()
    {
        return $this->getKey('PrivKeyFile');
    }

    /**
     * Returns key: 'Password'. Password required for transport
     *
     * @return string
     */
    public function getPassword()
    {
        return $this->getKey('Password');
    }

    /**
     * Returns key: 'ExternalSignalingAddress'. External address for SIP signalling
     *
     * @return string
     */
    public function getExternalSignalingAddress()
    {
        return $this->getKey('ExternalSignalingAddress');
    }

    /**
     * Returns key: 'ExternalSignalingPort'. External port for SIP signalling
     *
     * @return string
     */
    public function getExternalSignalingPort()
    {
        return $this->getKey('ExternalSignalingPort');
    }

    /**
     * Returns key: 'ExternalMediaAddress'. External IP address to use in RTP handling
     *
     * @return string
     */
    public function getExternalMediaAddress()
    {
        return $this->getKey('ExternalMediaAddress');
    }

    /**
     * Returns key: 'Domain'. Domain the transport comes from
     *
     * @return string
     */
    public function getDomain()
    {
        return $this->getKey('Domain');
    }

    /**
     * Returns key: 'VerifyServer'. Require verification of server certificate (TLS ONLY)
     *
     * @return string
     */
    public function getVerifyServer()
    {
        return $this->getKey('VerifyServer');
    }

    /**
     * Returns key: 'VerifyClient'. Require verification of client certificate (TLS ONLY)
     *
     * @return string
     */
    public function getVerifyClient()
    {
        return $this->getKey('VerifyClient');
    }

    /**
     * Returns key: 'RequireClientCert'. Require client certificate (TLS ONLY)
     *
     * @return string
     */
    public function getRequireClientCert()
    {
        return $this->getKey('RequireClientCert');
    }

    /**
     * Returns key: 'Method'. Method of SSL transport (TLS ONLY)
     *
     * @return string
     */
    public function getMethod()
    {
        return $this->getKey('Method');
    }

    /**
     * Returns key: 'Cipher'. Preferred cryptography cipher names (TLS ONLY)
     *
     * @return string
     */
    public function getCipher()
    {
        return $this->getKey('Cipher');
    }

    /**
     * Returns key: 'LocalNet'. Network to consider local (used for NAT purposes).
     *
     * @return string
     */
    public function getLocalNet()
    {
        return $this->getKey('LocalNet');
    }

    /**
     * Returns key: 'Tos'. Enable TOS for the signalling sent over this transport
     *
     * @return string
     */
    public function getTos()
    {
        return $this->getKey('Tos');
    }

    /**
     * Returns key: 'Cos'. Enable COS for the signalling sent over this transport
     *
     * @return string
     */
    public function getCos()
    {
        return $this->getKey('Cos');
    }

    /**
     * Returns key: 'WebsocketWriteTimeout'. The timeout (in milliseconds) to set on WebSocket connections.
     *
     * @return string
     */
    public function getWebsocketWriteTimeout()
    {
        return $this->getKey('WebsocketWriteTimeout');
    }

    /**
     * Returns key: 'EndpointName'. The name of the endpoint associated with this information.
     *
     * @return string
     */
    public function getEndpointName()
    {
        return $this->getKey('EndpointName');
    }
}