modify method names to give consitancy
[platform/framework/native/appwidget-service.git] / inc / FShell_AppWidgetManagerService.h
1 //
2 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
3 //
4 // Licensed under the Flora License, Version 1.1 (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
7 //
8 //     http://floralicense.org/license/
9 //
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.
15 //
16
17 /**
18  * @file        FShell_AppWidgetManagerService.h
19  * @brief       This is the header file for the %AppWidgetManagerService class.
20  *
21  * This header file contains the declarations of the %AppWidgetManagerService class.
22  */
23
24 #ifndef _FSHELL_INTERNAL_APPWIDGET_MANAGER_SERVICE_H_
25 #define _FSHELL_INTERNAL_APPWIDGET_MANAGER_SERVICE_H_
26
27 #include <FBaseRtTimer.h>
28 #include <FBaseRtThread.h>
29 #include <FBaseColHashMapT.h>
30 #include <FSysISettingEventListener.h>
31 #include "FShell_AppWidgetContext.h"
32 #include "FShell_AppWidgetManagerStub.h"
33
34 namespace Tizen { namespace Base  { namespace Collection
35 {
36 class IList;
37 }}}
38
39 namespace Tizen { namespace Shell  { namespace App {
40
41 class AppWidgetManagerService
42         :public Tizen::Shell::App::_AppWidgetManagerStub
43          ,public Tizen::Base::Runtime::ITimerEventListener
44          ,public Tizen::System::ISettingEventListener
45 {
46 public:
47         static AppWidgetManagerService* GetInstance(void);
48         static AppWidgetManagerService* CreateInstance(const char* pServiceIdForCoreDaemon);
49         _AppWidgetContext* AddAppWidget(const Tizen::Base::String& userInfo, const Tizen::Base::String& appId, const Tizen::Base::String& instanceId, int width, int height, int period, int priority);
50         result RemoveAppWidget(const char* pProviderId, const char* pId);
51         result RequestUpdate(_AppWidgetContext* pAppWidgetContext, const Tizen::Base::String& argument);
52         int GetProviderCount(const Tizen::Base::String& appId) const;
53
54 private:
55         result Construct(const char* pServiceIdForCoreDaemon);
56         result InitializeCoreDaemonEventReceiver(const char* pServiceIdForCoreDaemon);
57         result DeinitializeCoreDaemonEventReceiver(void);
58
59         // core daemon callbacks
60         static int AppWidgetConnected(struct event_arg *arg, void* data);
61         static int AppWidgetDisconnected(struct event_arg *arg, void* data);
62         static int OnAppWidgetCreate(struct event_arg *arg, int *width, int *height, double *priority, void* data);
63         static int OnAppWidgetDestroy(struct event_arg *arg, void* data);
64         static int OnAppWidgetUpdate(struct event_arg *arg, void* data);
65         static int OnAppWidgetPopupCreate(struct event_arg *arg, void* data);
66         static int OnAppWidgetPopupDestroy(struct event_arg *arg, void* data);
67         static int OnAppWidgetBackground(struct event_arg *arg, void* data);
68         static int OnAppWidgetForeground(struct event_arg *pArg, void* pData);
69         static int OnAppWidgetBackgroundAll(struct event_arg *arg, void* data);
70         static int OnAppWidgetForegroundAll(struct event_arg *pArg, void* pData);
71         static int OnAppWidgetClick(struct event_arg *arg, void* data);
72         static int OnAppWidgetResize(struct event_arg *arg, void* data);
73         static int OnAppWidgetPeriodChanged(struct event_arg *arg, void* data);
74         static int OnAppWidgetRecreate(struct event_arg *arg, void* data);
75
76         // stub implementations
77         virtual result RequestUpdate(const Tizen::App::AppId& appId, const Tizen::Base::String& providerName, const Tizen::Base::String& argument);
78         virtual result RequestUpdateInstance(const Tizen::Base::String& instanceId, const Tizen::Base::String& argument);
79         virtual result AcquireRemoteBuffer(const Tizen::App::AppId& appId, const Tizen::Base::String& instanceId, int w, int h, int& bufferId);
80         virtual result AcquireRemoteBufferForPD(const Tizen::App::AppId& appId, const Tizen::Base::String& instanceId, int w, int h, int& bufferId);
81         virtual result SyncRemoteBuffer(const Tizen::App::AppId& appId, const Tizen::Base::String& instanceId, int width, int height);
82         virtual result SyncRemoteBufferForPD(const Tizen::App::AppId& appId, const Tizen::Base::String& instanceId);
83         virtual result ReleaseRemoteBuffer(const Tizen::App::AppId& appId, const Tizen::Base::String& instanceId);
84         virtual result ReleaseRemoteBufferForPD(const Tizen::App::AppId& appId, const Tizen::Base::String& instanceId);
85         virtual result RequestProviderCount(const Tizen::App::AppId& appId, const Tizen::Base::String& instanceId, int& providerCount);
86         virtual result SendResult(const Tizen::App::AppId& appId, const Tizen::Base::String& instanceId, bool isSucceeded);
87         virtual result SendAccessStatus(const Tizen::App::AppId& appId, const Tizen::Base::String& instanceId, int accessStatus);
88
89         // internal functions
90         AppWidgetManagerService(void);
91         virtual ~AppWidgetManagerService(void);
92
93         // _IIpcServerEventListener
94         virtual void OnIpcClientConnected(const Tizen::Io::_IpcServer& server, int clientId);
95         virtual void OnIpcClientDisconnected(const Tizen::Io::_IpcServer&server, int clientId);
96
97         // ISettingEventListener
98         virtual void OnSettingChanged(Tizen::Base::String &     key);
99
100         // helpers
101         _AppWidgetContext* Find(const Tizen::Base::String& instanceId) const;
102         int UpdateAppWidgetsByProviderId(const Tizen::Base::String& appId);
103         result RequestPendingEvent(void);
104
105         void StartPingTimer(void);
106         virtual void OnTimerExpired(Tizen::Base::Runtime::Timer& timer);
107
108 private:
109         class _TaskHandlerThread
110                         : public Tizen::Base::Runtime::Thread
111         {
112         public:
113                 virtual ~_TaskHandlerThread(void);
114                 virtual void OnUserEventReceivedN(RequestId reqId, Tizen::Base::Collection::IList* pArgs);
115
116         };
117
118         static AppWidgetManagerService* __pTheInstance;
119         Tizen::Base::Collection::HashMapT<Tizen::Base::String, _AppWidgetContext*> __appWidgetContextList;
120         Tizen::Base::Collection::HashMapT<Tizen::Base::String, _AppContext*> __appContextList;
121         Tizen::Base::Runtime::Timer __pingTimer;
122         _TaskHandlerThread      __handlerThread;
123 };      // class AppWidgetManagerService
124
125 }}} // Tizen::Shell::App
126
127 #endif // _FSHELL_INTERNAL_APPWIDGET_MANAGER_SERVICE_H_