Symbian^3 Application Developer Library >

MGavdpUser Class Reference

class MGavdpUser

Mixin class for GAVDP-related events.

To enforce thinking about the sequence of GAVDP events, these are pure

Public Member Functions
void GAVDP_AbortIndication ( TSEID )
void GAVDP_AbortStreamConfirm ()
void GAVDP_BearerReady ( RSocket , const TAvdtpSockAddr &)
void GAVDP_ConfigurationConfirm ()
TInt GAVDP_ConfigurationEndIndication ()
TInt GAVDP_ConfigurationIndication ( TAvdtpServiceCapability *)
void GAVDP_ConfigurationStartIndication ( TSEID , TSEID )
void GAVDP_ConnectConfirm (const TBTDevAddr &)
void GAVDP_Error ( TInt , const TDesC8 &)
void GAVDP_ReleaseIndication ( TSEID )
void GAVDP_SEPCapability ( TAvdtpServiceCapability *)
void GAVDP_SEPCapabilityComplete ()
void GAVDP_SEPDiscovered (const TAvdtpSEPInfo &)
void GAVDP_SEPDiscoveryComplete ()
void GAVDP_SecurityControlConfirm (const TDesC8 &)
TInt GAVDP_SecurityControlIndication ( TSEID , TDes8 &)
TInt GAVDP_StartIndication ( TSEID )
void GAVDP_StartStreamsConfirm ()
TInt GAVDP_SuspendIndication ( TSEID )
void GAVDP_SuspendStreamsConfirm ()

Member Functions Documentation

GAVDP_AbortIndication(TSEID)

void GAVDP_AbortIndication ( TSEID aSEID ) [pure virtual]

Callback when the remote has Aborted the stream

Parameters

TSEID aSEID the SEID of the local SEP which has been Aborted

GAVDP_AbortStreamConfirm()

void GAVDP_AbortStreamConfirm ( ) [pure virtual]

Callback when the locally-initiated Abort stream has successfully completed

GAVDP_BearerReady(RSocket, const TAvdtpSockAddr &)

void GAVDP_BearerReady ( RSocket aSocket,
const TAvdtpSockAddr & aAddress
) [pure virtual]

Callback when a bearer has been created for a session in the stream. The session the bearer is for can be examined from the socket address given in the callback Each socket created in this way is created on the client's socket server session, and responsibility for socket closure is ceded to the client. TAvdtpSockAddr

Parameters

RSocket aSocket the socket created on the client's socket server session.
const TAvdtpSockAddr & aAddress the socket address (containing SEID, Session type)

GAVDP_ConfigurationConfirm()

void GAVDP_ConfigurationConfirm ( ) [pure virtual]

Callback when locally-initiated (re)configuration procedure successfully completes

GAVDP_ConfigurationEndIndication()

TInt GAVDP_ConfigurationEndIndication ( ) [pure virtual]

Callback when remotely initiated configuration of local SEP is completed The client can still error, as the local side may have expected to see more capabilities proposed

GAVDP_ConfigurationIndication(TAvdtpServiceCapability *)

TInt GAVDP_ConfigurationIndication ( TAvdtpServiceCapability * aCapability ) [pure virtual]

Callback when each capability is being proposed by the peer during configuration Each capability can be refused, but doing so completes whole configure operation

Parameters

TAvdtpServiceCapability * aCapability The capability being proposed. Ownership transferred to client,iff processes in the function return KErrNone.

GAVDP_ConfigurationStartIndication(TSEID, TSEID)

void GAVDP_ConfigurationStartIndication ( TSEID aLocalSEID,
TSEID aRemoteSEID
) [pure virtual]

Callback when remote is beginning to configure a local SEP This cannot be rejected by the client at this stage - it must examine each capability proposed by the GAVDP peer.

Parameters

TSEID aLocalSEID the SEID of the local SEP being configured
TSEID aRemoteSEID the SEID of the remote SEP configuring us

GAVDP_ConnectConfirm(const TBTDevAddr &)

void GAVDP_ConnectConfirm ( const TBTDevAddr & aDeviceAddr ) [pure virtual]

Callback when a signalling channel has successfully been created Note this can be called by GAVDP without the client having called RGavdp::Connect The reason being that as soon as a GAVDP session is created AVDTP begins listening Therefore a remote device can connect to us. The GAVDP client can check the address to confirm if the device is that they originally Connect()ed

Parameters

const TBTDevAddr & aDeviceAddr the Bluetooth device address for which a signalling channel has been created

GAVDP_Error(TInt, const TDesC8 &)

void GAVDP_Error ( TInt aError,
const TDesC8 & aErrorData
) [pure virtual]

Callback when a GAVDP error occurs TAvdtpConfigRejectPckgBuf as an example of what may be passed back

