epoc32/include/mw/sipreplytoheader.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        : sipreplytoheader.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 CSIPREPLYTOHEADER_H
    26 #define CSIPREPLYTOHEADER_H
    27 
    28 //  INCLUDES
    29 #include "sipaddressheaderbase.h"
    30 
    31 // FORWARD DECLARATIONS
    32 class CSIPAddress;
    33 class CSIPHeaderGenericParams;
    34 
    35 // CLASS DECLARATION
    36 /**
    37 * @publishedAll
    38 * @released
    39 *
    40 * Class provides functions for setting and getting parameters in SIP 
    41 * "Reply-To" header.
    42 *
    43 *  @lib sipcodec.lib
    44 */
    45 class CSIPReplyToHeader : public CSIPAddressHeaderBase
    46 	{
    47 	public:	// Constructors and destructor
    48 
    49 		/**
    50 		* Constructs a CSIPReplyToHeader from textual representation 
    51 		* of the header's value part.
    52 		* @param aValue a value part of a "Refer-To"-header 
    53 		*        (e.g. "User <user@host>")
    54 		* @return a new instance of CSIPReplyToHeader   
    55 		*/
    56 		IMPORT_C static CSIPReplyToHeader* DecodeL(const TDesC8& aValue);
    57 
    58 		/**
    59 		* Creates a new instance of CSIPReplyToHeader
    60 		* @pre aSIPAddress != 0
    61 		* @param aSIPAddress a name-address, the ownership is transferred.
    62 		* @return a new instance of CSIPReplyToHeader
    63 		*/
    64 		IMPORT_C static CSIPReplyToHeader* NewL(CSIPAddress* aSIPAddress);
    65 
    66 		/**
    67 		* Creates a new instance of CSIPReplyToHeader and puts it to CleanupStack
    68 		* @pre aSIPAddress != 0
    69 		* @param aSIPAddress a name-address, the ownership is transferred,
    70 		* @return a new instance of CSIPReplyToHeader
    71 		*/
    72 		IMPORT_C static CSIPReplyToHeader* NewLC(CSIPAddress* aSIPAddress);
    73 
    74 		/**
    75 		* Destructor, deletes the resources of CSIPReplyToHeader.
    76 		*/
    77 		IMPORT_C virtual ~CSIPReplyToHeader();
    78 
    79 
    80 	public: // New functions
    81 
    82 		/**
    83 		* Constructs an instance of a CSIPReplyToHeader 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 CSIPReplyToHeader
    87 		*/
    88 		IMPORT_C static CSIPHeaderBase* 
    89             InternalizeValueL(RReadStream& aReadStream);
    90 
    91 
    92 	public: // From CSIPHeaderBase
    93 
    94 		/**
    95 		* From CSIPHeaderBase CloneL
    96 		*/
    97 		IMPORT_C CSIPHeaderBase* CloneL() const;
    98 
    99 		/**
   100 		* From CSIPHeaderBase Name
   101 		*/
   102 		IMPORT_C RStringF Name() const;
   103 
   104 
   105 	public: // From CSIPHeaderBase, for internal use
   106 
   107         /**
   108         * @internalComponent
   109         */
   110 		TPreferredPlace PreferredPlaceInMessage() const;
   111 
   112 	public: // New functions, for internal use
   113 
   114 		static RPointerArray<CSIPHeaderBase> BaseDecodeL(const TDesC8& aValue);
   115 
   116 	private: // Constructors
   117 
   118 		CSIPReplyToHeader();
   119 
   120 	private: // For testing purposes
   121 #ifdef CPPUNIT_TEST	
   122 		friend class CSIPReplyToHeaderTest;
   123 #endif
   124 	};
   125 
   126 #endif // end of CSIPREPLYTOHEADER_H
   127 
   128 // End of File