Symbian^3 Application Developer Library >

RAccessoryControl Class Reference

class RAccessoryControl : public RAccessoryConnection

Accessory Control sub-session.

This class is not intended for user derivation.

AccControl.lib
Since
S60 3.1

Inherits from

Public Member Functions
RAccessoryControl ()
IMPORT_C void AccessoryValueChangedNotifyL (const TAccPolGenericID &, const TAccPolNameRecord &, const TAccValueTypeTBool )
IMPORT_C void AccessoryValueChangedNotifyL (const TAccPolGenericID &, const TAccPolNameRecord &, const TAccValueTypeTInt )
IMPORT_C void AccessoryValueChangedNotifyL (const TAccPolGenericID &, const TAccPolNameRecord &, const CAccPolObjectCon &)
IMPORT_C void CancelConnectAccessory ()
IMPORT_C void CancelDisconnectAccessory ()
IMPORT_C TInt CloseSubSession ()
IMPORT_C void ConnectAccessory ( TRequestStatus &, TAccPolGenericID &)
IMPORT_C void ConnectAccessory ( TRequestStatus &, CAccConGenericID *const , TBool )
IMPORT_C TInt CreateSubSession ( RAccessoryServer &)
IMPORT_C void DisconnectAccessory ( TRequestStatus &, const TAccPolGenericID &)
IMPORT_C TInt SetValueL (const TAccPolGenericID &, const TAccPolNameRecord &, const TAccValueTypeTBool )
IMPORT_C TInt SetValueL (const TAccPolGenericID &, const TAccPolNameRecord &, const TAccValueTypeTInt )
IMPORT_C TInt SetValueL (const TAccPolGenericID &, const TAccPolNameRecord &, const CAccPolObjectCon &)
Inherited Functions
RAccessoryConnection::CancelGetAccessoryConnectionStatus()const
RAccessoryConnection::CancelNotifyAccessoryConnectionStatusChanged()const
RAccessoryConnection::GetAccessoryConnectionStatus(TAccPolGenericIDArray &)const
RAccessoryConnection::GetAccessoryConnectionStatus(TRequestStatus &,TAccPolGenericIDArray &)
RAccessoryConnection::NotifyAccessoryConnectionStatusChanged(TRequestStatus &,TAccPolGenericIDArray &)
RAccessoryConnection::RAccessoryConnection()
RAccessoryConnectionBase::GetSubblockNameArrayL(const TAccPolGenericID &,CAccPolSubblockNameArray &)const
RAccessoryConnectionBase::GetValueL(const TAccPolGenericID &,const TAccPolNameRecord &,CAccPolObjectCon &)const
RAccessoryConnectionBase::GetValueL(const TAccPolGenericID &,const TAccPolNameRecord &,TAccValueTypeTBool &)const
RAccessoryConnectionBase::GetValueL(const TAccPolGenericID &,const TAccPolNameRecord &,TAccValueTypeTInt &)const
RAccessoryConnectionBase::GetValueL(const TAccPolGenericID &,const TAccPolNameRecord &,TDes8 &)const
RAccessoryConnectionBase::RAccessoryConnectionBase()
RAccessorySubsessionBase::RAccessorySubsessionBase()
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
Private Attributes
TAccSrvGenericIDPckg iConnectGIDPckg
TAccSrvConnectRecordPckgBuf iConnectRecordPckgBuf
TAccSrvGenericIDPckgBuf iDisconnectGIDPckgBuf
TInt iFlags
TPckg < TInt > iFlagsPckg
TPckg < TInt > iReserved1
TPckg < TInt > iReserved2
TPckgBuf < TUint > iThisThreadIDPckgBuf

Constructor & Destructor Documentation

RAccessoryControl()

IMPORT_C RAccessoryControl ( )

C++ default constructor.

Member Functions Documentation

AccessoryValueChangedNotifyL(const TAccPolGenericID &, const TAccPolNameRecord &, const TAccValueTypeTBool)

IMPORT_C void AccessoryValueChangedNotifyL ( const TAccPolGenericID & aGenericId,
const TAccPolNameRecord & aNameRecord,
const TAccValueTypeTBool aValue
) const

Notifies value change of specific accessory capability.

Accessory capability name constants and value types are defined in AccPolCommonNameValuePairs.h and AccPolProprietaryNameValuePairs.h.

