RCommServ Class Reference

class RCommServ : public RSessionBase

Represents a session with the serial comms server. Functions are provided for connection to the server and for loading and unloading different comms modules, and services for finding out the name and numbers of the available ports.

Sessions with the serial comms server are not shareable.

Comms modules are also known as "CSY"s due to their ".CSY" extension, derived from the term "Comms SYstem".

This class is not intended for user derivation.

Inherits from

Public Member Functions
RCommServ()
IMPORT_C TIntConnect()
IMPORT_C TIntCreateThreadInCommProc(const TDesC &, const TDesC &, TThreadFunction, TInt, TInt, TInt)
IMPORT_C TIntGetPortInfo(const TDesC &, TSerialInfo &)
IMPORT_C TIntGetPortInfo(TInt, TDes &, TSerialInfo &)
IMPORT_C TIntLoadCommModule(const TDesC &)
IMPORT_C TIntNumPorts(TInt &)
IMPORT_C TIntUnloadCommModule(const TDesC &)
IMPORT_C TVersionVersion()
IMPORT_C TInt__DbgCheckHeap(TInt)
IMPORT_C TInt__DbgFailNext(TInt)
IMPORT_C TInt__DbgMarkEnd(TInt)
IMPORT_C TInt__DbgMarkHeap()
IMPORT_C TInt__DbgSetTraceMask(TC32Trace)
Private Member Functions
TBool IsServerThreadL()
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
Inherited Attributes
RHandleBase::iHandle

Constructor & Destructor Documentation

RCommServ()

IMPORT_CRCommServ()

Member Functions Documentation

Connect()

IMPORT_C TIntConnect()

CreateThreadInCommProc(const TDesC &, const TDesC &, TThreadFunction, TInt, TInt, TInt)

IMPORT_C TIntCreateThreadInCommProc(const TDesC &aLibraryName,
const TDesC &aThreadName,
TThreadFunctionaFunction,
TIntaStackSize,
TIntaHeapMinSize,
TIntaHeapMaxSize
)[static]

Parameters

const TDesC & aLibraryName
const TDesC & aThreadName
TThreadFunction aFunction
TInt aStackSize
TInt aHeapMinSize
TInt aHeapMaxSize

GetPortInfo(const TDesC &, TSerialInfo &)

IMPORT_C TIntGetPortInfo(const TDesC &aName,
TSerialInfo &aInfo
)

Parameters

const TDesC & aName
TSerialInfo & aInfo

GetPortInfo(TInt, TDes &, TSerialInfo &)

IMPORT_C TIntGetPortInfo(TIntaIndex,
TDes &aModuleName,
TSerialInfo &aInfo
)

Parameters

TInt aIndex
TDes & aModuleName
TSerialInfo & aInfo

IsServerThreadL()

TBool IsServerThreadL()[private, static]

LoadCommModule(const TDesC &)

IMPORT_C TIntLoadCommModule(const TDesC &aFileName)

Parameters

const TDesC & aFileName

NumPorts(TInt &)

IMPORT_C TIntNumPorts(TInt &aNum)

Parameters

TInt & aNum

UnloadCommModule(const TDesC &)

IMPORT_C TIntUnloadCommModule(const TDesC &aName)

Parameters

const TDesC & aName

Version()

IMPORT_C TVersionVersion()const

__DbgCheckHeap(TInt)

IMPORT_C TInt__DbgCheckHeap(TIntaCount)

Parameters

TInt aCount

__DbgFailNext(TInt)

IMPORT_C TInt__DbgFailNext(TIntaCount)

Parameters

TInt aCount

__DbgMarkEnd(TInt)

IMPORT_C TInt__DbgMarkEnd(TIntaCount)

Parameters

TInt aCount

__DbgMarkHeap()

IMPORT_C TInt__DbgMarkHeap()

__DbgSetTraceMask(TC32Trace)

IMPORT_C TInt__DbgSetTraceMask(TC32TraceaMask)

Parameters

TC32Trace aMask