williamr@2: // Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2: // All rights reserved.
williamr@2: // This component and the accompanying materials are made available
williamr@2: // 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
williamr@2: // which accompanies this distribution, and is available
williamr@2: // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2: //
williamr@2: // Initial Contributors:
williamr@2: // Nokia Corporation - initial contribution.
williamr@2: //
williamr@2: // Contributors:
williamr@2: //
williamr@2: // Description:
williamr@2: // SIPSCPR_subconevents.h
williamr@2: // SIP extension events definition
williamr@2: // 
williamr@2: //
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: /**
williamr@2:  @file
williamr@2:  @publishedAll
williamr@2:  @released since v9.2
williamr@2: */
williamr@2:  
williamr@2: #ifndef SIPSCPR_SUBCONEVENTS_H
williamr@2: #define SIPSCPR_SUBCONEVENTS_H
williamr@2: 
williamr@2: #include <es_sock.h>
williamr@2: #include <comms-infras/metabuffer.h>
williamr@2: 
williamr@2: /** The numeric value of ECOM plugin identifier for this SubConnection SIP event parameter.See the assisting *.rss file. */
williamr@2: const TInt KSubConSIPEventsUid = 0x10274CAE;
williamr@2: 
williamr@2: /** The numeric value of Response event type identifier for SIP extension parameter set  */
williamr@2: const TInt KSubConSIPResponseEventType = 1;
williamr@2: 
williamr@2: /** The numeric value of AuthenticationRequired event type identifier for SIP extension parameter set  */
williamr@2: const TInt KSubConSIPAuthenticationRequiredEventType = 2;
williamr@2: 
williamr@2: /** The numeric value of Notification event type identifier for SIP extension parameter set  */
williamr@2: const TInt KSubConSIPNotificationEventType = 3;
williamr@2: 
williamr@2: 
williamr@2: class CSubConSIPResponseEvent : public CSubConNotificationEvent
williamr@2: /** CSubConSIPResponseEvent is used to get and set the response elements of the most recent response  
williamr@2: 
williamr@2: @publishedAll
williamr@2: @released since v9.2 */
williamr@2: 	{
williamr@2: public:
williamr@2: 	/**
williamr@2: 	 Identifies the  predefined type of Response 		 .
williamr@2: 	 */
williamr@2:     enum PredefinedResponses
williamr@2:         {
williamr@2:         /** The numeric value of Invalid Response */
williamr@2:         EInvalidResponse = 0
williamr@2:         };
williamr@2:         
williamr@2: 	inline static CSubConSIPResponseEvent* NewL();
williamr@2: 	/** Constructor. */
williamr@2: 	inline CSubConSIPResponseEvent();
williamr@2: 	/** Destructor. */
williamr@2: 	virtual ~CSubConSIPResponseEvent();
williamr@2: 	/** Sets Response Code of the SIP Response. **/	
williamr@2: 	inline void SetResponse(TInt aResponse);
williamr@2: 	/** Gets Response Code of the SIP Response. **/	
williamr@2: 	inline TInt GetResponse() const;
williamr@2: 
williamr@2: protected:
williamr@2: 	/** The Response Code of the SIP reasponse. */
williamr@2:     TInt iResponse;
williamr@2: 	DATA_VTABLE
williamr@2: 	};
williamr@2: 	
williamr@2: 
williamr@2: class CSubConSIPAuthenticationRequiredEvent : public CSubConNotificationEvent
williamr@2: /** CSubConSIPAuthenticationRequiredEvent is used  when SIP authentication is required
williamr@2: 
williamr@2: @publishedAll
williamr@2: @released since v9.2 */
williamr@2: 	{
williamr@2: public:
williamr@2:         
williamr@2: 	inline static CSubConSIPAuthenticationRequiredEvent* NewL();
williamr@2: 	/** Constructor. */
williamr@2: 	inline CSubConSIPAuthenticationRequiredEvent();
williamr@2: 	/** Destructor. */
williamr@2: 	virtual ~CSubConSIPAuthenticationRequiredEvent();
williamr@2: 	/** Sets Realm field of the SIP header. **/	
williamr@2: 	inline void SetRealmL(const TPtrC8& aRealm);
williamr@2: 	/** Gets Realm field of the SIP header. **/	
williamr@2: 	inline const TPtrC8& GetRealm() const;
williamr@2: 
williamr@2: protected:
williamr@2: 	/** The Realm entry of Authenticate field in a SIP header. */
williamr@2: 	RBuf8	iRealm;
williamr@2: 	DATA_VTABLE
williamr@2: 	};
williamr@2: 
williamr@2: 
williamr@2: class CSubConSIPNotificationEvent : public CSubConNotificationEvent
williamr@2: /** CSubConSIPNotificationEvent is used for receiving SIP event notifications 
williamr@2: 
williamr@2: @publishedAll
williamr@2: @released since v9.2 */
williamr@2: 	{
williamr@2: public:
williamr@2:   	inline static CSubConSIPNotificationEvent* NewL();
williamr@2:   	/** Constructor. */
williamr@2: 	inline CSubConSIPNotificationEvent();
williamr@2: 	/** Destructor. */
williamr@2: 	virtual ~CSubConSIPNotificationEvent();
williamr@2: 	/** Sets Notification for an event. **/	
williamr@2: 	inline void SetNotificationL(const TPtrC8 & aNotification);
williamr@2: 	/** Gets Notification for an event. **/	
williamr@2: 	inline const TPtrC8& GetNotification() const;
williamr@2: 
williamr@2: protected:
williamr@2: 	/** The Notification entry. */
williamr@2:     RBuf8 iNotification;
williamr@2: 	DATA_VTABLE
williamr@2: 	};	
williamr@2: 	
williamr@2: 
williamr@2: class CSIPSubConnExtensionEventsFactory : public CBase
williamr@2: /** Factory used to create instances of the SIP SubConnection Extension Events
williamr@2: 
williamr@2: @publishedAll
williamr@2: @released since v9.2 
williamr@2: */
williamr@2: 	{
williamr@2: public:
williamr@2: 	static CSubConNotificationEvent* NewL(TAny* aConstructionParameters);
williamr@2: 	};
williamr@2: 
williamr@2: #include <sip_subconevents.inl>
williamr@2: 
williamr@2: #endif // SIPSCPR_SUBCONEVENTS_H