Skip to content

Commit

Permalink
Add SubscribeButtonRequest and SubscribeButtonResponse classes
Browse files Browse the repository at this point in the history
  • Loading branch information
ychernysheva committed Jul 6, 2021
1 parent 5ecfd16 commit 1304547
Show file tree
Hide file tree
Showing 20 changed files with 675 additions and 77 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@
#include "application_manager/hmi_state.h"
#include "application_manager/message.h"
#include "connection_handler/device.h"
#include "interfaces/HMI_API.h"
#include "interfaces/MOBILE_API.h"
#include "protocol_handler/protocol_handler.h"
#include "smart_objects/smart_object.h"
Expand Down Expand Up @@ -106,6 +107,8 @@ struct AppFile {
mobile_apis::FileType::eType file_type;
};
typedef std::map<std::string, AppFile> AppFilesMap;
typedef std::map<int32_t, hmi_apis::Common_ButtonName::eType>
ButtonSubscriptionsMap;
class InitialApplicationData {
public:
virtual ~InitialApplicationData() {}
Expand Down Expand Up @@ -1160,6 +1163,29 @@ class Application : public virtual InitialApplicationData,
*/
virtual const std::list<AppExtensionPtr>& Extensions() const = 0;

/**
* @brief Get map of pending button subscription requests correlation ids
* to button names
* @return pending button subscriptions map
*/
virtual const ButtonSubscriptionsMap& PendingButtonSubscriptions() const = 0;

/**
* @brief Add pending button subscription request
* @param correlation_id - correlation id of subscription request
* @param button_name - enum value indicating button name
*/
virtual void AddPendingButtonSubscription(
const int32_t correlation_id,
const hmi_apis::Common_ButtonName::eType button_name) = 0;

/**
* @brief Remove pending button subscription request
* @param correlation_id - correlation id of subscription request
*/
virtual void RemovePendingSubscriptionButton(
const int32_t correlation_id) = 0;

/**
* @brief Get cloud app endpoint for websocket connection
* @return cloud app endpoint
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -510,6 +510,14 @@ class ApplicationImpl : public virtual Application,

const smart_objects::SmartObject& get_user_location() const OVERRIDE;

const ButtonSubscriptionsMap& PendingButtonSubscriptions() const OVERRIDE;

void AddPendingButtonSubscription(
const int32_t correlation_id,
const hmi_apis::Common_ButtonName::eType button_name) OVERRIDE;

void RemovePendingSubscriptionButton(const int32_t correlation_id) OVERRIDE;

protected:
/**
* @brief Clean up application folder. Persistent files will stay
Expand Down Expand Up @@ -580,6 +588,7 @@ class ApplicationImpl : public virtual Application,
sync_primitives::Lock video_streaming_suspended_lock_;
sync_primitives::Lock audio_streaming_suspended_lock_;
sync_primitives::Lock streaming_stop_lock_;
sync_primitives::Lock pending_button_subscription_lock_;

bool is_app_allowed_;
bool is_app_data_resumption_allowed_;
Expand All @@ -600,6 +609,7 @@ class ApplicationImpl : public virtual Application,
std::string bundle_id_;
AppFilesMap app_files_;
std::set<mobile_apis::ButtonName::eType> subscribed_buttons_;
ButtonSubscriptionsMap pending_button_subscriptions_;
UsageStatistics usage_report_;
HelpPromptManagerImpl help_prompt_manager_impl_;
protocol_handler::MajorProtocolVersion protocol_version_;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -320,6 +320,21 @@ class MessageHelper {
ApplicationManager& app_mngr,
const ButtonSubscriptions& button_subscriptions);

/**
* @brief Creates button subscription request to hmi
* @param app_id id of application for which request should be created
* @param button_name button to be subscribed
* @param function_id function ID
* @param app_mngr reference to application manager
* @return Smart object with fulfilled request
*/
static smart_objects::SmartObjectSPtr
CreateButtonSubscriptionHandlingRequestToHmi(
const uint32_t app_id,
const hmi_apis::Common_ButtonName::eType button_name,
const hmi_apis::FunctionID::eType function_id,
ApplicationManager& app_mngr);

static void SendAppDataToHMI(ApplicationConstSharedPtr app,
ApplicationManager& app_man);
static void SendGlobalPropertiesToHMI(ApplicationConstSharedPtr app,
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
/*
* Copyright (c) 2021, Ford Motor Company
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following
* disclaimer in the documentation and/or other materials provided with the
* distribution.
*
* Neither the name of the Ford Motor Company nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/

#ifndef SRC_COMPONENTS_APPLICATION_MANAGER_RPC_PLUGINS_SDL_RPC_PLUGIN_INCLUDE_SDL_RPC_PLUGIN_COMMANDS_HMI_SUBSCRIBE_BUTTON_REQUEST_H_
#define SRC_COMPONENTS_APPLICATION_MANAGER_RPC_PLUGINS_SDL_RPC_PLUGIN_INCLUDE_SDL_RPC_PLUGIN_COMMANDS_HMI_SUBSCRIBE_BUTTON_REQUEST_H_

#include "application_manager/commands/request_to_hmi.h"
#include "application_manager/event_engine/event.h"
#include "utils/macro.h"

namespace sdl_rpc_plugin {
namespace app_mngr = application_manager;

namespace commands {
namespace hmi {
/**
* @brief SubscribeButtonRequest command class
**/
class SubscribeButtonRequest : public app_mngr::commands::RequestToHMI,
public app_mngr::event_engine::EventObserver {
public:
/**
* @brief SubscribeButtonRequest class constructor
* @param message Incoming SmartObject message
**/
SubscribeButtonRequest(const app_mngr::commands::MessageSharedPtr& message,
app_mngr::ApplicationManager& application_manager,
app_mngr::rpc_service::RPCService& rpc_service,
app_mngr::HMICapabilities& hmi_capabilities,
policy::PolicyHandlerInterface& policy_handle);

/**
* @brief SubscribeButtonRequest class destructor
**/
~SubscribeButtonRequest();

/**
* @brief Execute command
**/
void Run() OVERRIDE;

void onTimeOut() OVERRIDE;

void on_event(const application_manager::event_engine::Event& event) OVERRIDE;

private:
DISALLOW_COPY_AND_ASSIGN(SubscribeButtonRequest);

/**
* @brief Determines whether internal unsubscription must be performed
* and HMI UnsubscribeButton request should be sent
* @param hmi_result - result code received from HMI
* @param app - reference to application instance
* @return bool - true if app should unsubscribe internally
**/
bool ShouldUnsubscribeIntertally(
const hmi_apis::Common_Result::eType hmi_result,
const app_mngr::Application& app) const;

hmi_apis::Common_ButtonName::eType button_name_;
};

} // namespace hmi
} // namespace commands
} // namespace sdl_rpc_plugin

