1.1 --- a/epoc32/include/sipfromheader.h Tue Nov 24 13:55:44 2009 +0000
1.2 +++ b/epoc32/include/sipfromheader.h Tue Mar 16 16:12:26 2010 +0000
1.3 @@ -1,1 +1,139 @@
1.4 -sipfromheader.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 : sipfromheader.h
1.20 +* Part of : SIP Codec
1.21 +* Interface : SDK API, SIP Codec API
1.22 +* Version : SIP/4.0
1.23 +*
1.24 +*/
1.25 +
1.26 +
1.27 +
1.28 +
1.29 +#ifndef CSIPFROMHEADER_H
1.30 +#define CSIPFROMHEADER_H
1.31 +
1.32 +// INCLUDES
1.33 +#include "sipfromtoheaderbase.h"
1.34 +#include "_sipcodecdefs.h"
1.35 +
1.36 +// CLASS DECLARATION
1.37 +/**
1.38 +* @publishedAll
1.39 +* @released
1.40 +*
1.41 +* Class provides functions for setting and getting SIP "From" header.
1.42 +*
1.43 +* @lib sipcodec.lib
1.44 +*/
1.45 +class CSIPFromHeader : public CSIPFromToHeaderBase
1.46 + {
1.47 + public: // Constructors and destructor
1.48 +
1.49 + /**
1.50 + * Constructs a CSIPFromHeader from textual representation
1.51 + * of the header's value part.
1.52 + * @param aValue a value part of a "From"-header (e.g. "<user@host>...")
1.53 + * @return a new instance of CSIPFromHeader
1.54 + */
1.55 + IMPORT_C static CSIPFromHeader* DecodeL(const TDesC8& aValue);
1.56 +
1.57 + /**
1.58 + * Creates a new instance of CSIPFromHeader
1.59 + * @pre aSIPAddress != 0
1.60 + * @param aSIPAddress a name-address, the ownership is transferred.
1.61 + * @return a new instance of CSIPFromHeader
1.62 + */
1.63 + IMPORT_C static CSIPFromHeader* NewL(CSIPAddress* aSIPAddress);
1.64 +
1.65 + /**
1.66 + * Creates a new instance of CSIPFromHeader and puts it to CleanupStack
1.67 + * @pre aSIPAddress != 0
1.68 + * @param aSIPAddress a name-address, the ownership is transferred,
1.69 + * @return a new instance of CSIPFromHeader
1.70 + */
1.71 + IMPORT_C static CSIPFromHeader* NewLC(CSIPAddress* aSIPAddress);
1.72 +
1.73 + /**
1.74 + * Creates a deep-copy of a CSIPFromToHeaderBase
1.75 + * Note that this function can be used for creating a From-header
1.76 + * using an existing To-header.
1.77 + * @param aHeader CSIPFromToHeaderBase to be copied
1.78 + * @return a new instance of CSIPFromHeader
1.79 + */
1.80 + IMPORT_C static CSIPFromHeader*
1.81 + NewL(const CSIPFromToHeaderBase& aHeader);
1.82 +
1.83 + /**
1.84 + * Creates a deep-copy of a CSIPFromToHeaderBase and
1.85 + * puts it to CleanupStack
1.86 + * Note that this function can be used for creating a From-header
1.87 + * using an existing To-header.
1.88 + * @param aHeader CSIPFromToHeaderBase to be copied
1.89 + * @return a new instance of CSIPFromHeader
1.90 + */
1.91 + IMPORT_C static CSIPFromHeader*
1.92 + NewLC(const CSIPFromToHeaderBase& aHeader);
1.93 +
1.94 + /**
1.95 + * Destructor, deletes the resources of CSIPFromHeader.
1.96 + */
1.97 + IMPORT_C ~CSIPFromHeader();
1.98 +
1.99 +
1.100 + public: // New functions
1.101 +
1.102 + /**
1.103 + * Constructs an instance of a CSIPFromHeader from a RReadStream
1.104 + * @param aReadStream a stream containing the value of the
1.105 + * externalized object (header name not included).
1.106 + * @return an instance of a CSIPFromHeader
1.107 + */
1.108 + IMPORT_C static CSIPHeaderBase*
1.109 + InternalizeValueL(RReadStream& aReadStream);
1.110 +
1.111 +
1.112 + public: // From CSIPHeaderBase
1.113 +
1.114 + /**
1.115 + * From CSIPHeaderBase CloneL
1.116 + */
1.117 + IMPORT_C CSIPHeaderBase* CloneL() const;
1.118 +
1.119 + /**
1.120 + * From CSIPHeaderBase Name
1.121 + */
1.122 + IMPORT_C RStringF Name() const;
1.123 +
1.124 +
1.125 + public: // From CSIPHeaderBase, for internal use
1.126 +
1.127 + /**
1.128 + * @internalComponent
1.129 + */
1.130 + RStringF CompactName() const;
1.131 +
1.132 + public: // New functions, for internal use
1.133 +
1.134 + static RPointerArray<CSIPHeaderBase> BaseDecodeL(const TDesC8& aValue);
1.135 +
1.136 + private: // Constructors
1.137 +
1.138 + CSIPFromHeader();
1.139 + };
1.140 +
1.141 +#endif // CSIPFROMHEADER_H
1.142 +
1.143 +// End of File