be4f5ca23c5a5eb3de9f6df52b7d6d0c501197ad
[framework/osp/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 _AppContext;
42
43 /**
44  * @class       AppWidgetManagerService
45  * @brief       The AppWidgetManagerService class handles request from viewer and provider applications, and manages context of connected application.
46  */
47 class AppWidgetManagerService
48         :public Tizen::Shell::App::_AppWidgetManagerStub
49          ,public Tizen::Base::Runtime::ITimerEventListener
50          ,public Tizen::System::ISettingEventListener
51 {
52 public:
53         static AppWidgetManagerService* GetInstance(void);
54         static AppWidgetManagerService* CreateInstance(const char* pServiceIdForCoreDaemon);
55         result AddAppWidget(const Tizen::Base::String& userInfo, const Tizen::Base::String& appId, const Tizen::Base::String& instanceId, int width, int height, int period, int priority);
56         result RequestUpdate(_AppWidgetContext* pAppWidgetContext, const Tizen::Base::String& argument) const;
57         void OnUserEventReceivedN(RequestId reqId, Tizen::Base::Collection::IList* pArgs);
58
59 private:
60         AppWidgetManagerService(void);
61         virtual ~AppWidgetManagerService(void);
62         result Construct(const char* pServiceIdForCoreDaemon);
63
64         result InitializeCoreDaemonEventReceiver(const char* pServiceIdForCoreDaemon);
65         result DeinitializeCoreDaemonEventReceiver(void);
66
67         // core daemon callbacks
68         static int OnAppWidgetServiceConnected(struct event_arg *arg, void* data);
69         static int OnAppWidgetServiceCDisconnected(struct event_arg *arg, void* data);
70         static int OnAppWidgetCreate(struct event_arg *arg, int *width, int *height, double *priority, void* data);
71         static int OnAppWidgetDestroy(struct event_arg *arg, void* data);
72         static int OnAppWidgetUpdate(struct event_arg *arg, void* data);
73         static int OnAppWidgetPopupCreate(struct event_arg *arg, void* data);
74         static int OnAppWidgetPopupDestroy(struct event_arg *arg, void* data);
75         static int OnAppWidgetBackground(struct event_arg *arg, void* data);
76         static int OnAppWidgetForeground(struct event_arg *arg, void* data);
77         static int OnAppWidgetBackgroundAll(struct event_arg *arg, void* data);
78         static int OnAppWidgetForegroundAll(struct event_arg *arg, void* data);
79         static int OnAppWidgetClick(struct event_arg *arg, void* data);
80         static int OnAppWidgetResize(struct event_arg *arg, void* data);
81         static int OnAppWidgetPeriodChanged(struct event_arg *arg, void* data);
82         static int OnAppWidgetRecreate(struct event_arg *arg, void* data);
83
84         // stub implementations(request for app)
85         virtual result RequestUpdate(const Tizen::App::AppId& appId, const Tizen::Base::String& providerName, const Tizen::Base::String& argument) const;
86         virtual result RequestUpdateInstance(const Tizen::App::AppId& appId, const Tizen::Base::String& instanceId, const Tizen::Base::String& argument);
87
88         // stub implementations(request for buffer)
89         virtual result AcquireRemoteBuffer(const Tizen::App::AppId& appId, const Tizen::Base::String& instanceId, int w, int h, int& bufferId);
90         virtual result AcquireRemoteBufferForPD(const Tizen::App::AppId& appId, const Tizen::Base::String& instanceId, int w, int h, int& bufferId);
91         virtual result SyncRemoteBuffer(const Tizen::App::AppId& appId, const Tizen::Base::String& instanceId, int width, int height);
92         virtual result SyncRemoteBufferForPD(const Tizen::App::AppId& appId, const Tizen::Base::String& instanceId);
93         virtual result ReleaseRemoteBuffer(const Tizen::App::AppId& appId, const Tizen::Base::String& instanceId);
94         virtual result ReleaseRemoteBufferForPD(const Tizen::App::AppId& appId, const Tizen::Base::String& instanceId);
95         virtual result SendAccessStatus(const Tizen::App::AppId& appId, const Tizen::Base::String& instanceId, int accessStatus);
96
97         // stub implementations(response)
98         virtual result RequestProviderCount(const Tizen::App::AppId& appId, const Tizen::Base::String& instanceId, int& providerCount);
99         virtual result SendResult(const Tizen::App::AppId& appId, const Tizen::Base::String& instanceId, bool isSucceeded);
100
101         // _IIpcServerEventListener
102         virtual void OnIpcClientConnected(const Tizen::Io::_IpcServer& server, int clientId);
103         virtual void OnIpcClientDisconnected(const Tizen::Io::_IpcServer&server, int clientId);
104
105         // ISettingEventListener
106         virtual void OnSettingChanged(Tizen::Base::String &     key);
107
108         // helpers
109         _AppContext* FindAppContext(const Tizen::App::AppId& appId) const;
110         _AppWidgetContext* FindAppWidget(const Tizen::App::AppId& appId, const Tizen::Base::String& instanceId) const;
111         void StartPingTimer(void);
112         virtual void OnTimerExpired(Tizen::Base::Runtime::Timer& timer);
113         result RequestUpdateAllSuspened(void) const;
114
115 private:
116         static AppWidgetManagerService* __pTheInstance;
117         Tizen::Base::Collection::HashMapT<Tizen::Base::String, _AppContext*> __appContextList;
118         Tizen::Base::Runtime::Timer __pingTimer;
119 };      // class AppWidgetManagerService
120
121 class _AppWidgetHelper
122 {
123 public:
124         static Tizen::App::AppId ExtractAppId(const Tizen::Base::String& providerId);
125         static Tizen::Base::String ExtractProviderName(const Tizen::Base::String& providerId);
126 }; // class AppWidgetHelper
127
128 }}} // Tizen::Shell::App
129
130 #endif // _FSHELL_INTERNAL_APPWIDGET_MANAGER_SERVICE_H_