Parameters

TInt aError system-wide or GAVDP or AVDTP error code, for example KErrDisconnected if the signalling channel is disconnected KErrNotReady if GAVDP or AVDTP is not in a valid state to perform an action KErrUnknown if a stream is not currently known to AVDTP. This is likely to occur in the case where a user has closed their bearer socket(s) and GAVDP tries to perform an operation requiring a stream. KErrDied if an unrecoverable internal error occurs (in which case clients should re-start GAVDP) Clients should note that for system wide error codes the reasons given are for errors generated by AVDTP. There is a small chance that they can be passed up in another situation if the error originates from a call on another part of the system.
const TDesC8 & aErrorData extra data relating to the error - the client can deduce the nature based on their GAVDP state and the spec

GAVDP_ReleaseIndication(TSEID)

void GAVDP_ReleaseIndication ( TSEID aSEID ) [pure virtual]

Callback when the remote end has Released a stream The user-plane bearers will subsequently error with KErrDisconnected.

Parameters

TSEID aSEID the SEID of the local SEP which was been released

GAVDP_SEPCapability(TAvdtpServiceCapability *)

void GAVDP_SEPCapability ( TAvdtpServiceCapability * aCapability ) [pure virtual]

Callback when a capability from a remote SEP has been retrieved The client takes owenership of the capability given TAvdtpServiceCapability

Parameters

TAvdtpServiceCapability * aCapability pointer to a capability. Ownership is transferred to the MGavdpUser implementor

GAVDP_SEPCapabilityComplete()

void GAVDP_SEPCapabilityComplete ( ) [pure virtual]

Callback when remote SEP has no more capabilities to be discovered

GAVDP_SEPDiscovered(const TAvdtpSEPInfo &)

void GAVDP_SEPDiscovered ( const TAvdtpSEPInfo & aSEP ) [pure virtual]

Callback when a remote SEP has been discovered TAvdtpSEPInfo

Parameters

const TAvdtpSEPInfo & aSEP the details of the remote SEP

GAVDP_SEPDiscoveryComplete()

void GAVDP_SEPDiscoveryComplete ( ) [pure virtual]

Callback when no more SEPs have been discovered on the remote device. This may be called without GAVDP_SEPDiscovered being called if the remote has no SEPs (such a remote would be in contravention of the specification however)

GAVDP_SecurityControlConfirm(const TDesC8 &)

void GAVDP_SecurityControlConfirm ( const TDesC8 & aResponseData ) [pure virtual]

Callback when the locally-initiated Security Control message successfully completed

Parameters

const TDesC8 & aResponseData The data returned by the ACP - may be the same or different to that supplied by INT

GAVDP_SecurityControlIndication(TSEID, TDes8 &)

TInt GAVDP_SecurityControlIndication ( TSEID aSEID,
TDes8 & aSecurityDataInOut
) [pure virtual]

Callback when the remote is sending Security Control information

Parameters

TSEID aSEID the SEID of the local SEP for which security control is for
TDes8 & aSecurityDataInOut Security Data inbound. The client may change this descriptor for the outbound response

GAVDP_StartIndication(TSEID)

TInt GAVDP_StartIndication ( TSEID aSEID ) [pure virtual]

Callback when the remote is trying to Start a stream The allowable error codes are defined in the Bluetooth SIG AVDTP specification and profiles design to operate above that layer, such as GAVDP. However those "local" error code values should be offset by the Symbian KErrAvdtpSignallingErrorBase (-18045) to convert to system-wide, absolute error codes.

For example; the error code for NOT_SUPPORTED_COMMAND = 25 Therefore, the system code would be (-18045)-25 = -18070

Parameters

TSEID aSEID the SEID of the local SEP being started

GAVDP_StartStreamsConfirm()

void GAVDP_StartStreamsConfirm ( ) [pure virtual]

Callback when the locally-initiated Start stream has successfully completed

GAVDP_SuspendIndication(TSEID)

TInt GAVDP_SuspendIndication ( TSEID aSEID ) [pure virtual]

Callback when the remote is trying to Suspend a stream The allowable error codes are defined in the Bluetooth SIG AVDTP specification and profiles design to operate above that layer, such as GAVDP. However those "local" error code values should be offset by the Symbian KErrAvdtpSignallingErrorBase (-18045) to convert to system-wide, absolute error codes.

For example; the error code for NOT_SUPPORTED_COMMAND = 25 Therefore, the system code would be (-18045)-25 = -18070

Parameters

TSEID aSEID the SEID of the local SEP being suspended

GAVDP_SuspendStreamsConfirm()

void GAVDP_SuspendStreamsConfirm ( ) [pure virtual]

Callback when the locally-initiated Suspend stream has successfully completed

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.