Since
S60 3.1
Exceptions
system-wide

error code if failed. Specifically: KErrArgument if an argument is out of range.

Parameters

const TAccPolGenericID & aGenericId Generic ID of the connected accessory.
const TAccPolNameRecord & aNameRecord Accessory capability.
const TAccValueTypeTBool aValue Value for the specific accessory capability.

AccessoryValueChangedNotifyL(const TAccPolGenericID &, const TAccPolNameRecord &, const TAccValueTypeTInt)

IMPORT_C void AccessoryValueChangedNotifyL ( const TAccPolGenericID & aGenericId,
const TAccPolNameRecord & aNameRecord,
const TAccValueTypeTInt aValue
) const

Notifies value change of specific accessory capability.

Accessory capability name constants and value types are defined in AccPolCommonNameValuePairs.h and AccPolProprietaryNameValuePairs.h.

Since
S60 3.1
Exceptions
system-wide

error code if failed. Specifically: KErrArgument if an argument is out of range.

Parameters

const TAccPolGenericID & aGenericId Generic ID of the connected accessory.
const TAccPolNameRecord & aNameRecord Accessory capability.
const TAccValueTypeTInt aValue Value for the specific accessory capability.

AccessoryValueChangedNotifyL(const TAccPolGenericID &, const TAccPolNameRecord &, const CAccPolObjectCon &)

IMPORT_C void AccessoryValueChangedNotifyL ( const TAccPolGenericID & aGenericId,
const TAccPolNameRecord & aNameRecord,
const CAccPolObjectCon & aValue
) const

Notifies value change of specific accessory capability.

Accessory capability name constants and value types are defined in AccPolCommonNameValuePairs.h and AccPolProprietaryNameValuePairs.h.

Since
S60 5.2
Exceptions
system-wide

error code if failed. Specifically: KErrArgument if an argument is out of range. KErrTooBig The aValue is too big to be streamed.

Parameters

const TAccPolGenericID & aGenericId Generic ID of the connected accessory.
const TAccPolNameRecord & aNameRecord Accessory capability.
const CAccPolObjectCon & aValue Value for the specific accessory capability.

CancelConnectAccessory()

IMPORT_C void CancelConnectAccessory ( ) const

Cancel ConnectAccessory() .

Since
S60 3.1
ConnectAccessory

CancelDisconnectAccessory()

IMPORT_C void CancelDisconnectAccessory ( ) const

Cancel DisconnectAccessory() .

Since
S60 3.1
DisconnectAccessory

CloseSubSession()

IMPORT_C TInt CloseSubSession ( ) [virtual]

Closes the RAccessoryControl sub-session.

Since
S60 3.1
CreateSubSession()

ConnectAccessory(TRequestStatus &, TAccPolGenericID &)

IMPORT_C void ConnectAccessory ( TRequestStatus & aStatus,
TAccPolGenericID & aGenericID
)

ASY has detected accessory connection and requests the Accessory Server to connect the accessory.

Since
S60 3.1
DisconnectAccessory Deprecated, will be removed.

Parameters

TRequestStatus & aStatus Indicates the completion status of a request. KErrNone if successful, system-wide error code if failed. Specifically: KErrAlreadyExists, if request allready exist KErrCancel, if request is cancelled
TAccPolGenericID & aGenericID On successful request completion, contains the updated Generic ID of the connected accessory

ConnectAccessory(TRequestStatus &, CAccConGenericID *const, TBool)

IMPORT_C void ConnectAccessory ( TRequestStatus & aStatus,
CAccConGenericID *const aGenericID,
TBool aEvaluateConnectionRules
)

ASY has detected accessory connection and requests the Accessory Server to connect the accessory.

If this method is called for already connected accessory it is interpreted as a update for existing connection.

Since
S60 3.1
DisconnectAccessory

Parameters

TRequestStatus & aStatus Indicates the completion status of a request. KErrNone if successful, system-wide error code if failed. Specifically: KErrAlreadyExists, if request allready exist. KErrCancel, if request is cancelled.
CAccConGenericID *const aGenericID
TBool aEvaluateConnectionRules Indicates that accessory server evaluates connection rules for this connection.

CreateSubSession(RAccessoryServer &)

IMPORT_C TInt CreateSubSession ( RAccessoryServer & aSession ) [virtual]

