realtimenetprots/sipfw/SIP/Transaction/src/ClearProxy.h
changeset 0 307788aac0a8
equal deleted inserted replaced
-1:000000000000 0:307788aac0a8
       
     1 /*
       
     2 * Copyright (c) 2006-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          : ClearProxy.h
       
    16 * Part of       : Transaction
       
    17 * Version       : SIP/5.0
       
    18 *
       
    19 */
       
    20 
       
    21 
       
    22 
       
    23 #ifndef CLEARPROXY_H
       
    24 #define CLEARPROXY_H
       
    25 
       
    26 // INCLUDES
       
    27 #include <e32base.h>
       
    28 
       
    29 // FORWARD DECLARATIONS
       
    30 class CClientTransaction;
       
    31 
       
    32 // CLASS DECLARATION
       
    33 /**
       
    34  * This class is used for removing an outbound proxy URI from a client
       
    35  * transaction.
       
    36  */
       
    37 class TClearProxy
       
    38 	{
       
    39 public: // Constructor
       
    40 	/**
       
    41 	 * Constructor
       
    42 	 *
       
    43 	 * @param aTransaction Client transaction
       
    44 	 */
       
    45 	TClearProxy(CClientTransaction& aTransaction);
       
    46 
       
    47 public: // New functions
       
    48 
       
    49     /**
       
    50 	 * Returns a TCleanupItem which can be pushed into CleanupStack.
       
    51 	 *
       
    52      * @return TCleanupItem
       
    53 	 */
       
    54 	TCleanupItem CleanupItem();
       
    55 
       
    56     /**
       
    57 	 * When CleanupStack destroys the TCleanupItem, this function is called.
       
    58      * Clears the outbound proxy from client transaction.
       
    59 	 *
       
    60 	 * @pre aItem != NULL
       
    61 	 *
       
    62 	 * @param aItem Pointer to a TClearProxy containing the information
       
    63 	 *	required to clear outbound proxy.
       
    64 	 */
       
    65 	static void ClearOutboundProxy(TAny* aItem);
       
    66 
       
    67 private: // Data
       
    68 
       
    69 	CClientTransaction& iTransaction;    
       
    70 	};
       
    71 
       
    72 #endif // end of CLEARPROXY_H
       
    73 
       
    74 // End of File