PtEvent.h

Go to the documentation of this file.

//  
// Copyright (C) 2006 SIPez LLC. 
// Licensed to SIPfoundry under a Contributor Agreement. 
//
// Copyright (C) 2004-2006 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// Copyright (C) 2004-2006 Pingtel Corp.  All rights reserved.
// Licensed to SIPfoundry under a Contributor Agreement.
//
// $$


#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;


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
    };
    //:Event Ids
    // The following table defines the event ids for all of the events
    // supported by the Pingtel system.
    //
    /* Provider Events */

    /* Address Events */
    /* call control: */

    /* Terminal Events */

    /* Call Events */
    /* call control */

    /* Multi-Call Events */

    /* Connection Events */
    /* replaced by callctrl CONNECTION_IN_PROGRESS - Indicates that the state of the PtConnection object has changed to PtConnection::IN_PROGRESS. */
    /* replaced by callctrl CONNECTION_CONNECTED - Indicates that the state of the PtConnection object has changed to PtConnection::CONNECTED. */
    /* call control */

    /* Terminal Connection Events */
    /* replaced by callctrl TERMINAL_CONNECTION_ACTIVE - Indicates that the state of the PtTerminalConnection object has changed to PtTerminalConnection::ACTIVE. */
    /* TERMINAL_CONNECTION_PASSIVE - Indicates that the state of the PtTerminalConnection object has changed to PtTerminalConnection::PASSIVE. */
    /* call control */
    /* TERMINAL_CONNECTION_BRIDGED - Indicates that the state of the PtTerminalConnection object has changed to PtTerminalConnection::BRIDGED. */
    /* TERMINAL_CONNECTION_IN_USE -  Indicates that the state of the PtTerminalConnection object has changed to PtTerminalConnection::INUSE. */

    /* PhoneComponent events */

    enum PtEventCause
    {
                /*
                 * WARNING: Do not change the order of these causes as they must match the JTAPI constants
                 */

                CAUSE_NORMAL                                                    = 100,
                CAUSE_UNKNOWN                                                   = 101,
                CAUSE_CALL_CANCELLED                                    = 102,
                CAUSE_DESTINATION_NOT_OBTAINABLE        = 103,
                CAUSE_INCOMPATIBLE_DESTINATION  = 104,
                CAUSE_LOCKOUT                                                   = 105,
                CAUSE_NEW_CALL                                                  = 106,
                CAUSE_RESOURCES_NOT_AVAILABLE           = 107,
                CAUSE_NETWORK_CONGESTION                        = 108,
                CAUSE_NETWORK_NOT_OBTAINABLE            = 109,
                CAUSE_SNAPSHOT                                                  = 110,

                // Call control
        CAUSE_ALTERNATE                                         = 202,
        CAUSE_BUSY                                                      = 203,
        CAUSE_CALL_BACK                                         = 204,
        CAUSE_CALL_NOT_ANSWERED                 = 205,
        CAUSE_CALL_PICKUP                                       = 206,
        CAUSE_CONFERENCE                                        = 207,
        CAUSE_DO_NOT_DISTURB                            = 208,
        CAUSE_PARK                                                      = 209,
        CAUSE_REDIRECTED                                        = 210,
        CAUSE_REORDER_TONE                                      = 211,
        CAUSE_TRANSFER                                          = 212,
        CAUSE_TRUNKS_BUSY                                       = 213,
        CAUSE_UNHOLD                                                    = 214,


                /*
                 * These are our own constants, make sure the map in JTAPI
                 */
                CAUSE_NOT_ALLOWED                                               = 1000,
                CAUSE_NETWORK_NOT_ALLOWED                       = 1001
    };
    //:Event causes
    // Specific event cause descriptions ...
    /* call control */

         // Meta events
    enum PtMetaCode
         {
                META_EVENT_NONE                                         = 0x00,
                META_CALL_STARTING                                      = 0x80,
                META_CALL_PROGRESS                                      = 0x81,
                META_CALL_ADDITIONAL_PARTY                      = 0x82,
                META_CALL_REMOVING_PARTY                        = 0x83,
                META_CALL_ENDING                                        = 0x84,
                META_CALL_MERGING                                       = 0x85,
                META_CALL_TRANSFERRING                          = 0x86,
                META_SNAPSHOT                                           = 0x87,
                META_UNKNOWN                                            = 0x88
        };
        /* meta events */