Creates a new sub-session within an existing session.

Since
S60 3.1

Parameters

RAccessoryServer & aSession The session to which this sub-session will belong.

DisconnectAccessory(TRequestStatus &, const TAccPolGenericID &)

IMPORT_C void DisconnectAccessory ( TRequestStatus & aStatus,
const TAccPolGenericID & aGenericId
)

ASY has detected accessory disconnection and requests the Accessory Server to disconnect the accessory.

Since
S60 3.1
ConnectAccessory

Parameters

TRequestStatus & aStatus Indicates the completion status of a request. KErrNone if successful, system-wide error code if failed. Specifically: KErrAlreadyExists, if request allready exist KErrCancel, if request is cancelled
const TAccPolGenericID & aGenericId Generic ID of the accessory to be disconnected

SetValueL(const TAccPolGenericID &, const TAccPolNameRecord &, const TAccValueTypeTBool)

IMPORT_C TInt SetValueL ( const TAccPolGenericID & aGenericId,
const TAccPolNameRecord & aNameRecord,
const TAccValueTypeTBool aValue
)

Set the value for the specific accessory capability.

Accessory capability name constants and value types are defined in AccPolCommonNameValuePairs.h and AccPolProprietaryNameValuePairs.h.

Since
S60 3.1
Exceptions
system-wide

error code if failed. Specifically: KErrArgument if an argument is out of range.

Parameters

const TAccPolGenericID & aGenericId Generic ID of the connected accessory.
const TAccPolNameRecord & aNameRecord Accessory capability.
const TAccValueTypeTBool aValue Value for the specific accessory capability.

SetValueL(const TAccPolGenericID &, const TAccPolNameRecord &, const TAccValueTypeTInt)

IMPORT_C TInt SetValueL ( const TAccPolGenericID & aGenericId,
const TAccPolNameRecord & aNameRecord,
const TAccValueTypeTInt aValue
)

Set the value for the specific accessory capability.

Accessory capability name constants and value types are defined in AccPolCommonNameValuePairs.h and AccPolProprietaryNameValuePairs.h.

Since
S60 3.1
Exceptions
system-wide

error code if failed. Specifically: KErrArgument if an argument is out of range.

Parameters

const TAccPolGenericID & aGenericId Generic ID of the connected accessory.
const TAccPolNameRecord & aNameRecord Accessory capability.
const TAccValueTypeTInt aValue Value for the specific accessory capability.

SetValueL(const TAccPolGenericID &, const TAccPolNameRecord &, const CAccPolObjectCon &)

IMPORT_C TInt SetValueL ( const TAccPolGenericID & aGenericId,
const TAccPolNameRecord & aNameRecord,
const CAccPolObjectCon & aValue
)

Set the value for the specific accessory capability.

Accessory capability name constants and value types are defined in AccPolCommonNameValuePairs.h and AccPolProprietaryNameValuePairs.h.

Exceptions
system-wide

error code if failed. Specifically: KErrArgument if an argument is out of range.

accpolobjectbase.h accpolobjectcon.h AccPolCommonNameValuePairs.h

Parameters

const TAccPolGenericID & aGenericId Generic ID of the connected accessory.
const TAccPolNameRecord & aNameRecord Accessory capability.
const CAccPolObjectCon & aValue Value for the specific accessory capability.

Member Data Documentation

TAccSrvGenericIDPckg iConnectGIDPckg

TAccSrvGenericIDPckg iConnectGIDPckg [private]

TAccSrvConnectRecordPckgBuf iConnectRecordPckgBuf

TAccSrvConnectRecordPckgBuf iConnectRecordPckgBuf [private]

TAccSrvGenericIDPckgBuf iDisconnectGIDPckgBuf

TAccSrvGenericIDPckgBuf iDisconnectGIDPckgBuf [private]

TInt iFlags

TInt iFlags [private]

TPckg< TInt > iFlagsPckg

TPckg < TInt > iFlagsPckg [private]

TPckg< TInt > iReserved1

TPckg < TInt > iReserved1 [private]

TPckg< TInt > iReserved2

TPckg < TInt > iReserved2 [private]

TPckgBuf< TUint > iThisThreadIDPckgBuf

TPckgBuf < TUint > iThisThreadIDPckgBuf [private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.