epoc32/include/mw/sipsecurityclientheader.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 3 e1b950c65cb4
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     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        : 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 
    31 // CLASS DECLARATION
    32 /**
    33 * @publishedAll
    34 * @released
    35 *
    36 * Class provides functions for setting and getting SIP "Security-Client"
    37 * header fields.
    38 *
    39 *  @lib sipcodec.lib
    40 */
    41 class CSIPSecurityClientHeader : public CSIPSecurityHeaderBase
    42 	{
    43 	public:	// Constructors and destructor
    44 
    45 		/**
    46 		* Constructs a CSIPSecurityClientHeader from textual representation
    47 		* of the header's value part.
    48 		* @param aValue a value part of a "Security-Client"-header
    49 		* @return an array containing 1..n instances of CSIPSecurityClientHeader
    50 		*/
    51 		IMPORT_C static RPointerArray<CSIPSecurityClientHeader> 
    52 			DecodeL(const TDesC8& aValue);
    53 
    54 		/**
    55 		* Creates a new instance of CSIPSecurityClientHeader
    56 		* @param aMechanism a Mechanism-Name parameter 
    57 		*        in the "Security-Client" header
    58 		* @return a new instance of CSIPSecurityClientHeader
    59 		*/
    60 		IMPORT_C static CSIPSecurityClientHeader* 
    61 			NewL(const TDesC8& aMechanism);
    62 
    63 		/**
    64 		* Creates a new instance of CSIPSecurityClientHeader 
    65 		* and puts it to CleanupStack
    66 		* @param aMechanism a Mechanism-Name parameter 
    67 		* in the "Security-Client" header
    68 		* @return a new instance of CSIPSecurityClientHeader
    69 		*/
    70 		IMPORT_C static CSIPSecurityClientHeader* 
    71 			NewLC(const TDesC8& aMechanism);
    72 
    73 		/**
    74 		* Destructor, deletes the resources of CSIPSecurityClientHeader.
    75 		*/
    76 		IMPORT_C ~CSIPSecurityClientHeader();
    77 
    78 
    79 	public: // New functions
    80 
    81 		/**
    82 		* Constructs an instance of a CSIPSecurityClientHeader 
    83 		* from a RReadStream
    84 		* @param aReadStream a stream containing the value of the
    85 		*        externalized object (header name not included). 
    86 		* @return an instance of a CSIPSecurityClientHeader
    87 		*/
    88 
    89 		IMPORT_C static CSIPHeaderBase* 
    90 			InternalizeValueL(RReadStream& aReadStream);
    91 
    92 
    93 	public: // From CSIPHeaderBase
    94 
    95 		/**
    96 		* From CSIPHeaderBase CloneL
    97 		*/
    98 		IMPORT_C CSIPHeaderBase* CloneL() const;
    99 
   100 		/**
   101 		* From CSIPHeaderBase Name
   102 		*/
   103 		IMPORT_C RStringF Name() const;
   104 
   105 
   106 	public: // New functions, for internal use
   107 
   108 		static RPointerArray<CSIPHeaderBase> BaseDecodeL(const TDesC8& aValue);
   109 
   110 	private: // New functions
   111 
   112 		CSIPSecurityClientHeader() ;
   113 
   114 	private: // For testing purposes
   115 #ifdef CPPUNIT_TEST	
   116 		friend class CSIPSecurityHeaderBaseTest;
   117 #endif
   118     };
   119 
   120 #endif // CSIPSECURITYCLIENTHEADER_H
   121 
   122 // End of File