1.1 --- a/epoc32/include/sipcseqheader.h Tue Mar 16 16:12:26 2010 +0000
1.2 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000
1.3 @@ -1,168 +0,0 @@
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 : sipcseqheader.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 CSIPCSEQHEADER_H
1.29 -#define CSIPCSEQHEADER_H
1.30 -
1.31 -// INCLUDES
1.32 -#include "sipheaderbase.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 sequence number and
1.41 -* method in SIP "CSeq" header.
1.42 -*
1.43 -* @lib sipcodec.lib
1.44 -*/
1.45 -class CSIPCSeqHeader : public CSIPHeaderBase
1.46 - {
1.47 - public: // Constructors and destructor
1.48 -
1.49 - /**
1.50 - * Constructs a CSIPCSeqHeader from textual representation
1.51 - * of the header's value part.
1.52 - * @param aValue a value part of a "CSeq"-header (e.g. "1 REGISTER")
1.53 - * @return a new instance of CSIPCSeqHeader.
1.54 - */
1.55 - IMPORT_C static CSIPCSeqHeader* DecodeL(const TDesC8& aValue);
1.56 -
1.57 - /**
1.58 - * Creates a new instance of CSIPCSeqHeader
1.59 - * @param aSeq a sequence number to set.
1.60 - * @param aMethod a method to set. For example "REGISTER"
1.61 - * @return a new instance of CSIPCSeqHeader
1.62 - */
1.63 - IMPORT_C static CSIPCSeqHeader* NewL(TUint aSeq, RStringF aMethod);
1.64 -
1.65 - /**
1.66 - * Creates a new instance of CSIPCSeqHeader and puts it to CleanupStack
1.67 - * @param aSeq a sequence number to set.
1.68 - * @param aMethod a method to set. For example "REGISTER"
1.69 - * @return a new instance of CSIPCSeqHeader
1.70 - */
1.71 - IMPORT_C static CSIPCSeqHeader* NewLC(TUint aSeq, RStringF aMethod);
1.72 -
1.73 - /**
1.74 - * Destructor, deletes the resources of CSIPCSeqHeader.
1.75 - */
1.76 - IMPORT_C ~CSIPCSeqHeader();
1.77 -
1.78 -
1.79 - public: // New functions
1.80 -
1.81 - /**
1.82 - * Gets the sequence number from the "CSeq" header
1.83 - * @return the current sequence number
1.84 - */
1.85 - IMPORT_C TUint Seq() const;
1.86 -
1.87 - /**
1.88 - * Sets the sequence number in the "CSeq" header
1.89 - * @param aSeq a sequence number to set
1.90 - */
1.91 - IMPORT_C void SetSeq(TUint aSeq);
1.92 -
1.93 - /**
1.94 - * Gets the method from the "CSeq" header
1.95 - * @return the method
1.96 - */
1.97 - IMPORT_C RStringF Method() const;
1.98 -
1.99 - /**
1.100 - * Sets the method in the "CSeq" header
1.101 - * @param aMethod a method to set
1.102 - */
1.103 - IMPORT_C void SetMethodL(RStringF aMethod);
1.104 -
1.105 - /**
1.106 - * Constructs an instance of a CSIPCSeqHeader from a RReadStream
1.107 - * @param aReadStream a stream containing the value of the
1.108 - * externalized object (header name not included).
1.109 - * @return an instance of a CSIPCSeqHeader
1.110 - */
1.111 - IMPORT_C static CSIPHeaderBase*
1.112 - InternalizeValueL(RReadStream& aReadStream);
1.113 -
1.114 -
1.115 - public: // From CSIPHeaderBase
1.116 -
1.117 - /**
1.118 - * From CSIPHeaderBase CloneL
1.119 - */
1.120 - IMPORT_C CSIPHeaderBase* CloneL() const;
1.121 -
1.122 - /**
1.123 - * From CSIPHeaderBase Name
1.124 - */
1.125 - IMPORT_C RStringF Name() const;
1.126 -
1.127 - /**
1.128 - * From CSIPHeaderBase ToTextValueL
1.129 - */
1.130 - IMPORT_C HBufC8* ToTextValueL() const;
1.131 -
1.132 -
1.133 - public: // From CSIPHeaderBase, for internal use
1.134 -
1.135 - /**
1.136 - * @internalComponent
1.137 - */
1.138 - TPreferredPlace PreferredPlaceInMessage () const;
1.139 -
1.140 - public: // New functions, for internal use
1.141 -
1.142 - static RPointerArray<CSIPHeaderBase> BaseDecodeL(const TDesC8& aValue);
1.143 -
1.144 - private: // From CSIPHeaderBase
1.145 -
1.146 - void ExternalizeValueL (RWriteStream& aWriteStream) const;
1.147 -
1.148 - private: // Constructors
1.149 -
1.150 - CSIPCSeqHeader();
1.151 - void ConstructL(TUint aCSeq, RStringF aMethod);
1.152 -
1.153 - private: // New functions
1.154 -
1.155 - void DoInternalizeValueL(RReadStream& aReadStream);
1.156 - void ParseL(const TDesC8& aValue);
1.157 - void SetMethodL(const TDesC8& aMethod);
1.158 -
1.159 - private: // Data
1.160 -
1.161 - TUint iSeq;
1.162 - RStringF iMethod;
1.163 -
1.164 - private: // For testing purposes
1.165 -
1.166 - UNIT_TEST(CSIPCSeqHeaderTest)
1.167 - };
1.168 -
1.169 -#endif // CSIPCSEQHEADER_H
1.170 -
1.171 -// End of File