MWsClientClass Class Reference

#include <w32std.h>

Link against: ws32.lib

class MWsClientClass
Protected Attributes
RWsBuffer *iBuffer
TInt32 iWsHandle
Public Member Functions
MWsClientClass()
MWsClientClass(RWsBuffer *)
TInt WsHandle()
Protected Member Functions
voidAddToBitmapArray(const TInt)
voidAsyncRequest(TRequestStatus &, TUint)
TInt CachedWindowSize(TSize &)
voidDestroyWindowSizeCacheEntry()
voidMarkWindowSizeCacheDirty()
voidRefreshWindowSizeCache(const TSize &)
TBool WindowSizeCacheEnabled()
voidWrite(const TAny *, TInt, TInt, TUint)
voidWrite(const TAny *, TInt, const TAny *, TInt, TUint, const TIpcArgs *)
voidWrite(const TAny *, TInt, TUint, const TIpcArgs *)
voidWrite(TUint)
voidWriteInt(TInt, TUint)
voidWritePoint(const TPoint &, TUint)
voidWriteRect(const TRect &, TUint)
TInt WriteReply(TUint, const TIpcArgs *)
TInt WriteReply(const TAny *, TInt, TUint, const TIpcArgs *)
TInt WriteReply(const TAny *, TInt, const TAny *, TInt, TUint, const TIpcArgs *)
TInt WriteReplyByProvidingRemoteReadAccess(const TAny *, TInt, const TReadDescriptorType &, TUint)
TInt WriteReplyInt(TInt, TUint, const TIpcArgs *)
TInt WriteReplyIntP(TInt, const TWriteDescriptorType &, TUint)
TInt WriteReplyP(const TWriteDescriptorType &, TUint)
TInt WriteReplyP(const TAny *, TInt, const TWriteDescriptorType &, TUint)
TInt WriteReplyP(const TAny *, TInt, const TAny *, TInt, const TWriteDescriptorType &, TUint)
voidWriteSize(const TSize &, TUint)

Detailed Description

Base class for all classes whose objects are clients of the window server.

Member Attribute Documentation

iBuffer

RWsBuffer *iBuffer[protected]

WARNING: Member variable for internal use ONLY. Compatibility is not guaranteed in future releases. Please access using the provided get/set APIs only.

iWsHandle

TInt32 iWsHandle[protected]

WARNING: Member variable for internal use ONLY. Compatibility is not guaranteed in future releases. Please access using the provided get/set APIs only.

Constructor & Destructor Documentation

MWsClientClass ( )

MWsClientClass()

MWsClientClass ( RWsBuffer * )

MWsClientClass(RWsBuffer *aBuffer)

Member Function Documentation

AddToBitmapArray ( const TInt )

voidAddToBitmapArray(const TIntaBitmapHandle)const [protected]

AsyncRequest ( TRequestStatus &, TUint )

voidAsyncRequest(TRequestStatus &aStatus,
TUintaOpcode
)const [protected]

CachedWindowSize ( TSize & )

TInt CachedWindowSize(TSize &aSize)const [protected]

DestroyWindowSizeCacheEntry ( )

voidDestroyWindowSizeCacheEntry()[protected]

MarkWindowSizeCacheDirty ( )

voidMarkWindowSizeCacheDirty()[protected]

RefreshWindowSizeCache ( const TSize & )

voidRefreshWindowSizeCache(const TSize &aNewSize)const [protected]

WindowSizeCacheEnabled ( )

TBool WindowSizeCacheEnabled()const [protected]

Write ( const TAny *, TInt, TInt, TUint )

voidWrite(const TAny *aData1,
TIntaLength1,
TIntaLength2,
TUintaOpcode
)const [protected]

Writes data sent in aData1 of length aLength1 for the specifed aOpcode into wserv buffer. It also takes aLength2 paratmeter, which is the length of second data that will be added using AppendData. This Function checks if current command and aLength2 can fit in the remaining buffer, if not then it does flush of previous command so that the current command can be set along with data of aLength2.

Parameters
aData1Data to be added to the buffer
aLength1Length of the data to be added to buffer
aLength2Length of second data that will(and must) be added using AppendData()
aOpcodeOpcode for the current command

Write ( const TAny *, TInt, const TAny *, TInt, TUint, const TIpcArgs * )

voidWrite(const TAny *aData,
TIntaLength,
const TAny *aData2,
TIntaLength2,
TUintaOpcode,
const TIpcArgs *aIpcArgs = 0
)const [protected]

