2 * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 * @author Karol Majewski (k.majewski@samsung.com)
22 #ifndef WRTDEVICEAPIS_COMMONS_IEVENT_H_
23 #define WRTDEVICEAPIS_COMMONS_IEVENT_H_
26 #include <dpl/event/controller.h>
27 #include <dpl/mutex.h>
28 #include <dpl/shared_ptr.h>
29 #include <Commons/Exception.h>
30 #include <Commons/EventReceiver.h>
32 namespace WrtDeviceApis {
34 class IEventPrivateData
37 virtual ~IEventPrivateData()
41 class IEventController
43 DPL::SharedPtr<IEventPrivateData> m_privateData;
46 virtual void waitTillProcessed() = 0;
47 virtual void waitForAnswer() = 0;
48 virtual bool cancelRequest()
52 virtual bool changeCallToSynchronous() = 0;
53 virtual ~IEventController()
57 const DPL::SharedPtr<IEventPrivateData> &privateData)
59 m_privateData = privateData;
61 const DPL::SharedPtr<IEventPrivateData>& getPrivateData()
66 typedef DPL::SharedPtr<IEventController> IEventControllerPtr;
70 class IEvent : /*private DPL::WaitableEvent, */ public IEventController
73 friend class EventRequestReceiver<Super>;
74 friend class EventAnswerReceiver<Super>;
75 friend class SignalEventCall<Super>;
76 friend class EventReceiver<Super>;
80 HANDLING_NOT_SET = -1,
81 HANDLING_SYNCHRONOUS = 0,
82 HANDLING_ASYNCHRONOUS = 1,
83 HANDLING_SYNCHRONOUS_MANUAL_ANSWER = 2,
84 HANDLING_ASYNCHRONOUS_MANUAL_ANSWER = 3
91 STATE_REQUEST_RECEIVED,
93 STATE_ANSWER_RECEIVED,
95 STATE_CHANGED_TO_SYNCHRONOUS
102 m_state = STATE_ENDED;
103 m_exceptionCode = Commons::ExceptionCodes::EventCancelledException;
104 //if someone is waiting
105 signalSynchronousEventFlag();
109 DPL::Mutex m_stateMutex;
111 HandlingType m_handlingType;
112 EventAnswerReceiver< Super > *m_remoteController;
113 Commons::ExceptionCodes::Enumeration m_exceptionCode;
114 DPL::WaitableEvent *m_synchronousEventFlag;
115 DPL::WaitableEvent *m_finishedFlag;
116 DPL::WaitableEvent *m_cancelStatusFlag;
118 bool m_cancelAllowed;
121 m_state(STATE_INITIAL),
122 m_handlingType(HANDLING_NOT_SET),
123 m_remoteController(NULL),
124 m_exceptionCode(Commons::ExceptionCodes::None),
125 m_synchronousEventFlag(NULL),
126 m_finishedFlag(NULL),
127 m_cancelStatusFlag(NULL),
129 m_cancelAllowed(false)
132 virtual void waitForAnswer()
134 assert(HANDLING_SYNCHRONOUS == m_handlingType);
135 DPL::WaitForSingleHandle(m_synchronousEventFlag->GetHandle());
137 DPL::Mutex::ScopedLock lock(&m_stateMutex);
138 m_state = STATE_ENDED;
140 signalFinishedFlag();
141 LogDebug("deleting m_processEvent");
142 delete m_synchronousEventFlag;
143 m_synchronousEventFlag = NULL;
146 void signalFinishedFlag()
148 if (m_finishedFlag) {
149 m_finishedFlag->Signal();
153 DPL::WaitableEvent &getFinishedFlag()
155 if (!m_finishedFlag) {
156 m_finishedFlag = new DPL::WaitableEvent();
158 return *m_finishedFlag;
161 void signalCancelStatusFlag()
163 LogDebug("signaling cancel");
164 if (m_cancelStatusFlag) {
165 m_cancelStatusFlag->Signal();
169 DPL::WaitableEvent &getCancelStatusFlag()
171 if (!m_cancelStatusFlag) {
172 m_cancelStatusFlag = new DPL::WaitableEvent();
174 return *m_cancelStatusFlag;
177 void signalSynchronousEventFlag()
179 if (m_synchronousEventFlag) {
180 m_synchronousEventFlag->Signal();
187 * Gets the answer receiver pointer.
189 EventAnswerReceiver< Super > * getAnswerReceiverRef() const
191 return m_remoteController;
196 delete m_cancelStatusFlag;
197 delete m_finishedFlag;
198 delete m_synchronousEventFlag;
201 virtual bool changeCallToSynchronous()
203 return setForSynchronousCall();
206 virtual void waitTillProcessed()
208 DPL::WaitForSingleHandle(getFinishedFlag().GetHandle());
209 delete m_finishedFlag;
210 m_finishedFlag = NULL;
213 virtual void clearOnCancel()
216 Commons::ExceptionCodes::Enumeration getExceptionCode() const
218 return m_exceptionCode;
220 void setExceptionCode(Commons::ExceptionCodes::Enumeration exceptionCode)
222 m_exceptionCode = exceptionCode;
225 short getHandlingType() const
227 return m_handlingType;
230 virtual bool setForSynchronousCall()
232 DPL::Mutex::ScopedLock lock(&m_stateMutex);
237 case STATE_ANSWER_SEND:
238 m_state = STATE_CHANGED_TO_SYNCHRONOUS;
240 case STATE_ANSWER_RECEIVED:
246 m_handlingType = HANDLING_SYNCHRONOUS;
250 virtual bool setForAsynchronousCall(
251 EventAnswerReceiver< Super > *remoteController)
253 DPL::Mutex::ScopedLock lock(&m_stateMutex);
258 case STATE_ANSWER_SEND:
259 case STATE_ANSWER_RECEIVED:
265 m_handlingType = HANDLING_ASYNCHRONOUS;
266 m_remoteController = remoteController;
271 * Normally, after invoking OnRequestReceived in RequestReceiver, the answer
272 * is being send automatically (after flow leaves OnRequestReceived).
273 * After calling this function, the answer is not being send automatically,
274 * you need to call ManualAnswer to send event back.
275 * It works both in asynchronous and synchronous handling type.
277 virtual bool switchToManualAnswer()
280 m_handlingType == HANDLING_ASYNCHRONOUS || m_handlingType ==
281 HANDLING_SYNCHRONOUS);
283 DPL::Mutex::ScopedLock lock(&m_stateMutex);
288 case STATE_ANSWER_SEND:
289 case STATE_ANSWER_RECEIVED:
296 switch (m_handlingType) {
297 case HANDLING_ASYNCHRONOUS:
298 m_handlingType = HANDLING_ASYNCHRONOUS_MANUAL_ANSWER;
300 case HANDLING_SYNCHRONOUS:
301 m_handlingType = HANDLING_SYNCHRONOUS_MANUAL_ANSWER;
309 bool checkCancelled()
311 //DPL::Mutex::ScopedLock lock(&m_stateMutex);
317 //DPL::Mutex::ScopedLock lock(&m_stateMutex);
319 Throw(Commons::EventCancelledException);
323 bool getCancelAllowed() const
325 return m_cancelAllowed;
328 void setCancelAllowed(bool cancelAllowed)
330 m_cancelAllowed = cancelAllowed;
335 LogDebug("trying to cancel");
337 HANDLING_ASYNCHRONOUS == m_handlingType ||
338 HANDLING_ASYNCHRONOUS_MANUAL_ANSWER == m_handlingType);
340 DPL::Mutex::ScopedLock lock(&m_stateMutex);
347 case STATE_ANSWER_SEND:
348 LogDebug("cancelling");
350 delete m_cancelStatusFlag;
351 m_cancelStatusFlag = NULL;
352 return m_cancelAllowed;
353 case STATE_ANSWER_RECEIVED:
359 LogDebug("cancelling");
362 LogDebug("waiting for cancel flag");
364 #if 0 // temporary fix for ApplicationLaunchAppControl eventhandling
365 DPL::WaitForSingleHandle(getCancelStatusFlag().GetHandle());
367 delete m_cancelStatusFlag;
368 m_cancelStatusFlag = NULL;
369 return m_cancelAllowed;
373 } // WrtDeviceApisCommon
375 #endif /* WRTDEVICEAPIS_COMMONS_IEVENT_H_ */