os/mm/devsoundextensions/telephonyaudiorouting/Session/src/TelephonyAudioRoutingSession.cpp
1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/mm/devsoundextensions/telephonyaudiorouting/Session/src/TelephonyAudioRoutingSession.cpp Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,383 @@
1.4 +/*
1.5 +* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
1.6 +* All rights reserved.
1.7 +* This component and the accompanying materials are made available
1.8 +* under the terms of "Eclipse Public License v1.0"
1.9 +* which accompanies this distribution, and is available
1.10 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.11 +*
1.12 +* Initial Contributors:
1.13 +* Nokia Corporation - initial contribution.
1.14 +*
1.15 +* Contributors:
1.16 +*
1.17 +* Description: This class is the main interface to the TelephonyAudioRoutingServer.
1.18 +* It implements the client-side session.
1.19 +*
1.20 +*/
1.21 +
1.22 +
1.23 +
1.24 +#include <e32math.h>
1.25 +#include <s32mem.h>
1.26 +#include "TelephonyAudioRoutingClientServer.h"
1.27 +#include "TelephonyAudioRoutingSession.h"
1.28 +#include "TelephonyAudioRoutingRequest.h"
1.29 +#include "TelephonyAudioRoutingPolicyRequest.h"
1.30 +
1.31 +const TInt KReqSetOutput = 0;
1.32 +const TInt KReqNotifyIfOutputChanged = 1;
1.33 +const TInt KReqNotifyIfAvailOutputsChanged = 2;
1.34 +const TInt KReqMaxSize = 3;
1.35 +
1.36 +// -----------------------------------------------------------------------------
1.37 +// RTelephonyAudioRoutingSession::RTelephonyAudioRoutingSession
1.38 +// C++ default constructor can NOT contain any code, that
1.39 +// might leave.
1.40 +// -----------------------------------------------------------------------------
1.41 +//
1.42 +EXPORT_C RTelephonyAudioRoutingSession::RTelephonyAudioRoutingSession()
1.43 + : RSessionBase(), iConnected(EFalse)
1.44 + {
1.45 + // No implementation required
1.46 +
1.47 + }
1.48 +
1.49 +// -----------------------------------------------------------------------------
1.50 +// RTelephonyAudioRoutingSession::ConnectL
1.51 +// Connects a client to the server
1.52 +// (other items were commented in a header).
1.53 +// -----------------------------------------------------------------------------
1.54 +//
1.55 +EXPORT_C TInt RTelephonyAudioRoutingSession::ConnectL(
1.56 + CTelephonyAudioRouting& aAudioRouting,
1.57 + MTelephonyAudioRoutingObserver& aObserver)
1.58 + {
1.59 +
1.60 + TELAUDRTNG_RDEBUG(_L("[TELAUDRTNG]\t TelephonyAudioRoutingSession::ConnectL "));
1.61 +
1.62 + TInt retry=2;
1.63 + TInt err = KErrGeneral;
1.64 +
1.65 +
1.66 + for (;;)
1.67 + {
1.68 + err=CreateSession(KTelAudRtngServName,TVersion(0,0,0));
1.69 + if (err!=KErrNotFound && err!=KErrServerTerminated && err!=KErrPermissionDenied)
1.70 + break;
1.71 +
1.72 + if (--retry==0)
1.73 + break;
1.74 + }
1.75 +
1.76 + if ( err == KErrNone )
1.77 + {
1.78 + // Create active object receive handlers and add it to scheduler
1.79 + TRAP(err, StartRequestHandlersL(aAudioRouting, aObserver));
1.80 + if ( err == KErrNone )
1.81 + {
1.82 + iConnected = ETrue;
1.83 + }
1.84 +
1.85 + SendReceive(ETelAudRtngServInitialize, TIpcArgs());
1.86 +
1.87 + }
1.88 +
1.89 + return err;
1.90 +
1.91 + }
1.92 +
1.93 +// -----------------------------------------------------------------------------
1.94 +// RTelephonyAudioRoutingSession::Close
1.95 +// Closes connection to the server.
1.96 +// (other items were commented in a header).
1.97 +// -----------------------------------------------------------------------------
1.98 +//
1.99 +EXPORT_C void RTelephonyAudioRoutingSession::Close()
1.100 + {
1.101 + TELAUDRTNG_RDEBUG1(_L("[TELAUDRTNG]\t RTelephonyAudioRoutingSession[%x]::Close "),this);
1.102 + if ( iConnected )
1.103 + {
1.104 +
1.105 + for (TInt i = 0; i < KReqMaxSize; i++)
1.106 + {
1.107 + delete iRequests[i];
1.108 + }
1.109 + iRequests.Close();
1.110 + iAvailableOutputs.Close();
1.111 + RSessionBase::Close();
1.112 + iConnected = EFalse;
1.113 +
1.114 + }
1.115 +
1.116 + }
1.117 +
1.118 +// -----------------------------------------------------------------------------
1.119 +// RTelephonyAudioRoutingSession::Version
1.120 +// Gets the client side version number.
1.121 +// (other items were commented in a header).
1.122 +// -----------------------------------------------------------------------------
1.123 +//
1.124 +EXPORT_C TVersion RTelephonyAudioRoutingSession::Version() const
1.125 + {
1.126 + return(TVersion(0,0,0));
1.127 + }
1.128 +
1.129 +// -----------------------------------------------------------------------------
1.130 +// RTelephonyAudioRoutingSession::GetDefaultValues
1.131 +// Gets default values for current audio output, previous audio output, and
1.132 +// show note mode from the server.
1.133 +// (other items were commented in a header).
1.134 +// -----------------------------------------------------------------------------
1.135 +//
1.136 +EXPORT_C void RTelephonyAudioRoutingSession::GetDefaultValuesL()
1.137 + {
1.138 + TELAUDRTNG_RDEBUG1(_L("[TELAUDRTNG]\t RTelephonyAudioRoutingSession[%x]::GetDefaultValuesL "),this);
1.139 +
1.140 + User::LeaveIfError( SendReceive(ETelAudRtngServGetDefaultValues, TIpcArgs(&iDefaultValuePkg)) );
1.141 +
1.142 + // Set session attributes with values retrieved from Server:
1.143 + TTelephonyAudioRoutingDefaultParams defParams = iDefaultValuePkg();
1.144 +
1.145 + CTelephonyAudioRouting::TAudioOutput currentAudioOutput = defParams.iCurrentAudio;
1.146 + TELAUDRTNG_RDEBUG1(_L("[TELAUDRTNG]\t GetDefaultValuesL: current audio output = %d "), currentAudioOutput);
1.147 + iCurrentAudioOutputPkg() = currentAudioOutput;
1.148 +
1.149 + CTelephonyAudioRouting::TAudioOutput previousAudioOutput = defParams.iPreviousAudio;
1.150 + TELAUDRTNG_RDEBUG1(_L("[TELAUDRTNG]\t GetDefaultValuesL: Previous audio output = %d "), previousAudioOutput);
1.151 + iPreviousAudioOutputPkg() = previousAudioOutput;
1.152 +
1.153 + TBool showNoteMode = defParams.iShowNoteMode;
1.154 + TELAUDRTNG_RDEBUG1(_L("[TELAUDRTNG]\t GetDefaultValuesL: showNoteMode = %d "), showNoteMode);
1.155 + iShowNoteModePkg() = showNoteMode;
1.156 +
1.157 + }
1.158 +
1.159 +// -----------------------------------------------------------------------------
1.160 +// RTelephonyAudioRoutingSession::SetOutput
1.161 +// Send a SetOutput request to server.
1.162 +// (other items were commented in a header).
1.163 +// -----------------------------------------------------------------------------
1.164 +//
1.165 +EXPORT_C void RTelephonyAudioRoutingSession::SetOutput(
1.166 + CTelephonyAudioRouting::TAudioOutput aOutput, TBool aShowNote)
1.167 + {
1.168 + TELAUDRTNG_RDEBUG1(_L("[TELAUDRTNG]\t RTelephonyAudioRoutingSession[%x]::SetOutput "),this);
1.169 +
1.170 + TELAUDRTNG_RDEBUG1(_L("[TELAUDRTNG]\t RTelephonyAudioRoutingSession::SetOutput: ShowNote = %d "), aShowNote);
1.171 +
1.172 + iRequests[KReqSetOutput]->Cancel();
1.173 +
1.174 + iCurrentAudioOutputPkg() = aOutput;
1.175 + iPreviousAudioOutputPkg() = CTelephonyAudioRouting::ENone;
1.176 + iErrPkg() = KErrNone;
1.177 + iShowNoteModePkg() = aShowNote;
1.178 +
1.179 + iRequests[KReqSetOutput]->SetActive();
1.180 + SendReceive(ETelAudRtngServDoSetOutput, TIpcArgs(&iCurrentAudioOutputPkg, &iPreviousAudioOutputPkg, &iErrPkg, &iShowNoteModePkg), iRequests[KReqSetOutput]->iStatus);
1.181 +
1.182 + }
1.183 +
1.184 +// -----------------------------------------------------------------------------
1.185 +// RTelephonyAudioRoutingSession::GetAvailableOutputsL
1.186 +// Get the available audio outputs from the server.
1.187 +// (other items were commented in a header).
1.188 +// -----------------------------------------------------------------------------
1.189 +//
1.190 +EXPORT_C void RTelephonyAudioRoutingSession::GetAvailableOutputsL()
1.191 + {
1.192 + TELAUDRTNG_RDEBUG1(_L("[TELAUDRTNG]\t RTelephonyAudioRoutingSession[%x]::GetAvailableOutputsL"),this);
1.193 + iAvailableOutputs.Reset();
1.194 +
1.195 + TPckgBuf<TInt> numOfOutputs;
1.196 + User::LeaveIfError(SendReceive(ETelAudRtngServGetNoOutputs, TIpcArgs(&numOfOutputs)));
1.197 + HBufC8* buf = HBufC8::NewLC(numOfOutputs()*sizeof(CTelephonyAudioRouting::TAudioOutput));
1.198 + TPtr8 ptr = buf->Des();
1.199 +
1.200 + User::LeaveIfError(SendReceive(ETelAudRtngServGetAvailableOutputs, TIpcArgs(&ptr)));
1.201 + RDesReadStream stream(ptr);
1.202 + CleanupClosePushL(stream);
1.203 +
1.204 + for (TInt i=0; i<numOfOutputs(); i++)
1.205 + {
1.206 + TInt err = iAvailableOutputs.Append((CTelephonyAudioRouting::TAudioOutput)stream.ReadInt32L());
1.207 + if (err)
1.208 + {
1.209 + iAvailableOutputs.Reset();
1.210 + User::Leave(err);
1.211 + }
1.212 + }
1.213 +
1.214 + CleanupStack::PopAndDestroy(2, buf);//stream, buf
1.215 +
1.216 + }
1.217 +
1.218 +// -----------------------------------------------------------------------------
1.219 +// RTelephonyAudioRoutingSession::NotifyIfOutputChanged
1.220 +// Send a request to server to receive notification whenever current audio output changes.
1.221 +// (other items were commented in a header).
1.222 +// -----------------------------------------------------------------------------
1.223 +//
1.224 +EXPORT_C void RTelephonyAudioRoutingSession::NotifyIfOutputChanged()
1.225 + {
1.226 + TELAUDRTNG_RDEBUG1(_L("[TELAUDRTNG]\t RTelephonyAudioRoutingSession[%x]::NotifyIfOutputChanged"),this);
1.227 +
1.228 + iRequests[KReqNotifyIfOutputChanged]->Cancel();
1.229 +
1.230 + SendReceive(ETelAudRtngServNotifyIfOutputChanged, TIpcArgs(&iCurrentAudioOutputPkg, &iPreviousAudioOutputPkg, &iErrPkg, &iShowNoteModePkg), iRequests[KReqNotifyIfOutputChanged]->iStatus);
1.231 + iRequests[KReqNotifyIfOutputChanged]->SetActive();
1.232 +
1.233 + }
1.234 +
1.235 +// -----------------------------------------------------------------------------
1.236 +// RTelephonyAudioRoutingSession::NotifyIfAvailableOutputsChanged
1.237 +// Send a request to server to receive notification whenever available audio output changes.
1.238 +// (other items were commented in a header).
1.239 +// -----------------------------------------------------------------------------
1.240 +//
1.241 +EXPORT_C void RTelephonyAudioRoutingSession::NotifyIfAvailableOutputsChanged()
1.242 + {
1.243 + TELAUDRTNG_RDEBUG1(_L("[TELAUDRTNG]\t RTelephonyAudioRoutingSession[%x]::NotifyIfAvailbleOutputsChanged"),this);
1.244 + iRequests[KReqNotifyIfAvailOutputsChanged]->Cancel();
1.245 +
1.246 + SendReceive(ETelAudRtngServNotifyIfAvailOutputsChanged, TIpcArgs(&iCurrentAudioOutputPkg), iRequests[KReqNotifyIfAvailOutputsChanged]->iStatus);
1.247 + iRequests[KReqNotifyIfAvailOutputsChanged]->SetActive();
1.248 +
1.249 + }
1.250 +
1.251 +// -----------------------------------------------------------------------------
1.252 +// RTelephonyAudioRoutingSession::CancelRequest
1.253 +// Cancel a previously sent request.
1.254 +// aRequestOpcode = index into array as to which request object to cancel.
1.255 +// (other items were commented in a header).
1.256 +// -----------------------------------------------------------------------------
1.257 +//
1.258 +EXPORT_C void RTelephonyAudioRoutingSession::CancelRequest(TTelAudRtngServRqst aRequestOpcode)
1.259 + {
1.260 + TPckgBuf<TInt> request;
1.261 + request() = aRequestOpcode;
1.262 +
1.263 + TELAUDRTNG_RDEBUG1(_L("[TELAUDRTNG]\t CTelephonyAudioRoutingSession::CancelRequest Number: %d"), aRequestOpcode);
1.264 + SendReceive(ETelAudRtngServCancelRequest, TIpcArgs(&request));
1.265 +
1.266 + }
1.267 +
1.268 +// -----------------------------------------------------------------------------
1.269 +// RTelephonyAudioRoutingSession::CurrentAudioOutputPkg
1.270 +// Accessor method returns iCurrentAudioOutputPkg to caller.
1.271 +// (other items were commented in a header).
1.272 +// -----------------------------------------------------------------------------
1.273 +//
1.274 +EXPORT_C TPckgBuf<CTelephonyAudioRouting::TAudioOutput>& RTelephonyAudioRoutingSession::CurrentAudioOutputPkg()
1.275 + {
1.276 + return iCurrentAudioOutputPkg;
1.277 + }
1.278 +
1.279 +// -----------------------------------------------------------------------------
1.280 +// RTelephonyAudioRoutingSession::PreviousAudioOutputPkg
1.281 +// Accessor method returns iPreviousAudioOutputPkg to caller.
1.282 +// (other items were commented in a header).
1.283 +// -----------------------------------------------------------------------------
1.284 +//
1.285 +EXPORT_C TPckgBuf<CTelephonyAudioRouting::TAudioOutput>& RTelephonyAudioRoutingSession::PreviousAudioOutputPkg()
1.286 + {
1.287 + return iPreviousAudioOutputPkg;
1.288 + }
1.289 +
1.290 +// -----------------------------------------------------------------------------
1.291 +// RTelephonyAudioRoutingSession::ErrPkg
1.292 +// Accessor method returns iErrPkg to caller.
1.293 +// (other items were commented in a header).
1.294 +// -----------------------------------------------------------------------------
1.295 +//
1.296 +EXPORT_C TPckgBuf<TInt>& RTelephonyAudioRoutingSession::ErrPkg()
1.297 + {
1.298 + return iErrPkg;
1.299 + }
1.300 +
1.301 +// -----------------------------------------------------------------------------
1.302 +// RTelephonyAudioRoutingSession::AvailableOutputs
1.303 +// Accessor method returns iAvailableOutputs to caller.
1.304 +// (other items were commented in a header).
1.305 +// -----------------------------------------------------------------------------
1.306 +//
1.307 +EXPORT_C RArray<CTelephonyAudioRouting::TAudioOutput>& RTelephonyAudioRoutingSession::AvailableOutputs()
1.308 + {
1.309 + return iAvailableOutputs;
1.310 + }
1.311 +
1.312 +// -----------------------------------------------------------------------------
1.313 +// RTelephonyAudioRoutingSession::StartRequestHandlersL
1.314 +// Start asynchronous request handlers.
1.315 +// (other items were commented in a header).
1.316 +// -----------------------------------------------------------------------------
1.317 +//
1.318 +void RTelephonyAudioRoutingSession::StartRequestHandlersL(
1.319 + CTelephonyAudioRouting& aAudioRouting,
1.320 + MTelephonyAudioRoutingObserver& aObserver )
1.321 + {
1.322 +
1.323 + CTelephonyAudioRoutingRequest* req = NULL;
1.324 +
1.325 + req = CTelephonyAudioRoutingRequest::NewL(*this, aObserver, aAudioRouting, ETelAudRtngServDoSetOutput);
1.326 + User::LeaveIfError( iRequests.Append(req) );
1.327 +
1.328 + req = CTelephonyAudioRoutingRequest::NewL(*this, aObserver, aAudioRouting, ETelAudRtngServNotifyIfOutputChanged);
1.329 + User::LeaveIfError( iRequests.Append(req) );
1.330 +
1.331 + req = CTelephonyAudioRoutingRequest::NewL(*this, aObserver, aAudioRouting, ETelAudRtngServNotifyIfAvailOutputsChanged);
1.332 + User::LeaveIfError( iRequests.Append(req) );
1.333 +
1.334 + }
1.335 +
1.336 +// -----------------------------------------------------------------------------
1.337 +// RTelephonyAudioRoutingSession::SetShowNoteMode
1.338 +// Sets session flag iOkToGetShowNoteMode to indicate that it is OK to retrieve value of
1.339 +// iShowNoteMode from the server.
1.340 +// (other items were commented in a header).
1.341 +// -----------------------------------------------------------------------------
1.342 +//
1.343 +EXPORT_C void RTelephonyAudioRoutingSession::SetShowNoteMode()
1.344 + {
1.345 + TELAUDRTNG_RDEBUG1(_L("[TELAUDRTNG]\t RTelephonyAudioRoutingSession[%x]::SetShowNoteMode"),this);
1.346 + iOkToGetShowNoteMode = ETrue;
1.347 + }
1.348 +
1.349 +// -----------------------------------------------------------------------------
1.350 +// RTelephonyAudioRoutingSession::ShowNoteMode
1.351 +// Provide caller with value of iShowNoteModePkg from server
1.352 +// (other items were commented in a header).
1.353 +// -----------------------------------------------------------------------------
1.354 +//
1.355 +EXPORT_C TPckgBuf<TBool>& RTelephonyAudioRoutingSession::ShowNoteMode()
1.356 + {
1.357 + TELAUDRTNG_RDEBUG1(_L("[TELAUDRTNG]\t RTelephonyAudioRoutingSession[%x]::ShowNoteMode"),this);
1.358 +
1.359 + return iShowNoteModePkg;
1.360 + }
1.361 +
1.362 +
1.363 +// -----------------------------------------------------------------------------
1.364 +// RTelephonyAudioRoutingSession::ResetShowNoteMode
1.365 +// Resets the session flag iOkToGetShowNoteMode to indicate it's not ok to retrieve
1.366 +// value of iSetShowNoteMode from server. (Client can only retrieve it once after a
1.367 +// SetOutputComplete call). (But it can be set internally from an OutputChanged call).
1.368 +// (other items were commented in a header).
1.369 +// -----------------------------------------------------------------------------
1.370 +//
1.371 +EXPORT_C void RTelephonyAudioRoutingSession::ResetShowNoteMode()
1.372 + {
1.373 + TELAUDRTNG_RDEBUG1(_L("[TELAUDRTNG]\t RTelephonyAudioRoutingSession[%x]::ResetShowNoteMode"),this);
1.374 + iOkToGetShowNoteMode = EFalse;
1.375 + }
1.376 +// -----------------------------------------------------------------------------
1.377 +// RTelephonyAudioRoutingSession::OkToGetShowNoteMode
1.378 +// Provide caller with value of iOkToGetShowNoteMode
1.379 +// (other items were commented in a header).
1.380 +// -----------------------------------------------------------------------------
1.381 +//
1.382 +EXPORT_C TBool RTelephonyAudioRoutingSession::OkToGetShowNoteMode()
1.383 + {
1.384 + return iOkToGetShowNoteMode;
1.385 + }
1.386 +// End of File