epoc32/include/siprouteheader.h
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
     1.1 --- a/epoc32/include/siprouteheader.h	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/siprouteheader.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,122 @@
     1.4 -siprouteheader.h
     1.5 +/*
     1.6 +* Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.7 +* All rights reserved.
     1.8 +* This component and the accompanying materials are made available
     1.9 +* 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.10 +* which accompanies this distribution, and is available
    1.11 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.12 +*
    1.13 +* Initial Contributors:
    1.14 +* Nokia Corporation - initial contribution.
    1.15 +*
    1.16 +* Contributors:
    1.17 +*
    1.18 +* Description:
    1.19 +* Name        : siprouteheader.h
    1.20 +* Part of     : SIP Codec
    1.21 +* Interface   : SDK API, SIP Codec API
    1.22 +* Version     : SIP/4.0 
    1.23 +*
    1.24 +*/
    1.25 +
    1.26 +
    1.27 +
    1.28 +
    1.29 +#ifndef CSIPROUTEHEADER_H
    1.30 +#define CSIPROUTEHEADER_H
    1.31 +
    1.32 +//  INCLUDES
    1.33 +#include "siprouteheaderbase.h"
    1.34 +#include "_sipcodecdefs.h"
    1.35 +
    1.36 +// CLASS DECLARATION
    1.37 +/**
    1.38 +* @publishedAll
    1.39 +* @released
    1.40 +*
    1.41 +* Class for SIP "Route"-header manipulation.
    1.42 +*
    1.43 +*  @lib sipcodec.lib
    1.44 +*/
    1.45 +class CSIPRouteHeader : public CSIPRouteHeaderBase
    1.46 +	{
    1.47 +	public:	// Constructors and destructor
    1.48 +
    1.49 +		/**
    1.50 +		* Constructs a CSIPRouteHeader from textual representation 
    1.51 +		* of the header's value part.
    1.52 +		* @param aValue a value part of a "Route"-header
    1.53 +		* @return an array containing one to many instances of CSIPRouteHeader
    1.54 +		*/
    1.55 +		IMPORT_C static RPointerArray<CSIPRouteHeader> 
    1.56 +			DecodeL(const TDesC8& aValue);
    1.57 +
    1.58 +		/**
    1.59 +		* Creates a new instance of CSIPRouteHeader
    1.60 +		* @pre aSIPAddress != 0
    1.61 +		* @param aSIPAddress a name-address, the ownership is transferred 
    1.62 +		* @return a new instance of CSIPRouteHeader
    1.63 +		*/
    1.64 +		IMPORT_C static CSIPRouteHeader* NewL(CSIPAddress* aSIPAddress);
    1.65 +
    1.66 +		/**
    1.67 +		* Creates a new instance of CSIPRouteHeader and puts it to CleanupStack
    1.68 +		* @pre aSIPAddress != 0
    1.69 +		* @pre aSIPAddress->Address().HostPort().HasHost() == ETrue
    1.70 +		* @param aSIPAddress a name-address, the ownership is transferred 
    1.71 +		* @return a new instance of CSIPRouteHeader
    1.72 +		*/
    1.73 +		IMPORT_C static CSIPRouteHeader* NewLC(CSIPAddress* aSIPAddress);
    1.74 +
    1.75 +		/**
    1.76 +		* Destructor, deletes the resources of CSIPRouteHeader.
    1.77 +		*/
    1.78 +		IMPORT_C ~CSIPRouteHeader();
    1.79 +
    1.80 +
    1.81 +	public: // New functions
    1.82 +
    1.83 +		/**
    1.84 +		* Constructs an instance of a CCSIPRouteHeader from a RReadStream
    1.85 +		* @param aReadStream a stream containing the value of the
    1.86 +		*        externalized object (header name not included). 
    1.87 +		* @return an instance of a CSIPRouteHeader
    1.88 +		*/
    1.89 +		IMPORT_C static CSIPHeaderBase* 
    1.90 +			InternalizeValueL(RReadStream& aReadStream);
    1.91 +
    1.92 +
    1.93 +	public: // From CSIPHeaderBase
    1.94 +		
    1.95 +		/**
    1.96 +		* From CSIPHeaderBase CloneL
    1.97 +		*/
    1.98 +		IMPORT_C CSIPHeaderBase* CloneL() const;
    1.99 +
   1.100 +		/**
   1.101 +		* From CSIPHeaderBase Name
   1.102 +		*/
   1.103 +		IMPORT_C RStringF Name() const;
   1.104 +
   1.105 +
   1.106 +	public: // New functions, for internal use
   1.107 +
   1.108 +		static RPointerArray<CSIPHeaderBase> BaseDecodeL(const TDesC8& aValue);
   1.109 +		static CSIPRouteHeader* NewL(const CSIPRouteHeaderBase& aHeader);		
   1.110 +
   1.111 +	private: // From CSIPHeaderbase
   1.112 +
   1.113 +		void ExternalizeValueL(RWriteStream& aWriteStream) const;
   1.114 +
   1.115 +	private: // Constructors
   1.116 +
   1.117 +		CSIPRouteHeader();
   1.118 +
   1.119 +	private: // New functions
   1.120 +
   1.121 +		void DoInternalizeValueL(RReadStream& aReadStream);
   1.122 +	};
   1.123 +
   1.124 +#endif // CSIPROUTEHEADER_H
   1.125 +
   1.126 +// End of File