RSubConnection Class Reference

class RSubConnection : public RCommsSubSession
A Sub-Connection, a channel within a Connection. A representation of a channel between this device and remote devices with which we are communicating. This channel will be used by one or more sockets. Depending on the state of the channel, it may not be possible to bind arbitary sockets into it. Attempts to bind sockets from different protocol families to a single channel is an error, as each channel can only be used by one protocol family.
Note:

The sub-connection can represent a end-to-end channel and/or a channel from this device to an intermediate device (e.g an access server such as a GGSN which using UMTS and PDP contexts. Properties can be specified simultaneously on protocol and link level.)

Before using any of these services, a connection to a socket server session must have been made and the connection must be open.

Since v9.0

Inherits from

Nested Classes and Structures

Public Member Functions
RSubConnection()
IMPORT_C voidAdd(RSocket &, TRequestStatus &)
IMPORT_C voidCancelEventNotification()
IMPORT_C voidClose()
IMPORT_C TIntControl(TUint, TUint, TDes8 &)
IMPORT_C voidEventNotification(TNotificationEventBuf &, TBool, TRequestStatus &)
IMPORT_C voidEventNotification(TNotificationEventBuf &, TEventFilter, TUint, TRequestStatus &)
IMPORT_C TIntGetParameters(RSubConParameterBundle &)
IMPORT_C TIntGetParameters(RParameterFamilyBundle &)
IMPORT_C TIntOpen(RSocketServ &, TSubConnType, RConnection &)
IMPORT_C voidRemove(RSocket &, TRequestStatus &)
TBool SameSession(TInt)
IMPORT_C TIntSetParameters(const RSubConParameterBundle &)
IMPORT_C TIntSetParameters(const RParameterFamilyBundle &)
IMPORT_C voidStart(TRequestStatus &)
IMPORT_C TIntStart()
IMPORT_C TIntStop()
Private Member Functions
IMPORT_C TIntOpen(RSocketServ &, TSubConnOpen::TSubConnType, RConnection &)
Inherited Functions
RSubSessionBase::CloseSubSession(TInt)
RSubSessionBase::CreateAutoCloseSubSession(RSessionBase &,TInt,const TIpcArgs &)
RSubSessionBase::CreateSubSession(const RSessionBase &,TInt)
RSubSessionBase::CreateSubSession(const RSessionBase &,TInt,const TIpcArgs &)
RSubSessionBase::RSubSessionBase()
RSubSessionBase::Send(TInt)const
RSubSessionBase::Send(TInt,const TIpcArgs &)const
RSubSessionBase::SendReceive(TInt)const
RSubSessionBase::SendReceive(TInt,TRequestStatus &)const
RSubSessionBase::SendReceive(TInt,const TIpcArgs &)const
RSubSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
RSubSessionBase::Session()const
RSubSessionBase::SubSessionHandle()const
Public Member Enumerations
enumTSubConnType { EAttachToDefault, ECreateNew, EWaitIncoming }
Private Attributes
TInt iSpare

Constructor & Destructor Documentation

RSubConnection()

IMPORT_CRSubConnection()

Member Functions Documentation

Add(RSocket &, TRequestStatus &)

IMPORT_C voidAdd(RSocket &aSocket,
TRequestStatus &aStatus
)

Parameters

RSocket & aSocket
TRequestStatus & aStatus

CancelEventNotification()

IMPORT_C voidCancelEventNotification()

Close()

IMPORT_C voidClose()

Control(TUint, TUint, TDes8 &)

IMPORT_C TIntControl(TUintaOptionLevel,
TUintaOptionName,
TDes8 &aOption
)

Parameters

TUint aOptionLevel
TUint aOptionName
TDes8 & aOption

EventNotification(TNotificationEventBuf &, TBool, TRequestStatus &)

IMPORT_C voidEventNotification(TNotificationEventBuf &aEventBuffer,
TBoolaGenericEventsOnly,
TRequestStatus &aStatus
)

Parameters

TNotificationEventBuf & aEventBuffer
TBool aGenericEventsOnly
TRequestStatus & aStatus

EventNotification(TNotificationEventBuf &, TEventFilter, TUint, TRequestStatus &)

IMPORT_C voidEventNotification(TNotificationEventBuf &aEventBuffer,
TEventFilteraEventFilterList,
TUintaEventListLength,
TRequestStatus &aStatus
)

Parameters

TNotificationEventBuf & aEventBuffer
TEventFilter aEventFilterList
TUint aEventListLength
TRequestStatus & aStatus

GetParameters(RSubConParameterBundle &)

IMPORT_C TIntGetParameters(RSubConParameterBundle &aParametersSet)

Parameters

RSubConParameterBundle & aParametersSet

GetParameters(RParameterFamilyBundle &)

IMPORT_C TIntGetParameters(RParameterFamilyBundle &aParametersSet)

Parameters

RParameterFamilyBundle & aParametersSet

Open(RSocketServ &, TSubConnType, RConnection &)

IMPORT_C TIntOpen(RSocketServ &aServer,
TSubConnTypeaSubConnType,
RConnection &aConnection
)

Parameters

RSocketServ & aServer
TSubConnType aSubConnType
RConnection & aConnection

Open(RSocketServ &, TSubConnOpen::TSubConnType, RConnection &)

IMPORT_C TIntOpen(RSocketServ &aServer,
TSubConnOpen::TSubConnTypeaSubConnType,
RConnection &aConnection
)[private]

Parameters

RSocketServ & aServer
TSubConnOpen::TSubConnType aSubConnType
RConnection & aConnection

Remove(RSocket &, TRequestStatus &)

IMPORT_C voidRemove(RSocket &aSocket,
TRequestStatus &aStatus
)

Parameters

RSocket & aSocket
TRequestStatus & aStatus

SameSession(TInt)

TBool SameSession(TIntaSessionHandle)

Parameters

TInt aSessionHandle

SetParameters(const RSubConParameterBundle &)

IMPORT_C TIntSetParameters(const RSubConParameterBundle &aParametersSet)

Parameters

const RSubConParameterBundle & aParametersSet

SetParameters(const RParameterFamilyBundle &)

IMPORT_C TIntSetParameters(const RParameterFamilyBundle &aParametersSet)

Parameters

const RParameterFamilyBundle & aParametersSet

Start(TRequestStatus &)

IMPORT_C voidStart(TRequestStatus &aStatus)

Parameters

TRequestStatus & aStatus

Start()

IMPORT_C TIntStart()

Stop()

IMPORT_C TIntStop()

Member Enumerations Documentation

Enum TSubConnType

Enumerators

EAttachToDefault
ECreateNew
EWaitIncoming

Member Data Documentation

TInt iSpare

TInt iSpare[private]
© Nokia 2010.