Msrp/MsrpServer/inc/MMSRPWriterObserver.h
author shivsood
Sat, 12 Jun 2010 14:30:11 +0530
branchMSRP_FrameWork
changeset 25 505ad3f0ce5c
child 58 cdb720e67852
permissions -rw-r--r--
MSRP Chat and File Sharing FrameWork - Initial Contribution from Nokia. MSRP Implementation as per RFC 4975 and RCS specifications that supports 1. Multiple one to one chat data sessions as per RCS/RFC 4975 specifications. 2. Multiple file Sharing sessions as per RCS. 3. Data Chunking requirements as per 4975. 3. MSRP Connection sharing requirements as per RFC 4975

/*
* Copyright (c) 2009-2010 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:
* MSRP Implementation
*
*/

#ifndef __MMMSRPWRITEROBSERVER_H
#define __MMMSRPWRITEROBSERVER_H

// CLASS DECLARATIONS
/**
* Interface for notifying about socket writer events
*/
class MMSRPWriterObserver
	{
	public:
    
    enum TWriteStatus
        {
        EMsrpSocketWrite = 0,//EComplete, EInterrupted, EPending_bufferfull
        EMsrpAvoidSocketWrite, //EPending_buffernotfull 
        };  
	    
	enum TMsgStatus
	    {
        EUndefined = 0,
	    EPending, //Sending incomplete. Same observer is called again immediately
	    EComplete, //No more to send. A new observer is called, this is removed 
	    EInterrupted //There is more to send. Same observer called later
	    };	
	
	    /**
	     * Called by writer to fetch the content to send
	     * @param aData Output param, Points to data to be sent 
	     * @param aInterrupt Signals whether other msgs are queued waiting to be sent
	     * @return KErrNone or system wide eror codes 
	     */	    
	    virtual TWriteStatus GetSendBufferL( TPtrC8& aData, TBool aInterrupt ) = 0;

	   /**           
        * Called when the message has been written to the socket
		* @param aSendstatus status of the write operation, communicates prev send result
        * @return Indicates which observer has to be called the next time                 
        */
	    virtual TMsgStatus WriteDoneL(TInt aStatus ) = 0;
	};


class MMSRPWriterErrorObserver
    {
    public:
        
        /**
         * socket errors detected on write arent msg specific
         * Hence the observer has been separated
         * The observer is expected to be implemented in connection and handled as a connection error
         */
        
        virtual void WriteSocketError(TInt aError) = 0;
    };



#endif // __MMMSRPWRITEROBSERVER_H

// End of file