• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2021-2025 Huawei Device Co., Ltd.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 
16 #ifndef FOUNDATION_EVENT_CESFWK_INNERKITS_INCLUDE_COMMON_EVENT_LISTENER_H
17 #define FOUNDATION_EVENT_CESFWK_INNERKITS_INCLUDE_COMMON_EVENT_LISTENER_H
18 
19 #include <mutex>
20 
21 #include "common_event_subscriber.h"
22 #include "event_handler.h"
23 #include "event_receive_stub.h"
24 
25 namespace OHOS {
26 namespace EventFwk {
27 class CommonEventListener : public EventReceiveStub {
28 public:
29     using EventHandler = OHOS::AppExecFwk::EventHandler;
30     using EventRunner = OHOS::AppExecFwk::EventRunner;
31 
32     /**
33      * Constructor.
34      *
35      * @param commonEventSubscriber the CommonEventSubscriber object
36      */
37     explicit CommonEventListener(const std::shared_ptr<CommonEventSubscriber> &commonEventSubscriber);
38 
39     virtual ~CommonEventListener();
40 
41     /**
42      * Notifies event.
43      *
44      * @param data Indicates the common event data.
45      * @param ordered Indicates whether it is an ordered common event.
46      * @param sticky Indicates whether it is a sticky common event.
47      */
48     ErrCode NotifyEvent(const CommonEventData &data, bool ordered, bool sticky) override;
49 
50     /**
51      * Stops to receive events.
52      *
53      */
54     void Stop();
55 
56     int32_t CallbackEnter([[maybe_unused]] uint32_t code) override;
57     int32_t CallbackExit([[maybe_unused]] uint32_t code, [[maybe_unused]] int32_t result) override;
58 
59 private:
60     ErrCode Init();
61 
62     std::shared_ptr<EventRunner> GetCommonRunner();
63 
64     void InitListenerQueue();
65 
66     bool IsReady();
67 
68     void OnReceiveEvent(const CommonEventData &commonEventData, const bool &ordered, const bool &sticky);
69 
70 public:
71     static std::shared_ptr<EventRunner> commonRunner_;
72 
73 private:
74     std::mutex mutex_;
75     static std::mutex onRemoteRequestMutex_;
76     std::shared_ptr<CommonEventSubscriber> commonEventSubscriber_;
77     std::shared_ptr<EventRunner> runner_;
78     std::shared_ptr<EventHandler> handler_;
79     void *listenerQueue_ = nullptr;
80 };
81 }  // namespace EventFwk
82 }  // namespace OHOS
83 
84 #endif  // FOUNDATION_EVENT_CESFWK_INNERKITS_INCLUDE_COMMON_EVENT_LISTENER_H