RFbsSession Class Reference

#include <fbs.h>

class RFbsSession : protected RSessionBase

Inherits from

RFbsSession
- RSessionBase
  - RHandleBase

Public Member Enumerations
enum	THeapFailType { EHeapFailTypeServerMemory, EHeapFailTypeHeapMemory }

Public Member Functions
	RFbsSession()
TInt	AllocScanLineBuffer(TInt)
IMPORT_C void	CallBack()
TBool	CanConnectToServer()
IMPORT_C TInt	Connect()
IMPORT_C TInt	Connect(RFs &)
IMPORT_C TInt	ConveyOogmMessage(TFbsOogmMessage &)
IMPORT_C void	Disconnect()
HBufC8 *	GetDecompressionBuffer(TInt)
HBufC8 *	GetExtraBuffer(TInt)
IMPORT_C TInt	GetGlyphCacheMetrics(TGlyphCacheMetrics &)
IMPORT_C TInt	GetHeapSizes(TInt &, TInt &, TInt &)
HBufC8 *	GetScanLineBuffer()
IMPORT_C RFbsSession *	GetSession()
IMPORT_C TUint8 *	HeapBase()
IMPORT_C void	ResetCallBack()
IMPORT_C TInt	ResourceCount()
IMPORT_C TInt	SendCommand(TInt, TInt, TInt, TInt, TInt)
TInt	SendCommand(TInt, const TIpcArgs &)
void	SendCommand(TInt, const TIpcArgs &, TRequestStatus &)
IMPORT_C TInt	ServerSessionHandle()
TInt	SessionHandle()
IMPORT_C void	SetCallBack(TCallBack)
void	SetCallBackPtr(TInt *)
IMPORT_C TVersion	Version()

Inherited Attributes
	RHandleBase::iHandle

Inherited Enumerations
	RHandleBase:TAttributes
	RSessionBase:TAttachMode

Inherited Functions
	RHandleBase::Attributes()const
	RHandleBase::BTraceId()const
	RHandleBase::Close()
	RHandleBase::DoExtendedClose()
	RHandleBase::Duplicate(const RThread &,TOwnerType)
	RHandleBase::FullName()const
	RHandleBase::FullName(TDes &)const
	RHandleBase::Handle()const
	RHandleBase::HandleInfo(THandleInfo *)
	RHandleBase::Name()const
	RHandleBase::NotifyDestruction(TRequestStatus &)
	RHandleBase::Open(const TFindHandleBase &,TOwnerType)
	RHandleBase::OpenByName(const TDesC &,TOwnerType,TInt)
	RHandleBase::RHandleBase()
	RHandleBase::RHandleBase(TInt)
	RHandleBase::SetHandle(TInt)
	RHandleBase::SetHandleNC(TInt)
	RSessionBase::CreateSession(RServer2,const TVersion &)
	RSessionBase::CreateSession(RServer2,const TVersion &,TInt)
	RSessionBase::CreateSession(RServer2,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy ,TRequestStatus )
	RSessionBase::CreateSession(const TDesC &,const TVersion &)
	RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt)
	RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy ,TRequestStatus )
	RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TRequestStatus *)
	RSessionBase::Open(RMessagePtr2,TInt,TOwnerType)
	RSessionBase::Open(RMessagePtr2,TInt,const TSecurityPolicy &,TOwnerType)
	RSessionBase::Open(TInt,TOwnerType)
	RSessionBase::Open(TInt,const TSecurityPolicy &,TOwnerType)
	RSessionBase::Send(TInt)const
	RSessionBase::Send(TInt,const TIpcArgs &)const
	RSessionBase::SendReceive(TInt)const
	RSessionBase::SendReceive(TInt,TRequestStatus &)const
	RSessionBase::SendReceive(TInt,const TIpcArgs &)const
	RSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
	RSessionBase::SetReturnedHandle(TInt)
	RSessionBase::SetReturnedHandle(TInt,RHandleBase &)
	RSessionBase::SetReturnedHandle(TInt,const TSecurityPolicy &)
	RSessionBase::ShareAuto()
	RSessionBase::ShareProtected()

Detailed Description

A session with the font and bitmap server.

Member Enumeration Documentation

Enum THeapFailType

WARNING: For internal use ONLY. Compatibility is not guaranteed in future releases. Used for testing server side out of memory failures. Test

Enumerator	Value	Description
EHeapFailTypeServerMemory
EHeapFailTypeHeapMemory

Constructor & Destructor Documentation

RFbsSession ( )

IMPORT_C

RFbsSession

(

)

Member Function Documentation

AllocScanLineBuffer ( TInt )

TInt

AllocScanLineBuffer

(

TInt

aSize

)

Allocates the buffer for decoding compressed rom bitmaps.

Internal use only.

Parameters
aSize	Minimum size of the buffer required. If the buffer is too small an attempt to resize it will be made.

Return Value: KErrNone if successful, KErrNoMemory if the buffer was too small and could not be expanded.

CallBack ( )

IMPORT_C void

CallBack

(

)

Triggers the most recently registered callback. This is mainly called by bitmaps when their twips size changes and when any FBSERV objects are closed to notify clients of a change that may affect their operation.

CanConnectToServer ( )

TBool

CanConnectToServer

(

)

[static]

Connect ( )

IMPORT_C TInt

Connect

(

)

[static]

Creates a session with the Font and Bitmap server.