#endif // SRC_COMPONENTS_APPLICATION_MANAGER_RPC_PLUGINS_SDL_RPC_PLUGIN_INCLUDE_SDL_RPC_PLUGIN_COMMANDS_HMI_SUBSCRIBE_BUTTON_REQUEST_H_
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
/*
* Copyright (c) 2021, Ford Motor Company
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following
* disclaimer in the documentation and/or other materials provided with the
* distribution.
*
* Neither the name of the Ford Motor Company nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/

#ifndef SRC_COMPONENTS_APPLICATION_MANAGER_RPC_PLUGINS_SDL_RPC_PLUGIN_INCLUDE_SDL_RPC_PLUGIN_COMMANDS_HMI_SUBSCRIBE_BUTTON_RESPONSE_H_
#define SRC_COMPONENTS_APPLICATION_MANAGER_RPC_PLUGINS_SDL_RPC_PLUGIN_INCLUDE_SDL_RPC_PLUGIN_COMMANDS_HMI_SUBSCRIBE_BUTTON_RESPONSE_H_

#include "application_manager/application_manager.h"
#include "application_manager/commands/response_from_hmi.h"
#include "utils/macro.h"

namespace sdl_rpc_plugin {
namespace app_mngr = application_manager;

namespace commands {
namespace hmi {
/**
* @brief SubscribeButtonResponse command class
**/
class SubscribeButtonResponse : public app_mngr::commands::ResponseFromHMI {
public:
/**
* @brief SubscribeButtonResponse class constructor
* @param message Incoming SmartObject message
**/
SubscribeButtonResponse(const app_mngr::commands::MessageSharedPtr& message,
app_mngr::ApplicationManager& application_manager,
app_mngr::rpc_service::RPCService& rpc_service,
app_mngr::HMICapabilities& hmi_capabilities,
policy::PolicyHandlerInterface& policy_handle);

/**
* @brief SubscribeButtonResponse class destructor
**/
~SubscribeButtonResponse();

/**
* @brief Execute command
**/
void Run() OVERRIDE;

private:
DISALLOW_COPY_AND_ASSIGN(SubscribeButtonResponse);
};

} // namespace hmi
} // namespace commands
} // namespace sdl_rpc_plugin

#endif // SRC_COMPONENTS_APPLICATION_MANAGER_RPC_PLUGINS_SDL_RPC_PLUGIN_INCLUDE_SDL_RPC_PLUGIN_COMMANDS_HMI_SUBSCRIBE_BUTTON_RESPONSE_H_
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,12 @@ class SubscribeButtonRequest : public app_mngr::commands::CommandRequestImpl {
*/
bool Init() FINAL;

/**
* @brief Interface method that is called whenever new event received
* @param event The received event
*/
void on_event(const app_mngr::event_engine::Event& event) FINAL;

private:
/**
* @brief Checks if button subscription allowed. In case non-media
Expand All @@ -88,12 +94,6 @@ class SubscribeButtonRequest : public app_mngr::commands::CommandRequestImpl {
bool IsSubscriptionAllowed(app_mngr::ApplicationSharedPtr app,
const mobile_apis::ButtonName::eType btn_id);

/**
* @brief Sends ButtonSubscription notification
* to notify HMI that app subscribed on the button.
*/
void SendSubscribeButtonNotification();

DISALLOW_COPY_AND_ASSIGN(SubscribeButtonRequest);
};

Expand Down
Loading

0 comments on commit 1304547

Please sign in to comment.