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          : MSIPRequestRouter.h

    16 * Part of       : SIP Server Core

    17 * Version       : SIP/4.0 

    18 *

    19 */

    20 

    21 

    22 

    23 

    24 /**

    25  @internalComponent

    26 */

    27 

    28 #ifndef MSIPREQUESTROUTER_H

    29 #define MSIPREQUESTROUTER_H

    30 

    31 //  INCLUDES

    32 #include <e32base.h>

    33 

    34 // FORWARD DECLARATIONS

    35 class MSIPRequestRouterObserver;

    36 class CSIPRequest;

    37 

    38 // CLASS DECLARATION

    39 /**

    40 * An interface for finding transaction owners for incoming SIP requests.

    41 *

    42 *  @lib sipserver.exe

    43 */

    44 class MSIPRequestRouter

    45     {

    46 	public:

    47 

    48     	virtual ~MSIPRequestRouter () { }

    49 

    50 		/**

    51      	* An asynchronous function to get the owner for an incoming SIP request.

    52      	*

    53      	* @param aRequest a SIP request

    54      	* @param aIapId the id of the IAP where the request was received from.

    55      	* @param aObs the observer to be called when the asynchronous 

    56      	*        request completes.

    57      	* @returns a request ID to be used when matching 

    58      	*          the asynchronous request completion callback.

    59 	 	*/

    60     	virtual TUint32 TransactionOwnerL (CSIPRequest& aRequest,

    61                                            TUint32 aIapId,

    62                                            MSIPRequestRouterObserver& aObs) = 0;

    63 

    64    

    65 		/**

    66 	 	* Cancels an outstanding routing request.

    67      	*

    68      	* @param aRequestId identifies the request to be cancelled.

    69      	*        Returned earlier from TransactionOwnerL.

    70 	 	*/    

    71     	virtual void Cancel (TUint32 aRequestId) = 0;

    72     };

    73 

    74 #endif // MSIPREQUESTROUTER_H

    75 

    76 // End of File