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