1.1 --- a/epoc32/include/sipcallidheader.h Tue Nov 24 13:55:44 2009 +0000
1.2 +++ b/epoc32/include/sipcallidheader.h Tue Mar 16 16:12:26 2010 +0000
1.3 @@ -1,1 +1,140 @@
1.4 -sipcallidheader.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 : sipcallidheader.h
1.20 +* Part of : SIP Codec
1.21 +* Version : SIP/4.0
1.22 +*
1.23 +*/
1.24 +
1.25 +
1.26 +
1.27 +
1.28 +#ifndef CSIPCALLIDHEADER_H
1.29 +#define CSIPCALLIDHEADER_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 for a SIP Call-ID header.
1.41 +*
1.42 +* @lib sipcodec.lib
1.43 +*/
1.44 +class CSIPCallIDHeader : public CSIPHeaderBase
1.45 + {
1.46 + public: // Constructors and destructor
1.47 +
1.48 + /**
1.49 + * Constructs a CSIPCallIDHeader from textual representation
1.50 + * of the header's value part.
1.51 + * @param aValue a value part of a "Call-ID"-header (e.g. "ab2x@zb7y")
1.52 + * @returns a new instance of CSIPCallIDHeader
1.53 + */
1.54 + IMPORT_C static CSIPCallIDHeader* DecodeL(const TDesC8& aValue);
1.55 +
1.56 + /**
1.57 + * Destructor
1.58 + */
1.59 + IMPORT_C ~CSIPCallIDHeader ();
1.60 +
1.61 +
1.62 + public: // New functions
1.63 +
1.64 + /**
1.65 + * Compares this instance to another "Call-ID" header object
1.66 + * @param aCallIDHeader a header to compare to
1.67 + * @returns ETrue if "Call-ID" headers are similar
1.68 + */
1.69 + IMPORT_C TBool operator==(const CSIPCallIDHeader& aCallIDHeader);
1.70 +
1.71 + /**
1.72 + * Constructs an instance of a CSIPCallIDHeader from a RReadStream
1.73 + * @param aReadStream a stream containing the value of the
1.74 + * externalized object (header name not included).
1.75 + * @return an instance of a CSIPCallIDHeader
1.76 + */
1.77 + IMPORT_C static CSIPHeaderBase*
1.78 + InternalizeValueL(RReadStream& aReadStream);
1.79 +
1.80 +
1.81 + public: // From CSIPHeaderBase
1.82 +
1.83 + /**
1.84 + * From CSIPHeaderBase CloneL
1.85 + */
1.86 + IMPORT_C CSIPHeaderBase* CloneL() const;
1.87 +
1.88 + /**
1.89 + * From CSIPHeaderBase Name
1.90 + */
1.91 + IMPORT_C RStringF Name() const;
1.92 +
1.93 + /**
1.94 + * From CSIPHeaderBase ToTextValueL
1.95 + */
1.96 + IMPORT_C HBufC8* ToTextValueL() const;
1.97 +
1.98 +
1.99 + public: // From CSIPHeaderBase, for internal use
1.100 +
1.101 + /**
1.102 + * @internalComponent
1.103 + */
1.104 + TBool HasCompactName() const;
1.105 +
1.106 + /**
1.107 + * @internalComponent
1.108 + */
1.109 + RStringF CompactName() const;
1.110 +
1.111 + /**
1.112 + * @internalComponent
1.113 + */
1.114 + TPreferredPlace PreferredPlaceInMessage() const;
1.115 +
1.116 + public: // New functions, for internal use
1.117 +
1.118 + static RPointerArray<CSIPHeaderBase> BaseDecodeL(const TDesC8& aValue);
1.119 +
1.120 + private: // From CSIPHeaderBase
1.121 +
1.122 + void ExternalizeValueL (RWriteStream& aWriteStream) const;
1.123 +
1.124 + private: // Constructors
1.125 +
1.126 + CSIPCallIDHeader();
1.127 +
1.128 + private: // New functions
1.129 +
1.130 + void ParseL(const TDesC8& aValue);
1.131 +
1.132 + private: // Data
1.133 +
1.134 + HBufC8* iCallID;
1.135 +
1.136 + private: // For testing purposes
1.137 +
1.138 + UNIT_TEST(CSIPCallIDHeaderTest)
1.139 + };
1.140 +
1.141 +
1.142 +#endif // end of CSIPCALLIDHEADER_H
1.143 +
1.144 +// End of File