1.1 --- a/epoc32/include/sipsecurityclientheader.h Tue Nov 24 13:55:44 2009 +0000
1.2 +++ b/epoc32/include/sipsecurityclientheader.h Tue Mar 16 16:12:26 2010 +0000
1.3 @@ -1,1 +1,122 @@
1.4 -sipsecurityclientheader.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 : sipsecurityclientheader.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 CSIPSECURITYCLIENTHEADER_H
1.30 +#define CSIPSECURITYCLIENTHEADER_H
1.31 +
1.32 +// INCLUDES
1.33 +#include "sipsecurityheaderbase.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 "Security-Client"
1.42 +* header fields.
1.43 +*
1.44 +* @lib sipcodec.lib
1.45 +*/
1.46 +class CSIPSecurityClientHeader : public CSIPSecurityHeaderBase
1.47 + {
1.48 + public: // Constructors and destructor
1.49 +
1.50 + /**
1.51 + * Constructs a CSIPSecurityClientHeader from textual representation
1.52 + * of the header's value part.
1.53 + * @param aValue a value part of a "Security-Client"-header
1.54 + * @return an array containing 1..n instances of CSIPSecurityClientHeader
1.55 + */
1.56 + IMPORT_C static RPointerArray<CSIPSecurityClientHeader>
1.57 + DecodeL(const TDesC8& aValue);
1.58 +
1.59 + /**
1.60 + * Creates a new instance of CSIPSecurityClientHeader
1.61 + * @param aMechanism a Mechanism-Name parameter
1.62 + * in the "Security-Client" header
1.63 + * @return a new instance of CSIPSecurityClientHeader
1.64 + */
1.65 + IMPORT_C static CSIPSecurityClientHeader*
1.66 + NewL(const TDesC8& aMechanism);
1.67 +
1.68 + /**
1.69 + * Creates a new instance of CSIPSecurityClientHeader
1.70 + * and puts it to CleanupStack
1.71 + * @param aMechanism a Mechanism-Name parameter
1.72 + * in the "Security-Client" header
1.73 + * @return a new instance of CSIPSecurityClientHeader
1.74 + */
1.75 + IMPORT_C static CSIPSecurityClientHeader*
1.76 + NewLC(const TDesC8& aMechanism);
1.77 +
1.78 + /**
1.79 + * Destructor, deletes the resources of CSIPSecurityClientHeader.
1.80 + */
1.81 + IMPORT_C ~CSIPSecurityClientHeader();
1.82 +
1.83 +
1.84 + public: // New functions
1.85 +
1.86 + /**
1.87 + * Constructs an instance of a CSIPSecurityClientHeader
1.88 + * from a RReadStream
1.89 + * @param aReadStream a stream containing the value of the
1.90 + * externalized object (header name not included).
1.91 + * @return an instance of a CSIPSecurityClientHeader
1.92 + */
1.93 +
1.94 + IMPORT_C static CSIPHeaderBase*
1.95 + InternalizeValueL(RReadStream& aReadStream);
1.96 +
1.97 +
1.98 + public: // From CSIPHeaderBase
1.99 +
1.100 + /**
1.101 + * From CSIPHeaderBase CloneL
1.102 + */
1.103 + IMPORT_C CSIPHeaderBase* CloneL() const;
1.104 +
1.105 + /**
1.106 + * From CSIPHeaderBase Name
1.107 + */
1.108 + IMPORT_C RStringF Name() const;
1.109 +
1.110 +
1.111 + public: // New functions, for internal use
1.112 +
1.113 + static RPointerArray<CSIPHeaderBase> BaseDecodeL(const TDesC8& aValue);
1.114 +
1.115 + private: // New functions
1.116 +
1.117 + CSIPSecurityClientHeader() ;
1.118 +
1.119 + private: // For testing purposes
1.120 +
1.121 + UNIT_TEST(CSIPSecurityHeaderBaseTest)
1.122 + };
1.123 +
1.124 +#endif // CSIPSECURITYCLIENTHEADER_H
1.125 +
1.126 +// End of File