sl@0: // Copyright (c) 1996-2010 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: // Common client side class
sl@0: // 
sl@0: //
sl@0: 
sl@0: #include <e32std.h>
sl@0: #include "../SERVER/w32cmd.h"
sl@0: #include "CLIENT.H"
sl@0: 
sl@0: 
sl@0: MWsClientClass::MWsClientClass() : iWsHandle(0), iBuffer(NULL)
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: MWsClientClass::MWsClientClass(RWsBuffer *aBuffer) : iWsHandle(0), iBuffer(aBuffer)
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Writes data sent in aData1 of length aLength1 for the specifed aOpcode
sl@0: into wserv buffer. It also takes aLength2 paratmeter, which is the length of second data 
sl@0: that will be added using AppendData. This Function checks if current command and aLength2 
sl@0: can fit in the remaining buffer, if not then it does flush of previous command so that
sl@0: the current command can be set along with data of aLength2. 
sl@0: 
sl@0: @param aData1 Data to be added to the buffer
sl@0: @param aLength1 Length of the data to be added to buffer
sl@0: @param aLength2 Length of second data that will(and must) be added using AppendData()
sl@0: @param aOpcode Opcode for the current command
sl@0: */
sl@0: void MWsClientClass::Write(const TAny *aData1,TInt aLength1,TInt aLength2,TUint aOpcode) const
sl@0: 	{
sl@0: 	Write(aData1,aLength1,NULL,aLength2,aOpcode);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Writes data sent in aData1 and aData2 of lengths aLength1 and aLength2 
sl@0: for the specifed aOpcode into wserv buffer. It also takes an TIpcArgs by which 
sl@0: you can send additional data. But one thing needs to be noted that if aIpcArgs 
sl@0: has some content then this function flushes the wserv buffer 
sl@0: 
sl@0: @param aData1 Data to be added to the buffer
sl@0: @param aLength1 Length of the data to be added to buffer
sl@0: @param aData2 second Data to be added to the buffer
sl@0: @param aLength2 second Length of second data then can be added using AppendData()
sl@0: @param aOpcode Opcode for the current command
sl@0: @param aIpcArgs Additional data sent from client to server. It has default argument NULL.
sl@0: 				And if some data is sent in aIpcArgs, it flushes wserv buffer.
sl@0: 
sl@0: Note:Only second, third and fourth slot of IPC agrs can be used to send data 
sl@0: as first slot is used up for normal wserv buffer
sl@0: */
sl@0: void MWsClientClass::Write(const TAny *aData1, TInt aLength1,const TAny *aData2, TInt aLength2,TUint aOpcode,const TIpcArgs* aIpcArgs/*=NULL*/) const
sl@0: 	{
sl@0: 	iBuffer->Write(iWsHandle,aOpcode,aData1,aLength1,aData2,aLength2,aIpcArgs);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Writes data sent in aData1 of length aLength1 for the specifed aOpcode 
sl@0: into wserv buffer. It also takes an TIpcArgs by which you can send additional data. 
sl@0: But one thing needs to be noted that if aIpcArgs has some content then this 
sl@0: function flushes the wserv buffer 
sl@0: 
sl@0: @param aData1 Data to be added to the buffer
sl@0: @param aLength1 Length of the data to be added to buffer
sl@0: @param aOpcode Opcode for the current command
sl@0: @param aIpcArgs Additional data sent from client to server. It has default argument NULL.
sl@0: 				And if some data is sent in aIpcArgs, it flushes wserv buffer
sl@0: 
sl@0: Note:Only second, third and fourth slot of IPC agrs can be used to send data 
sl@0: as first slot is used up for normal wserv buffer				
sl@0: */
sl@0: void MWsClientClass::Write(const TAny *aData, TInt aLength, TUint aOpcode, const TIpcArgs* aIpcArgs/*=NULL*/) const
sl@0: 	{
sl@0: 	iBuffer->Write(iWsHandle,aOpcode,aData,aLength,aIpcArgs);
sl@0: 	}
sl@0: 
sl@0: void MWsClientClass::Write(TUint aOpcode) const
sl@0: 	{
sl@0: 	iBuffer->Write(iWsHandle,aOpcode);
sl@0: 	}
sl@0: 
sl@0: void MWsClientClass::WriteInt(TInt aInt, TUint aOpcode) const
sl@0: 	{
sl@0: 	iBuffer->Write(iWsHandle,aOpcode,&aInt,sizeof(TInt));
sl@0: 	}
sl@0: 
sl@0: void MWsClientClass::WriteRect(const TRect &aRect, TUint aOpcode) const
sl@0: 	{
sl@0: 	Write(&aRect,sizeof(aRect),aOpcode);
sl@0: 	}
sl@0: 
sl@0: void MWsClientClass::WritePoint(const TPoint &aPoint, TUint aOpcode) const
sl@0: 	{
sl@0: 	Write(&aPoint,sizeof(aPoint),aOpcode);
sl@0: 	}
sl@0: 
sl@0: void MWsClientClass::WriteSize(const TSize &aSize, TUint aOpcode) const
sl@0: 	{
sl@0: 	Write(&aSize,sizeof(aSize),aOpcode);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Appends data directly to wserv buffer for the current command. So this function 
sl@0: should be used after adding the current command.
sl@0: Typically this function is used in conjunction with  
sl@0: MWsClientClass::Write(const TAny *aData1,TInt aLength1,TInt aLength2,TUint aOpcode)
sl@0: Please see its description for more details.  
sl@0: 
sl@0: @param aData Data to be added to the buffer
sl@0: @param aLength Length of the data to be added to buffer. Make sure that its length
sl@0: 		is less than availabe buffer.
sl@0: @param aFinished EFalse, adds data to buffer and disables flushing(notfies that more data is pending to be added)
sl@0: 				 ETrue, adds data to buffer and enables flushing(Signals that this is the last bit of data to be added)
sl@0: 
sl@0: Notes:
sl@0: 1. The total length of all data added by using this API(by one or more calls) must be less then(See note 3)or 
sl@0: same as aLength2 passed in earlier call to MWsClientClass::Write(const TAny *aData1,TInt aLength1,TInt aLength2,TUint aOpcode)
sl@0: 2. When data is added using this API, it pads out buffer to multiple of 4 bytes so that 
sl@0: all strings added to the buffer will begin on a 4 byte boundary.
sl@0: 3. If data added is less then the length passed to above Write API it works, but wastes buffer spaces. 
sl@0: */
sl@0: void MWsClientClass::AppendData(const TAny *aData,TInt aLength,TBool aFinished)
sl@0: 	{
sl@0: 	iBuffer->AppendData(aData,aLength,aFinished);
sl@0: 	}
sl@0: 
sl@0: TInt MWsClientClass::WriteReply(TUint aOpcode,const TIpcArgs* aIpcArgs) const
sl@0: 	{
sl@0: 	return(iBuffer->WriteReply(iWsHandle,aOpcode,aIpcArgs));
sl@0: 	}
sl@0: 
sl@0: TInt MWsClientClass::WriteReplyInt(TInt aInt, TUint aOpcode,const TIpcArgs* aIpcArgs) const
sl@0: 	{
sl@0: 	return(iBuffer->WriteReply(iWsHandle,aOpcode,&aInt,sizeof(TInt),aIpcArgs));
sl@0: 	}
sl@0: 
sl@0: TInt MWsClientClass::WriteReply(const TAny *aData1, TInt aLength1,TUint aOpcode,const TIpcArgs* aIpcArgs) const
sl@0: 	{
sl@0: 	return(iBuffer->WriteReply(iWsHandle,aOpcode,aData1,aLength1,aIpcArgs));
sl@0: 	}
sl@0: 
sl@0: TInt MWsClientClass::WriteReply(const TAny *aData1, TInt aLength1,const TAny *aData2, TInt aLength2,TUint aOpcode,const TIpcArgs* aIpcArgs) const
sl@0: 	{
sl@0: 	return(iBuffer->WriteReply(iWsHandle,aOpcode,aData1,aLength1,aData2,aLength2,aIpcArgs));
sl@0: 	}
sl@0: 
sl@0: TInt MWsClientClass::WriteReplyP(const TWriteDescriptorType& aReplyPackage,TUint aOpcode) const
sl@0: 	{
sl@0: 	return(iBuffer->WriteReplyP(iWsHandle,aOpcode,aReplyPackage));
sl@0: 	}
sl@0: 
sl@0: TInt MWsClientClass::WriteReplyIntP(TInt aInt, const TWriteDescriptorType& aReplyPackage,TUint aOpcode) const
sl@0: 	{
sl@0: 	return(iBuffer->WriteReplyP(iWsHandle,aOpcode,&aInt,sizeof(aInt),aReplyPackage));
sl@0: 	}
sl@0: 
sl@0: TInt MWsClientClass::WriteReplyP(const TAny *aData1, TInt aLength1, const TWriteDescriptorType& aReplyPackage,TUint aOpcode) const
sl@0: 	{
sl@0: 	return(iBuffer->WriteReplyP(iWsHandle,aOpcode,aData1,aLength1,aReplyPackage));
sl@0: 	}
sl@0: 
sl@0: TInt MWsClientClass::WriteReplyP(const TAny *aData1, TInt aLength1,const TAny *aData2, TInt aLength2, const TWriteDescriptorType& aReplyPackage,TUint aOpcode) const
sl@0: 	{
sl@0: 	return(iBuffer->WriteReplyP(iWsHandle,aOpcode,aData1,aLength1,aData2,aLength2,aReplyPackage));
sl@0: 	}
sl@0: 
sl@0: TInt MWsClientClass::WriteReplyByProvidingRemoteReadAccess(const TAny* aBuf, TInt aBufLen,const TReadDescriptorType& aRemoteReadBuffer, TUint aOpcode) const
sl@0: 	{
sl@0: 	return(iBuffer->WriteReplyByProvidingRemoteReadAccess(iWsHandle,aOpcode,aBuf,aBufLen,aRemoteReadBuffer));
sl@0: 	}
sl@0: 
sl@0: void MWsClientClass::AddToBitmapArray(const TInt aBitmapHandle)const
sl@0: 	{
sl@0: 	iBuffer->AddToBitmapArray(aBitmapHandle);
sl@0: 	}
sl@0: 
sl@0: void MWsClientClass::AsyncRequest(TRequestStatus& aStatus, TUint aOpcode) const
sl@0: 	{
sl@0: 	iBuffer->AsyncRequest(iWsHandle, aOpcode, aStatus);
sl@0: 	}
sl@0: 
sl@0: TBool MWsClientClass::WindowSizeCacheEnabled() const
sl@0:     {
sl@0:     return iBuffer->WindowSizeCacheEnabled();
sl@0:     }
sl@0: 
sl@0: void MWsClientClass::MarkWindowSizeCacheDirty()
sl@0:     {
sl@0:     iBuffer->MarkWindowSizeCacheDirty(iWsHandle);
sl@0:     }
sl@0: 
sl@0: void MWsClientClass::RefreshWindowSizeCache(const TSize& aNewSize) const
sl@0:     {
sl@0:     iBuffer->RefreshWindowSizeCache(iWsHandle,aNewSize);
sl@0:     }
sl@0: 
sl@0: TInt MWsClientClass::CachedWindowSize(TSize& aSize) const
sl@0:     {
sl@0:     return iBuffer->CachedWindowSize(iWsHandle, aSize);
sl@0:     }
sl@0: 
sl@0: void MWsClientClass::DestroyWindowSizeCacheEntry()
sl@0:     {
sl@0:     iBuffer->DestroyWindowSizeCacheEntry(iWsHandle);
sl@0:     }