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