ptevent.h

基于sipfoundy 公司开发的sipx协议API

//
// Copyright (C) 2004, 2005 Pingtel Corp.
// 
//
// $$
////////////////////////////////////////////////////////////////////////
//////


#ifndef _PtEvent_h_
#define _PtEvent_h_

// SYSTEM INCLUDES
// APPLICATION INCLUDES
#include <utl/UtlString.h>
#include "ptapi/PtDefs.h"

// DEFINES
#define MAX_OLD_CALLS 10

// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS
class PtMetaEvent;
class TaoClientTask;

//! The PtEvent encapulates data associated with an event notification.
//! The PtEvent is sent to an application implementing a PtEventListener
//! by the Pingtel object in which the event occurs.
/*!
 * <H3>Event/Listener Model</H3>
 * PtEvent is subclassed to contain the PTAPI object(s) and data
 * involved with the event.  An application that is interested in events
 * from a specific object must implement a PtEventListener that handles
 * the specific type of event(s) of interest.  In order to start the
 * reporting of events, the application adds its listener to the object
 * instance that will report those events.  When the
 * events for that object occur, a method on the listener is called,
 * specific to that event type.
 * <p>
 *
 * The application implementing the listener knows which specific event
 * has occurred based upon the listener method that was invoked.
 * However the PtEvent also contains a PtEventId which also defines
 * the specific event that occured.  In addition, the PtEvent contains
 * a PtEventCause which provides information as to why the event occurred.
 * <p>
 *
 * The methods on the PtEventListener, that are called when a specific event
 * occurs, take a PtEvent as an argument.  The application is likely
 * to want to up-cast the PtEvent to access data specific to the
 * PtEvent subtype.  To ease this, the PtEvent provides methods to query
 * its class name and inheritance.
 *
 * <H3>Meta Events</H3>
 * Events very often occur in logical groups of related events.  To provide
 * this grouping, the concept of meta events is used.  Meta events occur in
 * pairs to indicate the start and end of the logical group of events.
 * Events that belong to the logical group (including the end meta event)
 * have a meta event set to the start meta event.  Note that due to the
 * distributed nature of the Pingtel system, the events may not all be
 * received as a group or sequentially.  That is events, which do not
 * belong to this or perhaps any meta group of events may be received
 * after the start meta event and before end meta event is received.
 */

class PtEvent
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

    PT_CLASS_INFO_MEMBERS

    enum PtEventId
    {
        EVENT_INVALID = 0,

                // core
        ADDRESS_EVENT_TRANSMISSION_ENDED        = 100,

        CALL_ACTIVE                                                     = 101,
        CALL_INVALID                                            = 102,
        CALL_EVENT_TRANSMISSION_ENDED           = 103,

        CONNECTION_ALERTING                                     = 104,
        CONNECTION_CONNECTED                            = 105,
        CONNECTION_CREATED                                      = 106,
        CONNECTION_DISCONNECTED                         = 107,
        CONNECTION_FAILED                                       = 108,
        CONNECTION_IN_PROGRESS                          = 109,
        CONNECTION_UNKNOWN                                      = 110,

        PROVIDER_IN_SERVICE                                     = 111,
        PROVIDER_EVENT_TRANSMISSION_ENDED       = 112,
        PROVIDER_OUT_OF_SERVICE                         = 113,
        PROVIDER_SHUTDOWN                                       = 114,

                TERMINAL_CONNECTION_ACTIVE                      = 115,
                TERMINAL_CONNECTION_CREATED                     = 116,
                TERMINAL_CONNECTION_DROPPED                     = 117,
                TERMINAL_CONNECTION_PASSIVE                     = 118,
                TERMINAL_CONNECTION_RINGING                     = 119,
                TERMINAL_CONNECTION_UNKNOWN                     = 120,

                TERMINAL_EVENT_TRANSMISSION_ENDED       = 121,

                  // call control
        ADDRESS_DO_NOT_DISTURB_ENABLED          = 200,
        ADDRESS_FORWARDING_CHANGED                      = 201,
        ADDRESS_MESSAGES_WAITING                        = 202,
        ADDRESS_DO_NOT_DISTURB_DISABLED         = 241,
        ADDRESS_NO_MESSAGES_WAITING                     = 244,

        CONNECTION_DIALING                                      = 204,
        CONNECTION_ESTABLISHED                          = 206,
        CONNECTION_IDLE                                         = 207,
        CONNECTION_INITIATED                            = 208,
        CONNECTION_NETWORK_ALERTING                     = 209,
        CONNECTION_NETWORK_REACHED                      = 210,
        CONNECTION_OFFERED                                      = 211,
        CONNECTION_QUEUED                                       = 212,

        TERMINAL_CONNECTION_BRIDGED                     = 214,
        TERMINAL_CONNECTION_HELD                        = 216,
        TERMINAL_CONNECTION_IN_USE                      = 217,
        TERMINAL_CONNECTION_TALKING                     = 219,
        TERMINAL_CONNECTION_DO_NOT_DISTURB      = 221,
        TERMINAL_CONNECTION_IDLE                        = 222,

        PHONE_BUTTON_INFO_CHANGED                       = 500,
        PHONE_BUTTON_DOWN                                       = 501,
        PHONE_DISPLAY_CHANGED                           = 502,
        PHONE_HOOKSWITCH_OFFHOOK                        = 503,
        PHONE_LAMP_MODE_CHANGED                         = 504,
        PHONE_MICROPHONE_GAIN_CHANGED           = 505,
        PHONE_RINGER_PATTERN_CHANGED            = 506,
        PHONE_RINGER_VOLUME_CHANGED                     = 507,
        PHONE_SPEAKER_VOLUME_CHANGED            = 508,

                PHONE_BUTTON_UP                                         = 510,
                PHONE_BUTTON_REPEAT                                     = 511,
                PHONE_EXTSPEAKER_CONNECTED                      = 512,
                PHONE_EXTSPEAKER_DISCONNECTED           = 513,
                PHONE_HANDSET_VOLUME_CHANGED            = 514,
                PHONE_HANDSETMIC_GAIN_CHANGED           = 515,
                PHONE_HOOKSWITCH_ONHOOK                         = 516,
                PHONE_RINGER_INFO_CHANGED                       = 517,

                MULTICALL_META_MERGE_STARTED            = 600,
                MULTICALL_META_MERGE_ENDED                      = 601,
                MULTICALL_META_TRANSFER_STARTED         = 602,
                MULTICALL_META_TRANSFER_ENDED           = 603,

                SINGLECALL_META_PROGRESS_STARTED        = 610,
                SINGLECALL_META_PROGRESS_ENDED          = 611,
                SINGLECALL_META_SNAPSHOT_STARTED        = 612,
                SINGLECALL_META_SNAPSHOT_ENDED          = 613,

        CALL_META_ADD_PARTY_STARTED                     = 620,
        CALL_META_ADD_PARTY_ENDED                       = 621,
        CALL_META_REMOVE_PARTY_STARTED          = 622,
        CALL_META_REMOVE_PARTY_ENDED            = 623,

        CALL_META_CALL_STARTING_STARTED         = 624,
        CALL_META_CALL_STARTING_ENDED           = 625,
        CALL_META_CALL_ENDING_STARTED           = 626,
        CALL_META_CALL_ENDING_ENDED                     = 627,

        PROVIDER_ADDRESS_ADDED                          = 630,
        PROVIDER_ADDRESS_REMOVED                        = 631,
        PROVIDER_TERMINAL_ADDED                         = 632,
        PROVIDER_TERMINAL_REMOVED                       = 633