RSocketServ Class Reference

class RSocketServ : public RCommsSession

Provides the Connect() function to create an IPC communication channel to the socket server. To close the channel RHandleBase provides a RHandleBase::Close() function.

The prime use for instances of RSocketServ is to establish subsession communications for RSocket, RHostResolver, RNetDatabase and RConnection. Any of the resources which are open using the session are automatically closed when the session is terminated, however it is more appropriate to issue a Close() on each subsession object before closing the session.

The following operations are also provided:

NumProtocols() - enumerates the number of protocols of which the socket server is currently aware.

GetProtocolInfo()/FindProtocol() - return information about a specific protocol.

StartProtocol() - loads a protocol asynchronously.

Note:

This class is not intended for user derivation.

Inherits from

Public Member Functions
RSocketServ()
IMPORT_C voidClearExclusiveMode()
IMPORT_C TIntConnect(TUint)
IMPORT_C TIntConnect(const TSessionPref &, TUint)
IMPORT_C TIntFindProtocol(const TProtocolName &, TProtocolDesc &)
IMPORT_C TIntGetProtocolInfo(TUint, TProtocolDesc &)
IMPORT_C TIntInstallExtension(const TDesC &, const TDesC &)
IMPORT_C TIntNumProtocols(TUint &)
IMPORT_C voidSetExclusiveMode(TRequestStatus &)
IMPORT_C voidStartProtocol(TUint, TUint, TUint, TRequestStatus &)
IMPORT_C voidStopProtocol(TUint, TUint, TUint, TRequestStatus &)
IMPORT_C TVersionVersion()
IMPORT_C TBool__DbgCheckFailNext()
IMPORT_C TInt__DbgCheckHeap(TInt)
IMPORT_C TInt__DbgCheckMbuf(TInt)
IMPORT_C TInt__DbgControl(const ESockDebug::TControlMsg &)
IMPORT_C TInt__DbgFailNext(TInt)
IMPORT_C TInt__DbgFailNextMbuf(TInt)
IMPORT_C TInt__DbgMarkEnd(TInt)
IMPORT_C TInt__DbgMarkHeap()
IMPORT_C TInt__DbgMbufFreeSpace()
IMPORT_C TInt__DbgMbufTotalSpace()
IMPORT_C TInt__DbgSetMbufPoolLimit(TInt)
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

RSocketServ()

IMPORT_CRSocketServ()

Member Functions Documentation

ClearExclusiveMode()

IMPORT_C voidClearExclusiveMode()

Connect(TUint)

IMPORT_C TIntConnect(TUintaMessageSlots = (TUint)-1)

Parameters

TUint aMessageSlots = (TUint)-1

Connect(const TSessionPref &, TUint)

IMPORT_C TIntConnect(const TSessionPref &aPref,
TUintaMessageSlots = (TUint)-1
)

Parameters

const TSessionPref & aPref
TUint aMessageSlots = (TUint)-1

FindProtocol(const TProtocolName &, TProtocolDesc &)

IMPORT_C TIntFindProtocol(const TProtocolName &aName,
TProtocolDesc &aProtocol
)

Parameters

const TProtocolName & aName
TProtocolDesc & aProtocol

GetProtocolInfo(TUint, TProtocolDesc &)

IMPORT_C TIntGetProtocolInfo(TUintanIndex,
TProtocolDesc &aProtocol
)

Parameters

TUint anIndex
TProtocolDesc & aProtocol

InstallExtension(const TDesC &, const TDesC &)

IMPORT_C TIntInstallExtension(const TDesC &aDllName,
const TDesC &aArgs =  TPtrC()
)

Parameters

const TDesC & aDllName
const TDesC & aArgs =  TPtrC()

NumProtocols(TUint &)

IMPORT_C TIntNumProtocols(TUint &aCount)

Parameters

TUint & aCount

SetExclusiveMode(TRequestStatus &)

IMPORT_C voidSetExclusiveMode(TRequestStatus &aStatus)

Parameters

TRequestStatus & aStatus

StartProtocol(TUint, TUint, TUint, TRequestStatus &)

IMPORT_C voidStartProtocol(TUintanAddrFamily,
TUintaSockType,
TUintaProtocol,
TRequestStatus &aStatus
)

Parameters

TUint anAddrFamily
TUint aSockType
TUint aProtocol
TRequestStatus & aStatus

StopProtocol(TUint, TUint, TUint, TRequestStatus &)

IMPORT_C voidStopProtocol(TUintanAddrFamily,
TUintaSockType,
TUintaProtocol,
TRequestStatus &aStatus
)

Parameters

TUint anAddrFamily
TUint aSockType
TUint aProtocol
TRequestStatus & aStatus

Version()

IMPORT_C TVersionVersion()const

__DbgCheckFailNext()

IMPORT_C TBool__DbgCheckFailNext()const

__DbgCheckHeap(TInt)

IMPORT_C TInt__DbgCheckHeap(TIntaCount)

Parameters

TInt aCount

__DbgCheckMbuf(TInt)

IMPORT_C TInt__DbgCheckMbuf(TIntasize)

Parameters

TInt asize

__DbgControl(const ESockDebug::TControlMsg &)

IMPORT_C TInt__DbgControl(const ESockDebug::TControlMsg &aRequestMsg)

Parameters

const ESockDebug::TControlMsg & aRequestMsg

__DbgFailNext(TInt)

IMPORT_C TInt__DbgFailNext(TIntaCount)

Parameters

TInt aCount

__DbgFailNextMbuf(TInt)

IMPORT_C TInt__DbgFailNextMbuf(TIntaCount)

Parameters

TInt aCount

__DbgMarkEnd(TInt)

IMPORT_C TInt__DbgMarkEnd(TIntaCount)

Parameters

TInt aCount

__DbgMarkHeap()

IMPORT_C TInt__DbgMarkHeap()

__DbgMbufFreeSpace()

IMPORT_C TInt__DbgMbufFreeSpace()

__DbgMbufTotalSpace()

IMPORT_C TInt__DbgMbufTotalSpace()

__DbgSetMbufPoolLimit(TInt)

IMPORT_C TInt__DbgSetMbufPoolLimit(TIntasize)

Parameters

TInt asize