/* ============================ CREATORS ================================== */
   PtEvent(int eventId = EVENT_INVALID,
                        int metaCode = 0,
                        int numOldCalls = 0,
                        const char* callId = NULL,
                        TaoClientTask *pClient = NULL,
                        int sipResponseCode = 0,
                        const char* sipResponseText = 0,
                        const char** pMetaEventCallIds = 0,
                        const char* newCallId = NULL,
                        PtEventCause cause = CAUSE_NORMAL,
                        int isLocal = -1);
     //:Default constructor

   PtEvent(const PtEvent& rPtEvent);
     //:Copy constructor

   virtual
   ~PtEvent();
     //:Destructor

/* ============================ MANIPULATORS ============================== */

   PtEvent& operator=(const PtEvent& rhs);
     //:Assignment operator

   virtual void setEventId(PtEventId eventId);
   virtual void setMetaCode(PtMetaCode metaCode);
   virtual void setEventCallId(const char* callId);                     // call id
   virtual void setEventSipResponseCode(int sipResponseCode);           // SIP response code
   virtual void setEventSipResponseText(const char* sipResponseText);           // SIP response text
   virtual void setEventNewCallId(const char* newCallId);               // new call id
   virtual void setEventOldCallIds(int numOldCalls, UtlString* oldCallIds); // old call ids
   virtual void setEventCause(PtEventCause cause);              // cause
   virtual void setEventLocal(int isLocal);             // islocal?


/* ============================ ACCESSORS ================================= */

   PtStatus getId(PtEventId& rId);
     //:Returns the event identifier.
     // The <i>rId</i> argument is set to indicate the specific event that
     // has occurred.  For detailed descriptions of the event ids see the
     // PtEventId enumeration.

   PtStatus getCause(PtEventCause& rCause);
     //:Returns the cause of this event.
     // For detailed descriptions of the event causes see the PtEventCause
     // enumeration.

   virtual PtStatus getMetaEvent(PtBoolean& rMetaEventExists, PtMetaEvent*& pEvent) const ;
     //:Returns meta event for this event.
     // Meta events are used to group a set of related events.  Meta events
     // occur in pairs to indicate the start and end of the set of events.
     // The events between, which belong to the logical set of events, will
     // all have a meta event set to the start meta event.
     // If this event is not associated with a meta event, <i>pEvent</i>
     // has a eventID set to EVENT_INVALID.

        PtStatus getMetaCode(int& rMetaCode);
                //:Returns the meta code associated with this event. The meta code provides
                // a higher-level description of the event.

        PtStatus  isNewMetaEvent(PtBoolean& rNewMetaEvent);
                //:Returns true when this event is the start of a meta code group. This
                // method is used to distinguish two contiguous groups of events bearing
                // the same meta code.

   static const char* className();
     //:Returns the name of this class.

   PtStatus getSipResponseCode(int& responseCode, UtlString& responseText);
                //:Return the SIP response code associated with this event

/* ============================ INQUIRY =================================== */
   int isLocal() const ;
                //:Return 0 if connection not local, 1 local.

        static PtBoolean isCallEvent(int eventId);

        static PtBoolean isConnectionEvent(int eventId);

        static PtBoolean isTerminalEvent(int eventId);

        static PtBoolean isTerminalComponentEvent(int eventId);

        static PtBoolean isTerminalConnectionEvent(int eventId);

   virtual PtBoolean isClass(const char* pClassName);
     //:Determines if this object if of the specified type.

   virtual PtBoolean isInstanceOf(const char* pClassName);
     //:Determines if this object is either an instance of or is derived from
     //:the specified type.

   virtual PtBoolean isSame(const PtEvent& rEvent);
     //:Compares events to determine if they are the same.
     // Compares this event with <i>rEvent</i> to determine if they are the same event.
     // Events are the same if they represent the same logical event occuring
     // at the same instant on the same object.

        static PtBoolean isStateTransitionAllowed(int newState, int oldState);

/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:

        int                             mIsLocal;
        PtEventId               mEventId;
        PtEventCause    mEventCause;
        PtMetaCode              mMetaCode;

        int                mNumOldCalls;
   char*       mOldCallIds[MAX_OLD_CALLS];
        // UtlString            mOldCallIds[MAX_OLD_CALLS];

   UtlString            mNewCallId;

        TaoClientTask*  mpClient;
   UtlString            mCallId;

        int                     mSipResponseCode;
        UtlString               mSipResponseText;


//      PtEvent(PtEventId eventId, PtEventCause cause = CAUSE_NORMAL);

/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:

};

/* ============================ INLINE METHODS ============================ */

#endif  // _PtEvent_h_