1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/epoc32/include/mw/sip_subconevents.h Wed Mar 31 12:27:01 2010 +0100
1.3 @@ -0,0 +1,141 @@
1.4 +// Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +// SIPSCPR_subconevents.h
1.18 +// SIP extension events definition
1.19 +//
1.20 +//
1.21 +
1.22 +
1.23 +
1.24 +/**
1.25 + @file
1.26 + @publishedAll
1.27 + @released since v9.2
1.28 +*/
1.29 +
1.30 +#ifndef SIPSCPR_SUBCONEVENTS_H
1.31 +#define SIPSCPR_SUBCONEVENTS_H
1.32 +
1.33 +#include <es_sock.h>
1.34 +#include <comms-infras/metabuffer.h>
1.35 +
1.36 +/** The numeric value of ECOM plugin identifier for this SubConnection SIP event parameter.See the assisting *.rss file. */
1.37 +const TInt KSubConSIPEventsUid = 0x10274CAE;
1.38 +
1.39 +/** The numeric value of Response event type identifier for SIP extension parameter set */
1.40 +const TInt KSubConSIPResponseEventType = 1;
1.41 +
1.42 +/** The numeric value of AuthenticationRequired event type identifier for SIP extension parameter set */
1.43 +const TInt KSubConSIPAuthenticationRequiredEventType = 2;
1.44 +
1.45 +/** The numeric value of Notification event type identifier for SIP extension parameter set */
1.46 +const TInt KSubConSIPNotificationEventType = 3;
1.47 +
1.48 +
1.49 +class CSubConSIPResponseEvent : public CSubConNotificationEvent
1.50 +/** CSubConSIPResponseEvent is used to get and set the response elements of the most recent response
1.51 +
1.52 +@publishedAll
1.53 +@released since v9.2 */
1.54 + {
1.55 +public:
1.56 + /**
1.57 + Identifies the predefined type of Response .
1.58 + */
1.59 + enum PredefinedResponses
1.60 + {
1.61 + /** The numeric value of Invalid Response */
1.62 + EInvalidResponse = 0
1.63 + };
1.64 +
1.65 + inline static CSubConSIPResponseEvent* NewL();
1.66 + /** Constructor. */
1.67 + inline CSubConSIPResponseEvent();
1.68 + /** Destructor. */
1.69 + virtual ~CSubConSIPResponseEvent();
1.70 + /** Sets Response Code of the SIP Response. **/
1.71 + inline void SetResponse(TInt aResponse);
1.72 + /** Gets Response Code of the SIP Response. **/
1.73 + inline TInt GetResponse() const;
1.74 +
1.75 +protected:
1.76 + /** The Response Code of the SIP reasponse. */
1.77 + TInt iResponse;
1.78 + DATA_VTABLE
1.79 + };
1.80 +
1.81 +
1.82 +class CSubConSIPAuthenticationRequiredEvent : public CSubConNotificationEvent
1.83 +/** CSubConSIPAuthenticationRequiredEvent is used when SIP authentication is required
1.84 +
1.85 +@publishedAll
1.86 +@released since v9.2 */
1.87 + {
1.88 +public:
1.89 +
1.90 + inline static CSubConSIPAuthenticationRequiredEvent* NewL();
1.91 + /** Constructor. */
1.92 + inline CSubConSIPAuthenticationRequiredEvent();
1.93 + /** Destructor. */
1.94 + virtual ~CSubConSIPAuthenticationRequiredEvent();
1.95 + /** Sets Realm field of the SIP header. **/
1.96 + inline void SetRealmL(const TPtrC8& aRealm);
1.97 + /** Gets Realm field of the SIP header. **/
1.98 + inline const TPtrC8& GetRealm() const;
1.99 +
1.100 +protected:
1.101 + /** The Realm entry of Authenticate field in a SIP header. */
1.102 + RBuf8 iRealm;
1.103 + DATA_VTABLE
1.104 + };
1.105 +
1.106 +
1.107 +class CSubConSIPNotificationEvent : public CSubConNotificationEvent
1.108 +/** CSubConSIPNotificationEvent is used for receiving SIP event notifications
1.109 +
1.110 +@publishedAll
1.111 +@released since v9.2 */
1.112 + {
1.113 +public:
1.114 + inline static CSubConSIPNotificationEvent* NewL();
1.115 + /** Constructor. */
1.116 + inline CSubConSIPNotificationEvent();
1.117 + /** Destructor. */
1.118 + virtual ~CSubConSIPNotificationEvent();
1.119 + /** Sets Notification for an event. **/
1.120 + inline void SetNotificationL(const TPtrC8 & aNotification);
1.121 + /** Gets Notification for an event. **/
1.122 + inline const TPtrC8& GetNotification() const;
1.123 +
1.124 +protected:
1.125 + /** The Notification entry. */
1.126 + RBuf8 iNotification;
1.127 + DATA_VTABLE
1.128 + };
1.129 +
1.130 +
1.131 +class CSIPSubConnExtensionEventsFactory : public CBase
1.132 +/** Factory used to create instances of the SIP SubConnection Extension Events
1.133 +
1.134 +@publishedAll
1.135 +@released since v9.2
1.136 +*/
1.137 + {
1.138 +public:
1.139 + static CSubConNotificationEvent* NewL(TAny* aConstructionParameters);
1.140 + };
1.141 +
1.142 +#include <sip_subconevents.inl>
1.143 +
1.144 +#endif // SIPSCPR_SUBCONEVENTS_H