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