epoc32/include/sipsecurityclientheader.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
permissions -rw-r--r--
Final list of Symbian^2 public API header files
     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 the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     6 * which accompanies this distribution, and is available
     7 * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     8 *
     9 * Initial Contributors:
    10 * Nokia Corporation - initial contribution.
    11 *
    12 * Contributors:
    13 *
    14 * Description:
    15 * Name        : sipsecurityclientheader.h
    16 * Part of     : SIP Codec
    17 * Interface   : SDK API, SIP Codec API
    18 * Version     : SIP/4.0 
    19 *
    20 */
    21 
    22 
    23 
    24 
    25 #ifndef CSIPSECURITYCLIENTHEADER_H
    26 #define CSIPSECURITYCLIENTHEADER_H
    27 
    28 //  INCLUDES
    29 #include "sipsecurityheaderbase.h"
    30 #include "_sipcodecdefs.h"
    31 
    32 // CLASS DECLARATION
    33 /**
    34 * @publishedAll
    35 * @released
    36 *
    37 * Class provides functions for setting and getting SIP "Security-Client"
    38 * header fields.
    39 *
    40 *  @lib sipcodec.lib
    41 */
    42 class CSIPSecurityClientHeader : public CSIPSecurityHeaderBase
    43 	{
    44 	public:	// Constructors and destructor
    45 
    46 		/**
    47 		* Constructs a CSIPSecurityClientHeader from textual representation
    48 		* of the header's value part.
    49 		* @param aValue a value part of a "Security-Client"-header
    50 		* @return an array containing 1..n instances of CSIPSecurityClientHeader
    51 		*/
    52 		IMPORT_C static RPointerArray<CSIPSecurityClientHeader> 
    53 			DecodeL(const TDesC8& aValue);
    54 
    55 		/**
    56 		* Creates a new instance of CSIPSecurityClientHeader
    57 		* @param aMechanism a Mechanism-Name parameter 
    58 		*        in the "Security-Client" header
    59 		* @return a new instance of CSIPSecurityClientHeader
    60 		*/
    61 		IMPORT_C static CSIPSecurityClientHeader* 
    62 			NewL(const TDesC8& aMechanism);
    63 
    64 		/**
    65 		* Creates a new instance of CSIPSecurityClientHeader 
    66 		* and puts it to CleanupStack
    67 		* @param aMechanism a Mechanism-Name parameter 
    68 		* in the "Security-Client" header
    69 		* @return a new instance of CSIPSecurityClientHeader
    70 		*/
    71 		IMPORT_C static CSIPSecurityClientHeader* 
    72 			NewLC(const TDesC8& aMechanism);
    73 
    74 		/**
    75 		* Destructor, deletes the resources of CSIPSecurityClientHeader.
    76 		*/
    77 		IMPORT_C ~CSIPSecurityClientHeader();
    78 
    79 
    80 	public: // New functions
    81 
    82 		/**
    83 		* Constructs an instance of a CSIPSecurityClientHeader 
    84 		* from a RReadStream
    85 		* @param aReadStream a stream containing the value of the
    86 		*        externalized object (header name not included). 
    87 		* @return an instance of a CSIPSecurityClientHeader
    88 		*/
    89 
    90 		IMPORT_C static CSIPHeaderBase* 
    91 			InternalizeValueL(RReadStream& aReadStream);
    92 
    93 
    94 	public: // From CSIPHeaderBase
    95 
    96 		/**
    97 		* From CSIPHeaderBase CloneL
    98 		*/
    99 		IMPORT_C CSIPHeaderBase* CloneL() const;
   100 
   101 		/**
   102 		* From CSIPHeaderBase Name
   103 		*/
   104 		IMPORT_C RStringF Name() const;
   105 
   106 
   107 	public: // New functions, for internal use
   108 
   109 		static RPointerArray<CSIPHeaderBase> BaseDecodeL(const TDesC8& aValue);
   110 
   111 	private: // New functions
   112 
   113 		CSIPSecurityClientHeader() ;
   114 
   115 	private: // For testing purposes
   116 	
   117 		UNIT_TEST(CSIPSecurityHeaderBaseTest)
   118     };
   119 
   120 #endif // CSIPSECURITYCLIENTHEADER_H
   121 
   122 // End of File