1 /*
2  * Copyright (c) 2021-2024 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_PROXY_H
17 #define FOUNDATION_EVENT_CESFWK_INNERKITS_INCLUDE_COMMON_EVENT_PROXY_H
18 
19 #include "common_event_service_ipc_interface_code.h"
20 #include "icommon_event.h"
21 #include "iremote_proxy.h"
22 
23 namespace OHOS {
24 namespace EventFwk {
25 class CommonEventProxy : public IRemoteProxy<ICommonEvent> {
26 public:
27     /**
28      * Constructor.
29      *
30      * @param object Indicates the remote object
31      */
32     explicit CommonEventProxy(const sptr<IRemoteObject> &object);
33 
34     virtual ~CommonEventProxy();
35 
36     /**
37      * Publishes a common event.
38      *
39      * @param event Indicates the common event data.
40      * @param publishInfo Indicates the publish info.
41      * @param commonEventListener Indicates the last subscriber to receive the event.
42      * @param userId Indicates the user ID.
43      * @return Returns true if success; false otherwise.
44      */
45     int32_t PublishCommonEvent(const CommonEventData &event, const CommonEventPublishInfo &publishInfo,
46         const sptr<IRemoteObject> &commonEventListener, const int32_t &userId) override;
47 
48     /**
49      * Publishes a common event.
50      *
51      * @param event Indicates the common event data
52      * @param publishInfo Indicates the publish info
53      * @param commonEventListener Indicates the last subscriber to receive the event
54      * @param uid Indicates the uid
55      * @param callerToken Indicates the caller token
56      * @param userId Indicates the user ID
57      * @return Returns true if success; false otherwise.
58      */
59     bool PublishCommonEvent(const CommonEventData &event, const CommonEventPublishInfo &publishinfo,
60         const sptr<IRemoteObject> &commonEventListener, const uid_t &uid, const int32_t &callerToken,
61         const int32_t &userId) override;
62 
63     /**
64      * Subscribes to common events.
65      *
66      * @param subscribeInfo Indicates the subscribe information
67      * @param commonEventListener Indicates the subscriber object
68      * @param instanceKey Indicates the instance key
69      * @return Returns true if successful; false otherwise.
70      */
71     int32_t SubscribeCommonEvent(const CommonEventSubscribeInfo &subscribeInfo,
72         const sptr<IRemoteObject> &commonEventListener, const int32_t instanceKey = 0) override;
73 
74     /**
75      * Unsubscribes from common events.
76      *
77      * @param commonEventListener Indicates the subscriber object
78      * @return Returns true if successful; false otherwise.
79      */
80     int32_t UnsubscribeCommonEvent(const sptr<IRemoteObject> &commonEventListener) override;
81 
82     /**
83      * Gets the current sticky common event
84      *
85      * @param event Indicates the common event.
86      * @param eventData Indicates the common event data.
87      * @return Returns true if successful; false otherwise.
88      */
89     bool GetStickyCommonEvent(const std::string &event, CommonEventData &eventData) override;
90 
91     /**
92      * Dumps the state for common event service.
93      *
94      * @param dumpType Indicates the dump type.
95      * @param event Indicates the specified event.
96      * @param userId Indicates the user id.
97      * @param state Indicates the output result.
98      * @return Returns true if successful; false otherwise.
99      */
100     bool DumpState(const uint8_t &dumpType, const std::string &event, const int32_t &userId,
101         std::vector<std::string> &state) override;
102 
103     /**
104      * Finishes the receiver for the ordered common event.
105      *
106      * @param proxy Indicates the current subscriber object.
107      * @param code Indicates the result code.
108      * @param receiverData Indicates the result data.
109      * @param abortEvent Indicates whether the current ordered common event should be aborted.
110      * @return Returns true if successful; false otherwise.
111      */
112     bool FinishReceiver(const sptr<IRemoteObject> &proxy, const int32_t &code, const std::string &receiverData,
113         const bool &abortEvent) override;
114 
115     /**
116      * Freezes the specified process.
117      *
118      * @param uid Indicates the uid of frozen process.
119      * @return Returns true if successful; false otherwise.
120      */
121     bool Freeze(const uid_t &uid) override;
122 
123     /**
124      * Unfreezes the specified process.
125      *
126      * @param uid Indicates the uid of unfrozen process.
127      * @return Returns true if successful; false otherwise.
128      */
129     bool Unfreeze(const uid_t &uid) override;
130 
131     /**
132      * Unfreezes all frozen applications.
133      *
134      * @return Returns true if successful; false otherwise.
135      */
136     bool UnfreezeAll() override;
137 
138     /**
139      * Remove sticky common event.
140      *
141      * @param event Name of the common event.
142      * @return Returns ERR_OK if success; otherwise failed.
143      */
144     int32_t RemoveStickyCommonEvent(const std::string &event) override;
145 
146     /**
147      * Set Static Subscriber State.
148      *
149      * @param enable static subscriber state.
150      * @return Returns ERR_OK if success; otherwise failed.
151      */
152     int32_t SetStaticSubscriberState(bool enable) override;
153 
154     /**
155      * Set static subscriber state.
156      *
157      * @param events Static subscriber event name.
158      * @param enable Static subscriber state.
159      * @return Returns ERR_OK if success; otherwise failed.
160      */
161     int32_t SetStaticSubscriberState(const std::vector<std::string> &events, bool enable) override;
162 
163     /**
164     * Set freeze status of process.
165     *
166     * @param pidList Indicates the list of process id.
167     * @param isFreeze Indicates wheather the process is freezed.
168     * @return Returns true if successful; false otherwise.
169     */
170     bool SetFreezeStatus(std::set<int> pidList, bool isFreeze) override;
171 
172 private:
173     bool SendRequest(CommonEventInterfaceCode code, MessageParcel &data, MessageParcel &reply);
174 
175 private:
176     static inline BrokerDelegator<CommonEventProxy> delegator_;
177 };
178 }  // namespace EventFwk
179 }  // namespace OHOS
180 
181 #endif  // FOUNDATION_EVENT_CESFWK_INNERKITS_INCLUDE_COMMON_EVENT_PROXY_H
182