sipXcallLib home page


PtConnectionEvent.h
Go to the documentation of this file.
1 //
2 // Copyright (C) 2004-2006 SIPfoundry Inc.
3 // Licensed by SIPfoundry under the LGPL license.
4 //
5 // Copyright (C) 2004-2006 Pingtel Corp. All rights reserved.
6 // Licensed to SIPfoundry under a Contributor Agreement.
7 //
8 // $$
10 
11 
12 #ifndef _PtConnectionEvent_h_
13 #define _PtConnectionEvent_h_
14 
15 // SYSTEM INCLUDES
16 // APPLICATION INCLUDES
17 #include "ptapi/PtCallEvent.h"
18 
19 // DEFINES
20 // MACROS
21 // EXTERNAL FUNCTIONS
22 // EXTERNAL VARIABLES
23 // CONSTANTS
24 // STRUCTS
25 // TYPEDEFS
26 // FORWARD DECLARATIONS
27 class PtConnection;
28 class TaoClientTask;
29 
30 //:PtConnectionEvent contains PtConnection-associated event data
31 
33 {
34 /* //////////////////////////// PUBLIC //////////////////////////////////// */
35 public:
36 
37 /* ============================ CREATORS ================================== */
39  int metaCode,
40  const char* addressName,
41  const char* callId,
42  int sipResponseCode,
43  const char* sipResponseText,
44  const char* newCallId = 0,
45  const char** oldCallIds = 0,
46  int numOldCalls = 0,
48  TaoClientTask *pClient = NULL);
49 
51 
52 
53  PtConnectionEvent(const PtConnectionEvent& rPtConnectionEvent);
54  //:Copy constructor
55 
57  //:Default constructor
58 
59  virtual
61  //:Destructor
62 
63 /* ============================ MANIPULATORS ============================== */
64 
66  //:Assignment operator
67 
68  virtual void setEventAddress(const char* address);
69 
70 /* ============================ ACCESSORS ================================= */
71  PtStatus getConnection(PtConnection& rConnection) const ;
72  //:Returns the connection object associated with this event.
76 
77 /* ============================ INQUIRY =================================== */
78 
79 /* //////////////////////////// PROTECTED ///////////////////////////////// */
80 protected:
81  char mAddressName[128];
82 
83 /* //////////////////////////// PRIVATE /////////////////////////////////// */
84 private:
85 
86 };
87 
88 /* ============================ INLINE METHODS ============================ */
89 
90 #endif // _PtConnectionEvent_h_
PtStatus
Definition: PtDefs.h:49
PtConnectionEvent(PtEvent::PtEventId eventId, int metaCode, const char *addressName, const char *callId, int sipResponseCode, const char *sipResponseText, const char *newCallId=0, const char **oldCallIds=0, int numOldCalls=0, PtEvent::PtEventCause cause=PtEvent::CAUSE_NORMAL, TaoClientTask *pClient=NULL)
Definition: PtConnectionEvent.cpp:38
PtEventId
Definition: PtEvent.h:83
Definition: PtEvent.h:85
char mAddressName[128]
param: (out) prConnection - The reference used to return the connection pointer retcode: PT_SUCCESS -...
Definition: PtConnectionEvent.h:81
Definition: PtEvent.h:279
Definition: PtConnectionEvent.h:32
PtStatus getConnection(PtConnection &rConnection) const
Definition: PtConnectionEvent.cpp:109
virtual ~PtConnectionEvent()
Definition: PtConnectionEvent.cpp:72
Definition: PtConnection.h:178
Definition: PtCallEvent.h:30
PtEventCause
enumcode: PROVIDER_EVENT_TRANSMISSION_ENDED - Indicates that the application will no longer receive p...
Definition: PtEvent.h:273
virtual void setEventAddress(const char *address)
Definition: PtConnectionEvent.cpp:92
Definition: TaoClientTask.h:50
PtConnectionEvent & operator=(const PtConnectionEvent &rhs)
Definition: PtConnectionEvent.cpp:80