LibHomeScreen Class Reference

#include <libhomescreen.hpp>

Public Types
enum	EventType {   Event_ShowWindow = 1, Event_TapShortcut = 1, Event_OnScreenMessage, Event_OnScreenReply,   Event_HideWindow, Event_ReplyShowWindow, Event_ShowNotification, Event_ShowInformation }
using	handler_func = std::function< void(json_object *)>

Public Member Functions
	LibHomeScreen ()
	~LibHomeScreen ()
	LibHomeScreen (const LibHomeScreen &)=delete
LibHomeScreen &	operator= (const LibHomeScreen &)=delete
int	init (const int port, const std::string &token)
int	tapShortcut (const char *application_id)
int	onScreenMessage (const char *display_message)
int	onScreenReply (const char *reply_message)
void	set_event_handler (enum EventType et, handler_func f)
void	registerCallback (void(*event_cb)(const std::string &event, struct json_object *event_contents), void(*reply_cb)(struct json_object *reply_contents), void(*hangup_cb)(void)=nullptr)
int	call (const std::string &verb, struct json_object *arg)
int	call (const char *verb, struct json_object *arg)
int	subscribe (const std::string &event_name)
int	unsubscribe (const std::string &event_name)
int	showWindow (const char *application_id, json_object *json)
int	hideWindow (const char *application_id)
int	replyShowWindow (const char *application_id, json_object *json)
int	showNotification (json_object *json)
int	showInformation (json_object *json)
void	on_hangup (void *closure, struct afb_wsj1 *wsj)
void	on_call (void *closure, const char *api, const char *verb, struct afb_wsj1_msg *msg)
void	on_event (void *closure, const char *event, struct afb_wsj1_msg *msg)
void	on_reply (void *closure, struct afb_wsj1_msg *msg)

Public Attributes
const char *	_keyParameter = "parameter"
const char *	_keyArea = "area"
const char *	_areaNormal = "normal"
const char *	_areaFullScreen = "fullscreen"
const char *	_areaSplitMain = "split.main"
const char *	_areaSplitSub = "split.sub"

Static Public Attributes
static const std::vector< std::string >	api_list
static const std::vector< std::string >	event_list

Detailed Description

Definition at line 31 of file libhomescreen.hpp.

Member Typedef Documentation

using LibHomeScreen::handler_func = std::function<void(json_object*)>

Definition at line 40 of file libhomescreen.hpp.

Member Enumeration Documentation

enum LibHomeScreen::EventType

Enumerator
Event_ShowWindow
Event_TapShortcut
Event_OnScreenMessage
Event_OnScreenReply
Event_HideWindow
Event_ReplyShowWindow
Event_ShowNotification
Event_ShowInformation

Definition at line 42 of file libhomescreen.hpp.

                   {
        Event_ShowWindow = 1,
        Event_TapShortcut = 1,
        Event_OnScreenMessage,
        Event_OnScreenReply,
        Event_HideWindow,
        Event_ReplyShowWindow,
        Event_ShowNotification,
        Event_ShowInformation
    };

Constructor & Destructor Documentation

LibHomeScreen::LibHomeScreen

(

)

constructor

Definition at line 93 of file libhomescreen.cpp.

{
}

LibHomeScreen::~LibHomeScreen

(

)

destructor

Definition at line 100 of file libhomescreen.cpp.

{
    if(mploop)
    {
        sd_event_unref(mploop);
    }
    if(sp_websock != NULL)
    {
        afb_wsj1_unref(sp_websock);
    }
}

LibHomeScreen::LibHomeScreen ( const LibHomeScreen &  )

delete

Member Function Documentation

int LibHomeScreen::call	(	const std::string &	verb,
		struct json_object *	arg
	)

int LibHomeScreen::call	(	const char *	verb,
		struct json_object *	arg
	)

This function calls the API of HomeScreen via WebSocket This function is overload function of "call"

Parameters

• verb [in] : This argument should be specified to the API name (e.g. "tap_shortcut")
• arg [in] : This argument should be specified to the argument of API. And this argument expects JSON object

Return

