realtimenetprots/sipfw/SIP/Codec/inc/sipsecurityverifyheader.h
changeset 0 307788aac0a8
equal deleted inserted replaced
-1:000000000000 0:307788aac0a8
       
     1 /*
       
     2 * Copyright (c) 2004-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          : sipsecurityverifyheader.h
       
    16 * Part of       : SIP Codec
       
    17 * Version       : SIP/4.0 
       
    18 *
       
    19 */
       
    20 
       
    21 
       
    22 
       
    23 
       
    24 /**
       
    25  @internalComponent
       
    26 */
       
    27 
       
    28 
       
    29 #ifndef CSIPSECURITYVERIFYHEADER_H
       
    30 #define CSIPSECURITYVERIFYHEADER_H
       
    31 
       
    32 //  INCLUDES
       
    33 #include "sipsecurityheaderbase.h"
       
    34 #include "_sipcodecdefs.h"
       
    35 
       
    36 // CLASS DECLARATION
       
    37 /**
       
    38 * Class for a SIP Security-Verify header.
       
    39 *
       
    40 * @lib sipcodec.lib
       
    41 */
       
    42 class CSIPSecurityVerifyHeader : public CSIPSecurityHeaderBase
       
    43 	{
       
    44 	public:	// Constructors and destructor
       
    45 
       
    46 		/**
       
    47 		* Constructs a CSIPSecurityVerifyHeader from textual representation 
       
    48 		* of the header's value part.
       
    49 		* @param aValue a value part of a "Security-Server"-header
       
    50 		* @return an array containing 1..n instances of 
       
    51 		* CSIPSecurityVerifyHeader
       
    52 		*/
       
    53 		IMPORT_C static RPointerArray<CSIPSecurityVerifyHeader> 
       
    54 			DecodeL(const TDesC8& aValue);
       
    55 
       
    56 		/**
       
    57 		* Creates a new instance of CSIPSecurityVerifyHeader
       
    58 		* @param aMechanism a Mechanism-Name parameter 
       
    59 		* in the "Security-Server" header
       
    60 		* @return a new instance of CSIPSecurityVerifyHeader
       
    61 		*/
       
    62 		IMPORT_C static CSIPSecurityVerifyHeader* 
       
    63 			NewL(const TDesC8& aMechanism);
       
    64 
       
    65 		/**
       
    66 		* Creates a new instance of CSIPSecurityVerifyHeader 
       
    67 		* and puts it to CleanupStack
       
    68 		* @param aMechanism a Mechanism-Name parameter 
       
    69 		* in the "Security-Server" header
       
    70 		* @return a new instance of CSIPSecurityVerifyHeader
       
    71 		*/
       
    72 		IMPORT_C static CSIPSecurityVerifyHeader* 
       
    73 			NewLC(const TDesC8& aMechanism);
       
    74 
       
    75         /**
       
    76 	    * Creates a deep copy of the given CSIPSecurityHeaderBase
       
    77 	    * @param aHeader to be copied
       
    78 	    * @returns a new instance of CSIPSecurityVerifyHeader
       
    79 	    */
       
    80 	    IMPORT_C static CSIPSecurityVerifyHeader* NewL(const
       
    81             CSIPSecurityHeaderBase& aHeader);
       
    82 
       
    83 	    /**
       
    84 	    * Creates a deep copy of the given CSIPSecurityHeaderBase and
       
    85 	    * puts it to CleanupStack
       
    86 	    * @param aHeader to be copied
       
    87 	    * @return a new instance of CSIPSecurityVerifyHeader
       
    88 	    */
       
    89 	    IMPORT_C static CSIPSecurityVerifyHeader* NewLC(const
       
    90             CSIPSecurityHeaderBase& aHeader);
       
    91 
       
    92 		/**
       
    93 		* Destructor, deletes the resources of CSIPSecurityVerifyHeader.
       
    94 		*/
       
    95 		IMPORT_C ~CSIPSecurityVerifyHeader();
       
    96 
       
    97 
       
    98 	public: // From CSIPHeaderBase
       
    99 
       
   100 		/**
       
   101 		* From CSIPHeaderBase CloneL
       
   102 		*/
       
   103 		IMPORT_C CSIPHeaderBase* CloneL() const;
       
   104 		
       
   105 		/**
       
   106 		* From CSIPHeaderBase Name
       
   107 		*/		
       
   108 		IMPORT_C RStringF Name() const;
       
   109 
       
   110 	public: // New functions, for internal use
       
   111 
       
   112 		static RPointerArray<CSIPHeaderBase> BaseDecodeL(const TDesC8& aValue);
       
   113 
       
   114 	private: // Constructors
       
   115 
       
   116 		CSIPSecurityVerifyHeader();
       
   117 
       
   118 	private: // For testing purposes
       
   119 	
       
   120 		UNIT_TEST(CSIPSecurityHeaderBaseTest)
       
   121     };
       
   122 
       
   123 #endif // CSIPSECURITYVERIFYHEADER_H
       
   124 
       
   125 // End of File