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