• Returns 0 on success or -1 in case of error.

Note

To call HomeScreen's APIs, the application should set its function name, arguments to JSON format.

Definition at line 377 of file libhomescreen.cpp.

{
    int ret;
    if(!sp_websock)
    {
        return -1;
    }
    if (!has_verb(string(verb)))
    {
        HMI_ERROR("libhomescreen","verb doesn't exit");
        return -1;
    }
    ret = afb_wsj1_call_j(sp_websock, API, verb, arg, _on_reply_static, this);
    if (ret < 0) {
        HMI_ERROR("libhomescreen","Failed to call verb:%s",verb);
    }
    return ret;
}

int LibHomeScreen::hideWindow

(

const char *

application_id

)

Sending hide window event

Call HomeScreen Service's hideWindow verb to release id's screen.

Parameters

• application_id [in] : This argument should be specified to the application's id.

Return

• Returns 0 on success or -1 in case of error.

Definition at line 503 of file libhomescreen.cpp.

{
    if(!sp_websock)
    {
        return -1;
    }

    struct json_object* j_obj = json_object_new_object();
    struct json_object* val = json_object_new_string(application_id);
    json_object_object_add(j_obj, ApplicationId, val);

    return this->call("hideWindow", j_obj);
}

int LibHomeScreen::init	(	const int	port,
		const std::string &	token
	)

This function is initializer

Parameters

• port [in] : This argument should be specified to the port number to be used for websocket
• token [in] : This argument should be specified to the token to be used for websocket

Return

Nothing

Note

Use this constructor

Definition at line 126 of file libhomescreen.cpp.

{
    int ret = 0;
    if(port > 0 && token.size() > 0)
    {
        mport = port;
        mtoken = token;
    }
    else
    {
        HMI_ERROR("libhomescreen","port and token should be > 0, Initial port and token uses.");
    }

    ret = initialize_websocket();
    if(ret != 0 )
    {
        HMI_ERROR("libhomescreen","Failed to initialize websocket");
    }
    else{
        HMI_DEBUG("libhomescreen","Initialized");
    }

    return ret;
}

void LibHomeScreen::on_call	(	void *	closure,
		const char *	api,
		const char *	verb,
		struct afb_wsj1_msg *	msg
	)

Definition at line 606 of file libhomescreen.cpp.

{
}

void LibHomeScreen::on_event	(	void *	closure,
		const char *	event,
		struct afb_wsj1_msg *	msg
	)

Definition at line 616 of file libhomescreen.cpp.

{
    HMI_DEBUG("libhomescreen","event: (%s) msg: (%s).", event, afb_wsj1_msg_object_s(msg));

    if (strstr(event, API) == NULL) {
        return;
    }

    struct json_object* ev_contents = afb_wsj1_msg_object_j(msg);
    struct json_object *json_data;
    if(!json_object_object_get_ex(ev_contents, "data", &json_data)) {
        HMI_ERROR("libhomescreen", "got ev_contents error.");
        return;
    }

    if(onEvent != nullptr)
    {
        const string ev(event);
        onEvent(ev, ev_contents);
    }

    const char* event_type = nullptr;
    struct json_object *json_event_type;
    if(json_object_object_get_ex(json_data, "type", &json_event_type)) {
        event_type = json_object_get_string(json_event_type);
    }
    else {
        HMI_WARNING("libhomescreen","event_type is null.");
        return;
    }

    if (strcasecmp(event_type, LibHomeScreen::event_list[0].c_str()) == 0) {
        auto i = this->handlers.find(Event_ShowWindow);
        if ( i != this->handlers.end() ) {
            i->second(json_data);
        }
    }
    else if (strcasecmp(event_type, LibHomeScreen::event_list[1].c_str()) == 0) {
        auto i = this->handlers.find(Event_OnScreenMessage);
        if ( i != this->handlers.end() ) {
            i->second(json_data);
        }
    }
    else if (strcasecmp(event_type, LibHomeScreen::event_list[2].c_str()) == 0) {
        auto i = this->handlers.find(Event_OnScreenReply);
        if ( i != this->handlers.end() ) {
            i->second(json_data);
        }
    }
    else if (strcasecmp(event_type, LibHomeScreen::event_list[3].c_str()) == 0) {
        auto i = this->handlers.find(Event_HideWindow);
        if ( i != this->handlers.end() ) {
            i->second(json_data);
        }
    }
    else if (strcasecmp(event_type, LibHomeScreen::event_list[4].c_str()) == 0) {
        auto i = this->handlers.find(Event_ReplyShowWindow);
        if ( i != this->handlers.end() ) {
            i->second(json_data);
        }
    }
    else if (strcasecmp(event_type, LibHomeScreen::event_list[5].c_str()) == 0) {
        auto i = this->handlers.find(Event_ShowNotification);
        if ( i != this->handlers.end() ) {
            i->second(json_data);
        }
    }
    else if (strcasecmp(event_type, LibHomeScreen::event_list[6].c_str()) == 0) {
        auto i = this->handlers.find(Event_ShowInformation);
        if ( i != this->handlers.end() ) {
            i->second(json_data);
        }
    }
}

