LibHomeScreen Class Reference

#include <libhomescreen.hpp>

Public Types
enum	EventType { Event_TapShortcut = 1, Event_OnScreenMessage, Event_OnScreenReply }
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_name)
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)
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)

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

Detailed Description

Definition at line 32 of file libhomescreen.hpp.

Member Typedef Documentation

handler_func

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

Definition at line 42 of file libhomescreen.hpp.

Member Enumeration Documentation

EventType

enum LibHomeScreen::EventType

Enumerator
Event_TapShortcut
Event_OnScreenMessage
Event_OnScreenReply

Definition at line 44 of file libhomescreen.hpp.

                       {
            Event_TapShortcut = 1,
            Event_OnScreenMessage,
            Event_OnScreenReply
        };

Constructor & Destructor Documentation

LibHomeScreen() [1/2]

LibHomeScreen::LibHomeScreen

(

)

constructor

Definition at line 83 of file libhomescreen.cpp.

{
}

~LibHomeScreen()

LibHomeScreen::~LibHomeScreen

(

)

destructor

Definition at line 90 of file libhomescreen.cpp.

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

LibHomeScreen() [2/2]

LibHomeScreen::LibHomeScreen ( const LibHomeScreen &  )

delete

Member Function Documentation

call() [1/2]

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

call() [2/2]

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 360 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;
}

init()

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 116 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;
}

on_call()

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

Definition at line 448 of file libhomescreen.cpp.

{
}

on_event()

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

Definition at line 458 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 = json_object_object_get(ev_contents, "data");

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

    const char* event_only = strchr(event, '/');
    if (event_only != nullptr) {
        event_only = event_only + 1;
    }

    if (strcasecmp(event_only, LibHomeScreen::event_list[0].c_str()) == 0) {
        auto i = this->handlers.find(Event_TapShortcut);
        if ( i != this->handlers.end() ) {
            i->second(json_data);
        }
    }
    else if (strcasecmp(event_only, 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_only, LibHomeScreen::event_list[2].c_str()) == 0) {
        auto i = this->handlers.find(Event_OnScreenReply);
        if ( i != this->handlers.end() ) {
            i->second(json_data);
        }
    }

    json_object_put(ev_contents);
}

on_hangup()

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

Definition at line 439 of file libhomescreen.cpp.

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

on_reply()

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 506 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);

        json_object_put(reply);
    }
}

onScreenMessage()

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 244 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);
}

onScreenReply()

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 268 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);
}

operator=()

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

delete

registerCallback()

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 155 of file libhomescreen.cpp.

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

set_event_handler()

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

Definition at line 293 of file libhomescreen.cpp.

{
    if (et >= 1 && et <= 3) {
        switch (et) {
            case Event_TapShortcut:
                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;
        }

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

subscribe()

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 392 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:%s",__FUNCTION__);
    }
    return ret;
}

tapShortcut()

int LibHomeScreen::tapShortcut

(

const char *

application_name

)

Sending ShortCut Icon tapped event

When HomeScreen shortcut area is tapped, sending a event

Parameters

• application_name [in] : Tapped application name (label)

Return

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

Definition at line 220 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_name);
    json_object_object_add(j_obj, "application_name", val);
    return this->call("tap_shortcut", j_obj);
}

unsubscribe()

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 421 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:%s",__FUNCTION__);
    }
    return ret;
}

Member Data Documentation

api_list

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")
}

Definition at line 50 of file libhomescreen.hpp.

event_list

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

static

Initial value:

{
    std::string("tap_shortcut"),
    std::string("on_screen_message"),
    std::string("on_screen_reply"),
    std::string("none")
}

Definition at line 51 of file libhomescreen.hpp.

---

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

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