1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/epoc32/include/mw/sipsupportedheader.h Wed Mar 31 12:27:01 2010 +0100
1.3 @@ -0,0 +1,133 @@
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 : sipsupportedheader.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 CSIPSUPPORTEDHEADER_H
1.29 +#define CSIPSUPPORTEDHEADER_H
1.30 +
1.31 +// INCLUDES
1.32 +#include "siptokenheaderbase.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 "Supported" header.
1.41 +*
1.42 +* @lib sipcodec.lib
1.43 +*/
1.44 +class CSIPSupportedHeader : public CSIPTokenHeaderBase
1.45 + {
1.46 + public: // Constructors and destructor
1.47 +
1.48 + /**
1.49 + * Constructs a CSIPSupportedHeader from textual representation
1.50 + * of the header's value part.
1.51 + * @param aValue a value part of a "Supported"-header
1.52 + * @return an array containing 1..n instances of CSIPSupportedHeader
1.53 + */
1.54 + IMPORT_C static RPointerArray<CSIPSupportedHeader>
1.55 + DecodeL(const TDesC8& aValue);
1.56 +
1.57 + /**
1.58 + * Creates a new instance of CSIPSupportedHeader
1.59 + * @param aValue a tag value
1.60 + * @return a new instance of CSIPSupportedHeader
1.61 + */
1.62 + IMPORT_C static CSIPSupportedHeader* NewL(RStringF aValue);
1.63 +
1.64 + /**
1.65 + * Creates a new instance of CSIPSupportedHeader
1.66 + * and puts it to CleanupStack
1.67 + * @param aValue a tag value
1.68 + * @return a new instance of CSIPSupportedHeader
1.69 + */
1.70 + IMPORT_C static CSIPSupportedHeader* NewLC(RStringF aValue);
1.71 +
1.72 + /**
1.73 + * Destructor, deletes the resources of CSIPSupportedHeader.
1.74 + */
1.75 + IMPORT_C ~CSIPSupportedHeader();
1.76 +
1.77 +
1.78 + public: // New functions
1.79 +
1.80 + /**
1.81 + * Constructs an instance of a CSIPSupportedHeader from a RReadStream
1.82 + * @param aReadStream a stream containing the value of the
1.83 + * externalized object (header name not included).
1.84 + * @return an instance of a CSIPSupportedHeader
1.85 + */
1.86 + IMPORT_C static CSIPHeaderBase*
1.87 + InternalizeValueL(RReadStream& aReadStream);
1.88 +
1.89 +
1.90 + public: // From CSIPHeaderBase
1.91 +
1.92 + /**
1.93 + * From CSIPHeaderBase CloneL
1.94 + */
1.95 + IMPORT_C CSIPHeaderBase* CloneL() const;
1.96 +
1.97 + /**
1.98 + * From CSIPHeaderBase Name
1.99 + */
1.100 + IMPORT_C RStringF Name() const;
1.101 +
1.102 +
1.103 + public: // From CSIPHeaderBase, for internal use
1.104 +
1.105 + /**
1.106 + * @internalComponent
1.107 + */
1.108 + TBool HasCompactName() const;
1.109 +
1.110 + /**
1.111 + * @internalComponent
1.112 + */
1.113 + RStringF CompactName() const;
1.114 +
1.115 + /**
1.116 + * @internalComponent
1.117 + */
1.118 + TPreferredPlace PreferredPlaceInMessage() const;
1.119 +
1.120 + public: // New functions, for internal use
1.121 +
1.122 + static RPointerArray<CSIPHeaderBase> BaseDecodeL(const TDesC8& aValue);
1.123 +
1.124 + private: // New functions
1.125 +
1.126 + CSIPSupportedHeader();
1.127 + CSIPSupportedHeader(const CSIPSupportedHeader& aHeader);
1.128 +
1.129 + private: // For testing purposes
1.130 +
1.131 + UNIT_TEST(CSIPSupportedHeaderTest)
1.132 + };
1.133 +
1.134 +#endif // CSIPSUPPORTEDHEADER_H
1.135 +
1.136 +// End of File