void LibHomeScreen::on_hangup	(	void *	closure,
		struct afb_wsj1 *	wsj
	)

Definition at line 597 of file libhomescreen.cpp.

{
    HMI_DEBUG("libhomescreen","called");
    if(onHangup != nullptr)
    {
        onHangup();
    }
}

void LibHomeScreen::on_reply	(	void *	closure,
		struct afb_wsj1_msg *	msg
	)

msg is like ({"response":{"verb":"subscribe","error":0},"jtype":"afb-reply","request":{"status":"success","info":"homescreen binder subscribe event name [on_screen_message]"}}) msg is like ({"response":{"verb":"tap_shortcut","error":0},"jtype":"afb-reply","request":{"status":"success","info":"afb_event_push event [tap_shortcut]"}})

Definition at line 695 of file libhomescreen.cpp.

{
    HMI_DEBUG("libhomescreen","msg: (%s)", afb_wsj1_msg_object_s(msg));
    if(onReply != nullptr)
    {
        struct json_object* reply = afb_wsj1_msg_object_j(msg);
        onReply(reply);
    }
}

int LibHomeScreen::onScreenMessage

(

const char *

display_message

)

Sending onScreen message event

Sending OnScreen message event to HomeScreen from applications

Parameters

• display_message [in] : message for display

Return

• Returns 0 on success or -1 in case of error.

Definition at line 242 of file libhomescreen.cpp.

{
    if(!sp_websock)
    {
        return -1;
    }

    struct json_object* j_obj = json_object_new_object();
    struct json_object* val = json_object_new_string(display_message);
    json_object_object_add(j_obj, "display_message", val);
    return this->call("on_screen_message", j_obj);
}

int LibHomeScreen::onScreenReply

(

const char *

reply_message

)

Sending onScreen reply event

Sending OnScreen reply event to applications from HomeScreen

Parameters

• reply_message [in] : message for reply

Return

• Returns 0 on success or -1 in case of error.

Definition at line 266 of file libhomescreen.cpp.

{
    if(!sp_websock)
    {
        return -1;
    }

    struct json_object* j_obj = json_object_new_object();
    struct json_object* val = json_object_new_string(reply_message);
    json_object_object_add(j_obj, "reply_message", val);
    return this->call("on_screen_reply", j_obj);
}

LibHomeScreen& LibHomeScreen::operator= ( const LibHomeScreen &  )

delete

void LibHomeScreen::registerCallback	(	void(*)(const std::string &event, struct json_object *event_contents)	event_cb,
		void(*)(struct json_object *reply_contents)	reply_cb,
		void(*)(void)	hangup_cb = nullptr
	)

This function register callback function for reply/event message from home screen

Parameters

• event_cb [in] : This argument should be specified to the callback for subscribed event
• reply_cb [in] : This argument should be specified to the reply callback for call function

Return

Nothing

Note

Event callback is invoked by home screen for event you subscribed. If you would like to get event, please call subscribe function before/after this function

Definition at line 165 of file libhomescreen.cpp.

