epoc32/include/mw/siprseqheader.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 3 e1b950c65cb4
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@4
     5
* under the terms of "Eclipse Public License v1.0"
williamr@2
     6
* which accompanies this distribution, and is available
williamr@4
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description:
williamr@2
    15
* Name        : siprseqheader.h
williamr@2
    16
* Part of     : SIP Codec
williamr@2
    17
* Interface   : SDK API, SIP Codec API
williamr@2
    18
* Version     : SIP/4.0 
williamr@2
    19
*
williamr@2
    20
*/
williamr@2
    21
williamr@2
    22
williamr@2
    23
williamr@2
    24
williamr@2
    25
#ifndef CSIPRSEQHEADER_H
williamr@2
    26
#define CSIPRSEQHEADER_H
williamr@2
    27
williamr@2
    28
//  INCLUDES
williamr@2
    29
#include "sipunsignedintheaderbase.h"
williamr@2
    30
williamr@2
    31
// CLASS DECLARATION
williamr@2
    32
/**
williamr@2
    33
* @publishedAll
williamr@2
    34
* @released
williamr@2
    35
*
williamr@2
    36
* Class encapsulates a "RSeq"-header value.
williamr@2
    37
*
williamr@2
    38
*  @lib sipcodec.lib
williamr@2
    39
*/
williamr@2
    40
class CSIPRSeqHeader : public CSIPUnsignedIntHeaderBase
williamr@2
    41
    {
williamr@2
    42
    public: // Constructors and destructor
williamr@2
    43
williamr@2
    44
        /**
williamr@2
    45
        * Constructs a CSIPRSeqHeader from textual representation 
williamr@2
    46
        * of the header's value part.
williamr@2
    47
        * @param aValue a value part of a "RSeq"-header (e.g. "123")
williamr@2
    48
        * @return a new instance of CSIPRSeqHeader
williamr@2
    49
        */
williamr@2
    50
        IMPORT_C static CSIPRSeqHeader* DecodeL(const TDesC8& aValue);
williamr@2
    51
    
williamr@2
    52
        /**
williamr@2
    53
        * Constructor
williamr@2
    54
        * @param aValue the value to set
williamr@2
    55
        */
williamr@2
    56
        IMPORT_C CSIPRSeqHeader(TUint aValue);
williamr@2
    57
    
williamr@2
    58
        /**
williamr@2
    59
        * Destructor, deletes the resources of CSIPRSeqHeader.
williamr@2
    60
        */
williamr@2
    61
        IMPORT_C ~CSIPRSeqHeader();
williamr@2
    62
williamr@2
    63
williamr@2
    64
    public: // New functions
williamr@2
    65
williamr@2
    66
        /**
williamr@2
    67
        * Constructs an instance of a CSIPRSeqHeader from a RReadStream
williamr@2
    68
        * @param aReadStream a stream containing the value of the
williamr@2
    69
        *        externalized header object (header name not included).
williamr@2
    70
        * @return an instance of a CSIPRSeqHeader
williamr@2
    71
        */
williamr@2
    72
        IMPORT_C static CSIPHeaderBase* 
williamr@2
    73
            InternalizeValueL(RReadStream& aReadStream);
williamr@2
    74
williamr@2
    75
williamr@2
    76
    public: // From CSIPHeaderBase
williamr@2
    77
williamr@2
    78
        /**
williamr@2
    79
        * From CSIPHeaderBase CloneL
williamr@2
    80
        */
williamr@2
    81
        IMPORT_C CSIPHeaderBase* CloneL() const;
williamr@2
    82
williamr@2
    83
        /**
williamr@2
    84
        * From CSIPHeaderBase Name
williamr@2
    85
        */
williamr@2
    86
        IMPORT_C RStringF Name() const;
williamr@2
    87
williamr@2
    88
williamr@2
    89
    public: // From CSIPHeaderBase, for internal use
williamr@2
    90
williamr@2
    91
        /**
williamr@2
    92
        * @internalComponent
williamr@2
    93
        */
williamr@2
    94
        TPreferredPlace PreferredPlaceInMessage() const;
williamr@2
    95
williamr@2
    96
    public: // New functions, for internal use
williamr@2
    97
williamr@2
    98
        static RPointerArray<CSIPHeaderBase> BaseDecodeL(const TDesC8& aValue);
williamr@2
    99
williamr@2
   100
    private: // For testing purposes
williamr@4
   101
#ifdef CPPUNIT_TEST 
williamr@4
   102
        friend class CSIPRSeqHeaderTest;
williamr@4
   103
#endif
williamr@2
   104
    };
williamr@2
   105
williamr@2
   106
#endif // CSIPRSEQHEADER_H
williamr@2
   107
williamr@2
   108
// End of File