#include <PtProviderEvent.h>
Inheritance diagram for PtProviderEvent:
Collaboration diagram for PtProviderEvent:
Public Member Functions | |
| PtProviderEvent (const PtProviderEvent &rPtProviderEvent) | |
| virtual | ~PtProviderEvent () |
| PtProviderEvent & | operator= (const PtProviderEvent &rhs) |
| PtStatus | getProvider (PtProvider &rProvider) |
 Public Member Functions inherited from PtEvent | |
| 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) | |
enumcode: META_CALL_STARTING - Meta code description for the initiation or starting of a call. This implies that the call is a new call and in the active state with at least one Connection added to it. enumcode: META_CALL_PROGRESS - Meta code description for the progress of a call. This indicates an update in state of certain objects in the call, or the addition of TerminalConnections (but not Connections). enumcode: META_CALL_ADDITIONAL_PARTY - Meta code description for the addition of a party to call. This includes adding a connection to the call. enumcode: META_CALL_REMOVING_PARTY - Meta code description for a party leaving the call. This includes exactly one Connection moving to the Connection.DISCONNECTED state. enumcode: META_CALL_ENDING - Meta code description for the entire call ending. This includes the call going to Call.INVALID, all of the Connections moving to the Connection.DISCONNECTED state. enumcode: META_CALL_MERGING - Meta code description for an action of merging two calls. This involves the removal of one party from one call and the addition of the same party to another call. enumcode: META_CALL_TRANSFERRING - Meta code description for an action of transferring one call to another. This involves the removal of parties from one call and the addition to another call, and the common party dropping off completely. enumcode: META_SNAPSHOT - Meta code description for a snapshot of events. enumcode: META_UNKNOWN - Meta code is unknown. More... | |
| PtEvent (const PtEvent &rPtEvent) | |
| virtual | ~PtEvent () |
| PtEvent & | operator= (const PtEvent &rhs) |
| virtual void | setEventId (PtEventId eventId) |
| virtual void | setMetaCode (PtMetaCode metaCode) |
| virtual void | setEventCallId (const char *callId) |
| virtual void | setEventSipResponseCode (int sipResponseCode) |
| virtual void | setEventSipResponseText (const char *sipResponseText) |
| virtual void | setEventNewCallId (const char *newCallId) |
| virtual void | setEventOldCallIds (int numOldCalls, UtlString *oldCallIds) |
| virtual void | setEventCause (PtEventCause cause) |
| virtual void | setEventLocal (int isLocal) |
| PtStatus | getId (PtEventId &rId) |
| PtStatus | getCause (PtEventCause &rCause) |
| param: (out) rId - The reference used to return the id retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More... | |
| virtual PtStatus | getMetaEvent (PtBoolean &rMetaEventExists, PtMetaEvent *&pEvent) const |
| param: (out) rCause - The reference used to return the cause retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More... | |
| PtStatus | getMetaCode (int &rMetaCode) |
| param: (out) rMetaEventExists - TRUE if a meta event is associated with this event. param: (out) rEvent - The reference used to return the meta event More... | |
| PtStatus | isNewMetaEvent (PtBoolean &rNewMetaEvent) |
| param: (out) rMetaCode - The meta code for this event. retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More... | |
| PtStatus | getSipResponseCode (int &responseCode, UtlString &responseText) |
| returns: Returns the string representation of the name of this class More... | |
| int | isLocal () const |
| param: (out) responseCode - The SIP response code. param: (out) responseText - The SIP response text. retcode: PT_SUCCESS - Success More... | |
| virtual PtBoolean | isClass (const char *pClassName) |
| virtual PtBoolean | isInstanceOf (const char *pClassName) |
| param: (in) pClassName - The string to compare with the name of this class. retcode: TRUE - If the given string contains the class name of this class. retcode: FALSE - If the given string does not match that of this class More... | |
| virtual PtBoolean | isSame (const PtEvent &rEvent) |
| param: (in) pClassName - The string to compare with the name of this class. retcode: TRUE - If this object is either an instance of or is derived from the specified class. retcode: FALSE - If this object is not an instance of the specified class. More... | |
Private Member Functions | |
| PtProviderEvent () | |
| param: (out) prProvider - The reference used to return the provider pointer retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More... | |
Additional Inherited Members | |
| Public Types inherited from PtEvent | |
| enum | PtEventId { EVENT_INVALID = 0, 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, 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 } |
| enum | PtEventCause { 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, 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, CAUSE_NOT_ALLOWED = 1000, CAUSE_NETWORK_NOT_ALLOWED = 1001 } |
| enumcode: PROVIDER_EVENT_TRANSMISSION_ENDED - Indicates that the application will no longer receive provider events on this instance of the PtProviderListener. enumcode: PROVIDER_IN_SERVICE - Indicates that the state of the PtProvider object has changed to PtProvider::IN_SERVICE. enumcode: PROVIDER_OUT_OF_SERVICE - Indicates that the state of the Provider object has changed to PtProvider::OUT_OF_SERVICE. enumcode: PROVIDER_SHUTDOWN - Indicates that the state of the PtProvider object has changed to PtProvider::SHUTDOWN. enumcode: PROVIDER_ADDRESS_ADDED - Indicates that a new PtAddress has been added to the provider. enumcode: PROVIDER_ADDRESS_REMOVED - Indicates that a PtAddress has been removed from the provider. enumcode: PROVIDER_TERMINAL_ADDED - Indicates that a new PtTerminal has been added to the provider. enumcode: PROVIDER_TERMINAL_REMOVED - Indicates that a PtTerminal has been removed from the provider. More... | |
| 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 } |
| enumcode: CAUSE_CALL_CANCELLED - Cause code indicating the user has terminated call without going on-hook. enumcode: CAUSE_DESTINATION_NOT_OBTAINABLE - Cause code indicating the destination is not available. enumcode: CAUSE_INCOMPATIBLE_DESTINATION - Cause code indicating that a call has encountered an incompatible destination. enumcode: CAUSE_LOCKOUT - Cause code indicating that a call encountered inter-digit timeout while dialing. enumcode: CAUSE_NETWORK_CONGESTION - Cause code indicating call encountered network congestion. enumcode: CAUSE_NETWORK_NOT_OBTAINABLE - Cause code indicating call could not reach a destination network. enumcode: CAUSE_NEW_CALL - Cause code indicating the event is related to a new call. enumcode: CAUSE_NORMAL - Cause code indicating normal operation. enumcode: CAUSE_RESOURCES_NOT_AVAILABLE - Cause code indicating resources were not available. enumcode: CAUSE_SNAPSHOT - Cause code indicating that the event is part of a snapshot of the current state of the call. enumcode: CAUSE_UNKNOWN - Cause code indicating the cause was unknown. More... | |
| Static Public Member Functions inherited from PtEvent | |
| static const char * | className () |
| param: (out) rNewMetaEvent - True if this event represents a new meta code grouping, false otherwise. retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More... | |
| 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) |
| static PtBoolean | isStateTransitionAllowed (int newState, int oldState) |
| param: (in) rEvent - Event to compare with this object. retcode: TRUE - If the events are the same. retcode: FALSE - If the events differ. More... | |
| Protected Attributes inherited from PtEvent | |
| int | mIsLocal |
| PtEventId | mEventId |
| PtEventCause | mEventCause |
| PtMetaCode | mMetaCode |
| int | mNumOldCalls |
| char * | mOldCallIds [MAX_OLD_CALLS] |
| UtlString | mNewCallId |
| TaoClientTask * | mpClient |
| UtlString | mCallId |
| int | mSipResponseCode |
| UtlString | mSipResponseText |
Constructor & Destructor Documentation
| PtProviderEvent | ( | const PtProviderEvent & | rPtProviderEvent | ) |
|
virtual |
|
private |
param: (out) prProvider - The reference used to return the provider pointer retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available
Member Function Documentation
| PtStatus getProvider | ( | PtProvider & | rProvider | ) |
| PtProviderEvent& operator= | ( | const PtProviderEvent & | rhs | ) |