{
    onEvent = event_cb;
    onReply = reply_cb;
    onHangup = hangup_cb;
}

int LibHomeScreen::replyShowWindow	(	const char *	application_id,
		json_object *	json
	)

Sending reply onscreen message event

Call HomeScreen Service's replyShowWindow verb to reply onscreen message.

Parameters

• application_id [in] : This argument should be specified to the onscreen reply to applilcation id.
• json [in] : This argument should be specified to the json parameters.

Return

• Returns 0 on success or -1 in case of error.

Definition at line 530 of file libhomescreen.cpp.

{
    if(!sp_websock)
    {
        return -1;
    }

    if (json == nullptr) {
        HMI_WARNING("libhomescreen", "replyShowWindow`s parameter is null");
        return -1;
    }

    struct json_object* j_obj = json_object_new_object();
    struct json_object* val = json_object_new_string(application_id);
    json_object_object_add(j_obj, ApplicationId, val);
    json_object_object_add(j_obj, "parameter", json);

    return this->call("replyShowWindow", j_obj);
}

void LibHomeScreen::set_event_handler	(	enum EventType	et,
		handler_func	f
	)

Setting Event Handler

Setting event handler for Homescreen

Parameters

• et [in] : event name
• f [in] : event handler

Return

Nothing

Note

Don't release json_object by json_object_put in handler_func. The resource is released by libafbwsc library.

Definition at line 295 of file libhomescreen.cpp.

{
    if (et >= 1 && et <= 7) {
        switch (et) {
/*          case Event_TapShortcut:
                this->subscribe(LibHomeScreen::event_list[0]);
                break;*/
            case Event_ShowWindow:
                this->subscribe(LibHomeScreen::event_list[0]);
                break;
            case Event_OnScreenMessage:
                this->subscribe(LibHomeScreen::event_list[1]);
                break;
            case Event_OnScreenReply:
                this->subscribe(LibHomeScreen::event_list[2]);
                break;
            case Event_HideWindow:
                this->subscribe(LibHomeScreen::event_list[3]);
                break;
            case Event_ReplyShowWindow:
                this->subscribe(LibHomeScreen::event_list[4]);
                break;
            case Event_ShowNotification:
                this->subscribe(LibHomeScreen::event_list[5]);
                break;
            case Event_ShowInformation:
                this->subscribe(LibHomeScreen::event_list[6]);
                break;
        }

        this->handlers[et] = std::move(f);
    }
}

int LibHomeScreen::showInformation

(

json_object *

json

)

Sending show information event

Call HomeScreen Service's information verb to show notification on Information Bar.

Parameters

• json [in] : This argument should be specified to the json parameters.

Return

• Returns 0 on success or -1 in case of error.

Definition at line 584 of file libhomescreen.cpp.

{
    if(!sp_websock)
    {
        return -1;
    }

    return this->call("showInformation", json);
}

int LibHomeScreen::showNotification

(

json_object *

json

)

Sending show notification event

Call HomeScreen Service's notification verb to show notification on Status Bar.

Parameters

• json [in] : This argument should be specified to the json parameters.

Return

• Returns 0 on success or -1 in case of error.

Definition at line 562 of file libhomescreen.cpp.

{
    if(!sp_websock)
    {
        return -1;
    }

    return this->call("showNotification", json);
}

int LibHomeScreen::showWindow	(	const char *	application_id,
		json_object *	json
	)

Sending show window event

Call HomeScreen Service's showWindow verb to request display id's screen.

Parameters

• application_id [in] : This argument should be specified to the application's id.
• json [in] : This argument should be specified to the json parameters.

Return

• Returns 0 on success or -1 in case of error.

Definition at line 467 of file libhomescreen.cpp.

{
    if(!sp_websock)
    {
        return -1;
    }

    struct json_object* j_obj = json_object_new_object();
    struct json_object* val = json_object_new_string(application_id);
    json_object_object_add(j_obj, ApplicationId, val);

    if (json == nullptr) {
        struct json_object* j_json = json_object_new_object();
        struct json_object* value = json_object_new_string("normal");
        json_object_object_add(j_json, "area", value);
        json_object_object_add(j_obj, "parameter", j_json);
    }
    else {
        json_object_object_add(j_obj, "parameter", json);
    }

    return this->call("showWindow", j_obj);
}

