realtimenetprots/sipfw/SIP/sipapi/api/sipresponseelements.h
author Petteri Saari <petteri.saari@digia.com>
Thu, 25 Nov 2010 13:59:42 +0200
branchMSRP_FrameWork
changeset 58 cdb720e67852
parent 0 307788aac0a8
permissions -rw-r--r--
This release addresses the following issues: 1. The crash bug fix when receiving file 2. Now the sending is based on MSRP messages, there is no longer file receiving or sending. Client sends data as MSRP was designed. 3. Soma MSRP stack was created so that the client told the correct session-id, Symbian stack generated it by itself. This is not allowed, it was changed so that clients tell the session-id (same as used in SIP INVITE). 4. Unnecessary division of data to chunks removed when there is no need to interrupt sending. The message is sent in as few chunks as possible. 5. Stack can now receive files and chunks with ?unlimited? size. Old stack wrote the incoming data to memory and did not utilize disk space until the end of chunk was reached (large chunks from another client crashed it). 6. Now when writing the incoming data to file, it will take into account the byte-range header values. So, this complies with the RFC4975 requirements that stack must be able to handle chunks that come in any sequence. 7. Some buffering changes to outgoing/incoming data. 8. The outgoing data is now checked that it does not contain the created transaction-id before sending the data. 9. MSRP success reports are now implemented and tested against servers. 10. Progress report system fixed so progress is now visible on client (all the way to 100%). 11. Message Cancel receiving / Cancel sending now corrected and made to work as rfc4975 requires. (termination from sender and error code from receiver when cancelling). 12. Bug correction related to messages received not belonging to any session, old stack implementation did send error response, but after response was written it did give the buffer to client anyway. Now corrected.

/*
* Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
* All rights reserved.
* This component and the accompanying materials are made available
* under the terms of "Eclipse Public License v1.0"
* which accompanies this distribution, and is available
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
*
* Initial Contributors:
* Nokia Corporation - initial contribution.
*
* Contributors:
*
* Description:
* Name        : sipresponseelements.h
* Part of     : SIP Client
* Interface   : SDK API, SIP API
* Version     : 1.0
*
*/



#ifndef CSIPRESPONSEELEMENTS_H
#define CSIPRESPONSEELEMENTS_H

//  INCLUDES
#include <e32base.h>
#include <s32strm.h>
#include <stringpool.h>

// FORWARD DECLARATIONS
class CSIPMessageElements;
class CSIPFromHeader;
class CSIPToHeader;
class CSIPCSeqHeader;

// CLASS DECLARATION

/**
*  @publishedAll
*  @released
*
*  Class provides services for creating and manipulating SIP responses
*  This class is used for creating and manipulating SIP responses including
*  status code, reason phrase and optional elements such user headers,
*  content and its type.
*
*  @lib sipclient.lib
*/
class CSIPResponseElements : public CBase
	{
    public:  // Constructors and destructor       
	    /**
        * Two-phased constructor.
        * @pre aStatusCode > 100 && aStatusCode < 700
	    * @param aStatusCode a known SIP response status code. Cannot be 100.
		* @param aReasonPhrase a SIP response reason phrase.
        */
		IMPORT_C static CSIPResponseElements* NewL(TUint aStatusCode,
		                                           RStringF aReasonPhrase);
										
	    /**
        * Two-phased constructor.
        * @pre aStatusCode > 100 && aStatusCode < 700
	    * @param aStatusCode a known SIP response status code. Cannot be 100.
		* @param aReasonPhrase a SIP response reason phrase.
        */
		IMPORT_C static CSIPResponseElements* NewLC(TUint aStatusCode,
		                                            RStringF aReasonPhrase);
											
        /**
        * Destructor.
        */
		IMPORT_C ~CSIPResponseElements();

    public: // New functions
		/**
		* Sets a SIP Response extension status code. It is not possible to set
        * value 100.
        * @pre aStatusCode > 100 && aStatusCode < 700
		* @param aStatusCode extension status code
		* @leave KErrArgument if aStatusCode < 100 or aStatusCode >= 700
		*/
		IMPORT_C void SetStatusCodeL(TUint aStatusCode);

		/**
		* Gets the SIP Response status code
		* @return SIP Response status code
		*/
		IMPORT_C TUint StatusCode() const;

		/**
		* Sets a SIP Response Reason Phrase.
		* @param aReasonPhrase a SIP response reason phrase.
		*/
		IMPORT_C void SetReasonPhraseL(RStringF aReasonPhrase);
			
		/**
		* Gets a SIP Response Reason Phrase.
		* @return a SIP response reason phrase or an empty string if
        *   the reason phrase is not defined.
		*/
		IMPORT_C RStringF ReasonPhrase() const;

		/**
		* Gets the originator's From-header
		* @return a From-header or a 0-pointer if not present. Ownership is
        *   not transferred.
		*/
		IMPORT_C const CSIPFromHeader* FromHeader() const;

		/**
		* Gets the recipient's To-header
		* @return a To-header or a 0-pointer if not present. Ownership is
        *   not transferred.
		*/
		IMPORT_C const CSIPToHeader* ToHeader() const;

		/**
		* Gets CSeq-header
		* @return a CSeq-header or a 0-pointer if not present. Ownership is
        *   not transferred.
		*/		
		IMPORT_C const CSIPCSeqHeader* CSeqHeader() const;

		/**
		* Gets message elements (contains all SIP user headers and content)
		* @return message elements
		*/
		IMPORT_C const CSIPMessageElements& MessageElements() const;

		/**
		* Gets message elements (contains all SIP user headers and content)
		* The response elements can be populated with SIP user headers
		* and content using returned reference to the message elements.
		* @return message elements
		*/
		IMPORT_C CSIPMessageElements& MessageElements();

    public: // New functions, for internal use
        static CSIPResponseElements* InternalizeL (RReadStream& aReadStream);
        static CSIPResponseElements* InternalizeLC (RReadStream& aReadStream);
        void ExternalizeL (RWriteStream& aWriteStream) const;

    private:
	    CSIPResponseElements();
	    void ConstructL(TUint aStatusCode, RStringF aReasonPhrase);
	    void DoInternalizeL (RReadStream& aReadStream);

    private: // Data
	    TUint iStatusCode;
	    RStringF iReasonPhrase;
        CSIPMessageElements* iMessageElements;
	};

#endif // end of CSIPRESPONSEELEMENTS_H