Writes data sent in aData1 and aData2 of lengths aLength1 and aLength2 for the specifed aOpcode into wserv buffer. It also takes an TIpcArgs by which you can send additional data. But one thing needs to be noted that if aIpcArgs has some content then this function flushes the wserv buffer

Note:Only second, third and fourth slot of IPC agrs can be used to send data as first slot is used up for normal wserv buffer

Parameters
aDataData to be added to the buffer
aLengthLength of the data to be added to buffer
aData2second Data to be added to the buffer
aLength2second Length of second data then can be added using AppendData()
aOpcodeOpcode for the current command
aIpcArgsAdditional data sent from client to server. It has default argument NULL. And if some data is sent in aIpcArgs, it flushes wserv buffer.

Write ( const TAny *, TInt, TUint, const TIpcArgs * )

voidWrite(const TAny *aBuf,
TIntaBufLen,
TUintaOpcode,
const TIpcArgs *aIpcArgs = 0
)const [protected]

Writes data sent in aData1 of length aLength1 for the specifed aOpcode into wserv buffer. It also takes an TIpcArgs by which you can send additional data. But one thing needs to be noted that if aIpcArgs has some content then this function flushes the wserv buffer

Note:Only second, third and fourth slot of IPC agrs can be used to send data as first slot is used up for normal wserv buffer

Parameters
aOpcodeOpcode for the current command
aIpcArgsAdditional data sent from client to server. It has default argument NULL. And if some data is sent in aIpcArgs, it flushes wserv buffer

Write ( TUint )

voidWrite(TUintaOpcode)const [protected]

WriteInt ( TInt, TUint )

voidWriteInt(TIntaInt,
TUintaOpcode
)const [protected]

WritePoint ( const TPoint &, TUint )

voidWritePoint(const TPoint &aPoint,
TUintaOpcode
)const [protected]

WriteRect ( const TRect &, TUint )

voidWriteRect(const TRect &aRect,
TUintaOpcode
)const [protected]

WriteReply ( TUint, const TIpcArgs * )

TInt WriteReply(TUintaOpcode,
const TIpcArgs *aIpcArgs = 0
)const [protected]

WriteReply ( const TAny *, TInt, TUint, const TIpcArgs * )

TInt WriteReply(const TAny *aBuf,
TIntaBufLen,
TUintaOpcode,
const TIpcArgs *aIpcArgs = 0
)const [protected]

WriteReply ( const TAny *, TInt, const TAny *, TInt, TUint, const TIpcArgs * )

TInt WriteReply(const TAny *aBuf,
TIntaBufLen,
const TAny *aBuf2,
TIntaBuflen2,
TUintaOpcode,
const TIpcArgs *aIpcArgs = 0
)const [protected]

WriteReplyByProvidingRemoteReadAccess ( const TAny *, TInt, const TReadDescriptorType &, TUint )

TInt WriteReplyByProvidingRemoteReadAccess(const TAny *aBuf,
TIntaBufLen,
const TReadDescriptorType &aRemoteReadBuffer,
TUintaOpcode
)const [protected]

WriteReplyInt ( TInt, TUint, const TIpcArgs * )

TInt WriteReplyInt(TIntaInt,
TUintaOpcode,
const TIpcArgs *aIpcArgs = 0
)const [protected]

WriteReplyIntP ( TInt, const TWriteDescriptorType &, TUint )

TInt WriteReplyIntP(TIntaInt,
const TWriteDescriptorType &aReplyPackage,
TUintaOpcode
)const [protected]

WriteReplyP ( const TWriteDescriptorType &, TUint )

TInt WriteReplyP(const TWriteDescriptorType &aReplyPackage,
TUintaOpcode
)const [protected]

WriteReplyP ( const TAny *, TInt, const TWriteDescriptorType &, TUint )

TInt WriteReplyP(const TAny *aBuf,
TIntaBufLen,
const TWriteDescriptorType &aReplyPackage,
TUintaOpcode
)const [protected]

WriteReplyP ( const TAny *, TInt, const TAny *, TInt, const TWriteDescriptorType &, TUint )

TInt WriteReplyP(const TAny *aBuf,
TIntaBufLen,
const TAny *aBuf2,
TIntaBuflen2,
const TWriteDescriptorType &aReplyPackage,
TUintaOpcode
)const [protected]

WriteSize ( const TSize &, TUint )

voidWriteSize(const TSize &aSize,
TUintaOpcode
)const [protected]

WsHandle ( )

TInt WsHandle()const [inline]

Gets the server side handle for the object.

Return Value
The server-side handle for the object.