int LibHomeScreen::subscribe

(

const std::string &

event_name

)

Register callback function for each event

Parameters

• event_name [in] : This argument should be specified to the event name

Return

• Returns 0 on success or -1 in case of error.

Note

This function enables to get an event to your callback function.

Definition at line 409 of file libhomescreen.cpp.

{
    if(!sp_websock)
    {
        return -1;
    }
    struct json_object* j_obj = json_object_new_object();
    json_object_object_add(j_obj, "event", json_object_new_string(event_name.c_str()));

    int ret = afb_wsj1_call_j(sp_websock, API, "subscribe", j_obj, _on_reply_static, this);
    if (ret < 0) {
        HMI_ERROR("libhomescreen","Failed to call verb");
    }
    return ret;
}

int LibHomeScreen::tapShortcut

(

const char *

application_id

)

Sending ShortCut Icon tapped event

When HomeScreen shortcut area is tapped, sending a event

Parameters

• application_id [in] : Tapped application id (label)

Return

• Returns 0 on success or -1 in case of error.

Definition at line 222 of file libhomescreen.cpp.

{
    struct json_object* obj = json_object_new_object();
    struct json_object* val = json_object_new_string("normal");
    json_object_object_add(obj, "area", val);

    return showWindow(application_id, obj);
}

int LibHomeScreen::unsubscribe

(

const std::string &

event_name

)

Unregister callback function for each event

Parameters

• event_name [in] : This argument should be specified to the event name

Return

• Returns 0 on success or -1 in case of error.

Note

This function disables to get an event to your callback function.

Definition at line 438 of file libhomescreen.cpp.

{
    if(!sp_websock)
    {
        return -1;
    }
    struct json_object* j_obj = json_object_new_object();
    json_object_object_add(j_obj, "event", json_object_new_string(event_name.c_str()));

    int ret = afb_wsj1_call_j(sp_websock, API, "unsubscribe", j_obj, _on_reply_static, this);
    if (ret < 0) {
        HMI_ERROR("libhomescreen","Failed to call verb");
    }
    return ret;
}

Member Data Documentation

const char* LibHomeScreen::_areaFullScreen = "fullscreen"

Definition at line 59 of file libhomescreen.hpp.

const char* LibHomeScreen::_areaNormal = "normal"

Definition at line 58 of file libhomescreen.hpp.

const char* LibHomeScreen::_areaSplitMain = "split.main"

Definition at line 60 of file libhomescreen.hpp.

const char* LibHomeScreen::_areaSplitSub = "split.sub"

Definition at line 61 of file libhomescreen.hpp.

const char* LibHomeScreen::_keyArea = "area"

Definition at line 55 of file libhomescreen.hpp.

const char* LibHomeScreen::_keyParameter = "parameter"

Definition at line 54 of file libhomescreen.hpp.

const std::vector< std::string > LibHomeScreen::api_list

static

Initial value:

{
    std::string("ping"), 
    std::string("tap_shortcut"), 
    std::string("on_screen_message"),
    std::string("on_screen_reply"),
    std::string("subscribe"),
    std::string("unsubscribe"),
    std::string("showWindow"),
    std::string("hideWindow"),
    std::string("replyShowWindow"),
    std::string("showNotification"),
    std::string("showInformation")
}

Definition at line 63 of file libhomescreen.hpp.

const std::vector< std::string > LibHomeScreen::event_list

static

Initial value:

{

    std::string("showWindow"),
    std::string("on_screen_message"),
    std::string("on_screen_reply"),
    std::string("hideWindow"),
    std::string("replyShowWindow"),
    std::string("showNotification"),
    std::string("showInformation"),
    std::string("none")
}

Definition at line 64 of file libhomescreen.hpp.

---

The documentation for this class was generated from the following files:

• include/libhomescreen.hpp
• libhomescreen/libhomescreen.cpp