Return Value: KErrNone, if successful; KErrNoMemory if there is not enough memory to create the session; otherwise another of the system-wide error codes.

Connect ( RFs & )

IMPORT_C TInt

Connect

(

RFs &

aFileServer

)

[static]

Creates a session with the Font and Bitmap server.

Parameters
aFileServer	A fuly constructed file server session

Return Value: KErrNone, if successful; KErrNoMemory if there is not enough memory to create the session; otherwise another of the system-wide error codes.

ConveyOogmMessage ( TFbsOogmMessage & )

IMPORT_C TInt

ConveyOogmMessage

(

TFbsOogmMessage &

aOogmMessage

)

Perform the IPC to convey the desired OoGM action to the glyph atlas.

Note:

The server-side platform security policy applied to this method is such that it is only useable by the GOoM framework.

Return Value: KErrNone if IPC was successful. One of the system-wide error codes, as described for RSessionBase::SendReceive(), if not.

Disconnect ( )

IMPORT_C void

Disconnect

(

)

[static]

Closes the session with the Font and Bitmap server.

GetDecompressionBuffer ( TInt )

HBufC8 *

GetDecompressionBuffer

(

TInt

aSize

)

Gets a pointer to the buffer currently in use for decoding compressed mask bitmaps.

Internal use only.

Parameters
aSize	Minimum size of the buffer required. If the buffer is too small an attempt to resize it will be made.

Return Value: The buffer area currently in use or NULL if there is no memory.

GetExtraBuffer ( TInt )

HBufC8 *

GetExtraBuffer

(

TInt

aSize

)

Gets a pointer to an extra buffer for general use.

Internal use only.

Parameters
aSize	Minimum size of the buffer required. If the buffer is too small an attempt to resize it will be made.

Return Value: The buffer area currently in use or NULL if there is no memory.

GetGlyphCacheMetrics ( TGlyphCacheMetrics & )

IMPORT_C TInt

GetGlyphCacheMetrics

(

TGlyphCacheMetrics &

aGlyphCacheMetrics

)

GetHeapSizes ( TInt &, TInt &, TInt & )

IMPORT_C TInt	GetHeapSizes	(	TInt &	aDefaultHeap,
			TInt &	aSmallBmpHeap,
			TInt &	aBigBmpChunk
		)

Returns the current sizes of the FBServ default heap, the heap for large bitmaps, and the heap for small bitmaps.

Not supported in release builds.

Test

Return Value: KErrNone or one of the system wide error codes in debug mode, or KErrNotSupported in release mode.

GetScanLineBuffer ( )

HBufC8 *

GetScanLineBuffer

(

)

Gets a reference to the buffer currently in use for decoding compressed rom bitmaps.

Internal use only.

Return Value: The buffer area currently in use,

GetSession ( )

IMPORT_C RFbsSession *

GetSession

(

)

[static]

Gets the current Font and Bitmap server session.

Return Value: A pointer to the current session or NULL if Connect() has not been called yet.

HeapBase ( )

IMPORT_C TUint8 *

HeapBase

(

)

const

Gets the address of first location in the global shared heap containing fonts and bitmaps.

Return Value: Pointer to the base of the shared heap.

ResetCallBack ( )

IMPORT_C void

ResetCallBack

(

)

Resets the callback.

ResourceCount ( )

IMPORT_C TInt

ResourceCount

(

)

Returns the number of Font and Bitmap Server objects currently in use by this session.

Return Value: The number of resources in use: bitmaps, fonts, typeface stores.

SendCommand ( TInt, TInt, TInt, TInt, TInt )

IMPORT_C TInt	SendCommand	(	TInt	aMessage,
			TInt	aInt0 = 0,
			TInt	aInt1 = 0,
			TInt	aInt2 = 0,
			TInt	aInt3 = 0
		)	const

Utility function for passing commands to the server.

Parameters
aMessage	Integer code for the message to pass - see TFbsMessage.
aInt0	Parameter 0 for the message.
aInt1	Parameter 1 for the message.
aInt2	Parameter 2 for the message.
aInt3	Parameter 3 for the message.

Return Value: Return code from RSessionBase::SendReceive().

SendCommand ( TInt, const TIpcArgs & )

TInt	SendCommand	(	TInt	aMessage,
			const TIpcArgs &	aArgs
		)	const

SendCommand ( TInt, const TIpcArgs &, TRequestStatus & )

void	SendCommand	(	TInt	aMessage,
			const TIpcArgs &	aArgs,
			TRequestStatus &	aStatus
		)	const

ServerSessionHandle ( )

IMPORT_C TInt

ServerSessionHandle

(

)

const

Returns a handle assigned to this session by the server upon connection. This method should be used instead of SessionHandle() when passing a session handle to FbServ APIs that require Session handles.

Pre-condition: The session has successfully connected to the server.

Return Value: A handle representing this session on the server.

SessionHandle ( )

TInt

SessionHandle

(

)

const [inline]

SetCallBack ( TCallBack )

IMPORT_C void

SetCallBack

(

TCallBack

aCallBack

)

Sets the callback.

Parameters
aCallBack	callback object to be called by CallBack(). Only one may be in use at a time and subsequent calls will displace previous calls.

SetCallBackPtr ( TInt * )

void

SetCallBackPtr

(

TInt *

aBitmapHandle

)

const

Version ( )

IMPORT_C TVersion

Version

(

)

Gets the current Font and Bitmap server version.

Return Value: The current version of the server.