realtimenetprots/sipfw/SIP/RequestHandler/inc/SipRequestHandlerBase.h
changeset 0 307788aac0a8
equal deleted inserted replaced
-1:000000000000 0:307788aac0a8
       
     1 /*
       
     2 * Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:
       
    15 * Name          : SipRequestHandlerBase.h
       
    16 * Part of       : SIP Request Handler
       
    17 * Version       : SIP/4.0 
       
    18 *
       
    19 */
       
    20 
       
    21 
       
    22 
       
    23 
       
    24 /**
       
    25  @internalComponent
       
    26 */
       
    27 
       
    28 #ifndef CSIPREQUESTHANDLERBASE_H
       
    29 #define CSIPREQUESTHANDLERBASE_H
       
    30 
       
    31 #include <e32base.h>
       
    32 #include <ecom/ecom.h>
       
    33 class CSIPRequest;
       
    34 class MSIPRequestHandlerObserver;
       
    35 
       
    36 const TUid KSIPRequestHandlerIFUid = { 0x101fed86 };
       
    37 
       
    38 
       
    39 class CSIPRequestHandlerBase : public CBase
       
    40     {
       
    41 	public: // Constructors and destructor
       
    42 	
       
    43 		/**
       
    44 		* Destructor.
       
    45 		*/
       
    46 		virtual inline ~CSIPRequestHandlerBase();
       
    47 
       
    48     public: // New functions
       
    49     
       
    50 		/**
       
    51 		* Registers handled client
       
    52 		* @param aChannel the communication channel UID of the connected client
       
    53 		*/
       
    54 		virtual void RegisterL(TUid aChannel) = 0;
       
    55 
       
    56 		/**
       
    57 		* Deregisters handled client
       
    58 		* @param aChannel the communication channel UID of the connected client
       
    59 		* @return KErrNone if successful, KErrNotFound if not found
       
    60 		*/
       
    61 		virtual TInt Deregister(TUid aChannel) = 0;
       
    62 
       
    63 		/**
       
    64 		* Request to provide the communication channel for the SIP request
       
    65 		* received outside the SIP dialog
       
    66 		* @param aSIPRequest SIP request
       
    67 		* @return a request ID
       
    68 		*/
       
    69 		virtual TUint32 ChannelL(CSIPRequest& aSIPRequest) = 0;
       
    70 		
       
    71 		/**
       
    72 		* Cancels a particular outstanding request
       
    73 		* @param aRequestId a request ID to be canceled
       
    74 		*/
       
    75 		virtual void Cancel(TUint32 aRequestId) = 0;
       
    76 
       
    77 	public: // Data
       
    78 
       
    79 		/// Unique key for implementations of this interface.
       
    80 		TUid iInstanceKey;
       
    81 
       
    82     protected: // Constructors:
       
    83 
       
    84         inline CSIPRequestHandlerBase(MSIPRequestHandlerObserver& aObserver);
       
    85         
       
    86     protected: // Data
       
    87     
       
    88     	MSIPRequestHandlerObserver& iObserver;
       
    89     };
       
    90     
       
    91 #include "SipRequestHandlerBase.inl"
       
    92 
       
    93 #endif // CSIPREQUESTHANDLERBASE_H