1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/mw/siptoheader.h	Wed Mar 31 12:27:01 2010 +0100
     1.3 @@ -0,0 +1,140 @@
     1.4 +/*
     1.5 +* Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.6 +* All rights reserved.
     1.7 +* This component and the accompanying materials are made available
     1.8 +* 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
     1.9 +* which accompanies this distribution, and is available
    1.10 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.11 +*
    1.12 +* Initial Contributors:
    1.13 +* Nokia Corporation - initial contribution.
    1.14 +*
    1.15 +* Contributors:
    1.16 +*
    1.17 +* Description:
    1.18 +* Name        : siptoheader.h
    1.19 +* Part of     : SIP Codec
    1.20 +* Interface   : SDK API, SIP Codec API
    1.21 +* Version     : SIP/4.0 
    1.22 +*
    1.23 +*/
    1.24 +
    1.25 +
    1.26 +
    1.27 +
    1.28 +#ifndef CSIPTOHEADER_H
    1.29 +#define CSIPTOHEADER_H
    1.30 +
    1.31 +//  INCLUDES
    1.32 +#include "sipfromtoheaderbase.h"
    1.33 +#include "_sipcodecdefs.h"
    1.34 +
    1.35 +// CLASS DECLARATION
    1.36 +/**
    1.37 +* @publishedAll
    1.38 +* @released
    1.39 +*
    1.40 +* Class provides functions for setting and getting SIP "To" header fields.
    1.41 +*
    1.42 +* @lib sipcodec.lib
    1.43 +*/
    1.44 +class CSIPToHeader : public CSIPFromToHeaderBase
    1.45 +	{
    1.46 +	public:	// Constructors and destructor
    1.47 +
    1.48 +		/**
    1.49 +		* Constructs a CSIPToHeader from textual representation 
    1.50 +		* of the header's value part.
    1.51 +		* @param aValue a value part of a "To"-header (e.g. "User <user@host>")
    1.52 +		* @return a new instance of CSIPToHeader 
    1.53 +		*/
    1.54 +		IMPORT_C static CSIPToHeader* DecodeL(const TDesC8& aValue);
    1.55 +
    1.56 +		/**
    1.57 +		* Creates a new instance of CSIPToHeader
    1.58 +		* @pre aSIPAddress != 0
    1.59 +		* @param aSIPAddress a name-address, the ownership is transferred,
    1.60 +		* @return a new instance of CSIPToHeader
    1.61 +		*/
    1.62 +		IMPORT_C static CSIPToHeader* NewL(CSIPAddress* aSIPAddress);
    1.63 +
    1.64 +		/**
    1.65 +		* Creates a new instance of CSIPToHeader and puts it to CleanupStack
    1.66 +		* @pre aSIPAddress != 0
    1.67 +		* @param aSIPAddress a name-address, the ownership is transferred,
    1.68 +		* @return a new instance of CSIPToHeader
    1.69 +		*/
    1.70 +		IMPORT_C static CSIPToHeader* NewLC(CSIPAddress* aSIPAddress);
    1.71 +
    1.72 +		/**
    1.73 +		* Creates a deep-copy of a CSIPFromToHeaderBase
    1.74 +		* Note that this function can be used for creating a To-header
    1.75 +		* using an existing From-header.
    1.76 +		* @param aHeader CSIPFromToHeaderBase to be copied
    1.77 +		* @return a new instance of CSIPToHeader
    1.78 +		*/
    1.79 +
    1.80 +		IMPORT_C static CSIPToHeader* 
    1.81 +			NewL(const CSIPFromToHeaderBase& aHeader);
    1.82 +
    1.83 +		/**
    1.84 +		* Creates a deep-copy of a CSIPFromToHeaderBase and 
    1.85 +		* puts it to CleanupStack
    1.86 +		* Note that this function can be used for creating a To-header
    1.87 +		* using an existing From-header.
    1.88 +		* @param aHeader CSIPFromToHeaderBaseto to be copied
    1.89 +		* @return a new instance of CSIPToHeader
    1.90 +		*/
    1.91 +		IMPORT_C static CSIPToHeader* 
    1.92 +			NewLC(const CSIPFromToHeaderBase& aHeader);
    1.93 +
    1.94 +		/**
    1.95 +		* Destructor, deletes the resources of CSIPToHeader.
    1.96 +		*/
    1.97 +		IMPORT_C ~CSIPToHeader();
    1.98 +
    1.99 +
   1.100 +	public: // New functions
   1.101 +
   1.102 +		/**
   1.103 +		* Constructs an instance of a CSIPToHeader from a RReadStream
   1.104 +		* @param aReadStream a stream containing the value of the
   1.105 +		*        externalized object (header name not included). 
   1.106 +		* @return an instance of a CSIPToHeader
   1.107 +		*/
   1.108 +		IMPORT_C static CSIPHeaderBase* 
   1.109 +			InternalizeValueL(RReadStream& aReadStream);
   1.110 +
   1.111 +
   1.112 +	public: // From CSIPHeaderBase
   1.113 +		
   1.114 +		/**
   1.115 +		* From CSIPHeaderBase CloneL
   1.116 +		*/
   1.117 +		IMPORT_C CSIPHeaderBase* CloneL() const;
   1.118 +
   1.119 +		/**
   1.120 +		* From CSIPHeaderBase Name
   1.121 +		*/
   1.122 +		IMPORT_C RStringF Name() const;
   1.123 +
   1.124 +
   1.125 +	public: // From CSIPHeaderBase, for internal use
   1.126 +
   1.127 +        /**
   1.128 +        * @internalComponent
   1.129 +        */
   1.130 +		RStringF CompactName() const;
   1.131 +
   1.132 +	public: // New functions, for internal use
   1.133 +
   1.134 +		static RPointerArray<CSIPHeaderBase> BaseDecodeL(const TDesC8& aValue);
   1.135 +
   1.136 +	private: // Constructors
   1.137 +
   1.138 +		CSIPToHeader();
   1.139 +	};
   1.140 +
   1.141 +#endif // CSIPTOHEADER_H
   1.142 +
   1.143 +// End of File