RRemConBulk Class Reference

class RRemConBulk : public RSessionBase

The abstract base class for RemCon session handles.

Inherits from

Public Member Functions
RRemConBulk ()
IMPORT_C TInt Connect ()
IMPORT_C void Receive ( TRequestStatus &, TUid &, TUint &, TDes8 &)
IMPORT_C TInt ReceiveCancel ()
IMPORT_C void Send ( TRequestStatus &, TUid , TUint , const TDesC8 &)
IMPORT_C TInt SendCancel ()
IMPORT_C TInt SendUnreliable ( TUid , TUint , const TDesC8 &)
IMPORT_C TVersion Version ()
IMPORT_C TInt __DbgCheckHeap ( TInt )
IMPORT_C TInt __DbgFailNext ( TInt )
IMPORT_C TInt __DbgMarkEnd ( TInt )
IMPORT_C TInt __DbgMarkHeap ()
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()
Inherited Enumerations
RHandleBase:TAttributes
RSessionBase:TAttachMode
Private Attributes
TPckg < TUint > iOpIdPckg
TPckgBuf < TOperationInformation > iOpInfoPckg
TPckg < TUint > iUidPckg
Inherited Attributes
RHandleBase::iHandle

Constructor & Destructor Documentation

RRemConBulk()

IMPORT_C RRemConBulk ( )

Member Functions Documentation

Connect()

IMPORT_C TInt Connect ( )

Connect the handle to the server. Must be called before all other methods (except Version and Close).

Receive(TRequestStatus &, TUid &, TUint &, TDes8 &)

IMPORT_C void Receive ( TRequestStatus & aStatus,
TUid & aInterfaceUid,
TUint & aOperationId,
TDes8 & aData
)

Receive a message (command or response) from the remote device. Note that RemCon server queues both commands and responses so that none are ever thrown away just because the client didn't have a Receive outstanding when they arrived.

Parameters

TRequestStatus & aStatus TRequestStatus for asynchronous completion.
TUid & aInterfaceUid The UID of the interface to which the message belongs.
TUint & aOperationId The ID of the message.
TDes8 & aData Data associated with the message.

ReceiveCancel()

IMPORT_C TInt ReceiveCancel ( )

Cancels interest in the completion of an outstanding Receive operation.

Send(TRequestStatus &, TUid, TUint, const TDesC8 &)

IMPORT_C void Send ( TRequestStatus & aStatus,
TUid aInterfaceUid,
TUint aOperationId,
const TDesC8 & aData =  KNullDesC8 ()
)

Sends a message (command or response) to the remote device. Note that currently only responses are supported, but the API is generic enough for both types of message.

Parameters

TRequestStatus & aStatus TRequestStatus for asynchronous completion.
TUid aInterfaceUid The UID of the interface to which the message belongs.
TUint aOperationId The ID of the message. RemCon needs to know this, separately from the arbitrary data, so it can (a) match up any incoming response to this client (if the message is a command), and (b) match this message up to the target (if this message is a response).
const TDesC8 & aData =  KNullDesC8 () Data associated with the message.

SendCancel()

IMPORT_C TInt SendCancel ( )

Cancels interest in the completion of an outstanding Send operation.

SendUnreliable(TUid, TUint, const TDesC8 &)

IMPORT_C TInt SendUnreliable ( TUid aInterfaceUid,
TUint aOperationId,
const TDesC8 & aData =  KNullDesC8 ()
)

Sends a message (command or response) unreliably to the remote device. Note that currently only reponses are supported, by the API is generic enough for both types of message.

Parameters

TUid aInterfaceUid The UID of the interface to which the message belongs.
TUint aOperationId The ID of the message. RemCon needs to know this, separately from the arbitrary data, so it can (a) match up any incoming response to this client (if the message is a command), and (b) match this message up to the target (if this message is a response).
const TDesC8 & aData =  KNullDesC8 () Data associated with the message.

Version()

IMPORT_C TVersion Version ( ) const

Getter for the version of the server.

__DbgCheckHeap(TInt)

IMPORT_C TInt __DbgCheckHeap ( TInt aCount )

Checks that the number of allocated cells on the server's heap is correct. The server is panicked if not. In release builds, just returns KErrNone.

Parameters

TInt aCount The expected number of allocated heap cells.

__DbgFailNext(TInt)

IMPORT_C TInt __DbgFailNext ( TInt aCount )

Simulates memory allocation failure in the server. In release builds, just returns KErrNone.

Parameters

TInt aCount The number of allocations after which memory allocation should fail.

__DbgMarkEnd(TInt)

IMPORT_C TInt __DbgMarkEnd ( TInt aCount )

Marks the end of heap cell checking. Checks that the number of heap cells allocated since the last __DbgMarkHeap() is aCount; the most common value to pass here is zero. In release builds, just returns KErrNone.

Parameters

TInt aCount The expected number of allocated heap cells.

__DbgMarkHeap()

IMPORT_C TInt __DbgMarkHeap ( )

Marks the start of heap cell checking in the server's heap. In release builds, just returns KErrNone.

Member Data Documentation

TPckg< TUint > iOpIdPckg

TPckg < TUint > iOpIdPckg [private]

TPckgBuf< TOperationInformation > iOpInfoPckg

TPckgBuf < TOperationInformation > iOpInfoPckg [private]

Used by Send.

TPckg< TUint > iUidPckg

TPckg < TUint > iUidPckg [private]

Used by Receive.