summaryrefslogtreecommitdiffstats
path: root/sample/README.md
blob: dd0552145fe43ccd0388ff185aa043794131e8ab (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
# Test cloud applications #

## Description

The test-cloud-app and telemetry-cloud-app are examples of an agl-cloudproxy-service client.
They are used to demonstrate the possibilities of the cloudproxy service.

## Applications

* test-cloud-app: Simple application demonstrating the following possibilities:
    * Sending the messages to cloud over cloud proxy server
    * Receiving confirmations from cloud on the sent messages
    * Receiving messages from cloud


* telemetry-cloud-app: Application which sends the GPS coordinates to the cloud
    * Sending of the messages with telemetry to the cloud
    * Receiving of the messages from the cloud

Applications use CloudProxy client as high level interface for the messages sending and receiving

## CloudProxy client

CloudProxy client hides the communication with CloudProxy server. It incupsulates the following actions

* Connection to **cloudporxy** over wsj1 websocket
* Subscription to the event
* Event loop handling

**Note:** At the moment only two event types are supported
1. Event_SendMessageConfirmation
2. Event_ReceivedMessage

### Usage of a Cloudproxy client:

* Include the appropriate header to appliciation

 ```
 #include "libcloudproxy.h"
  ```

* Initialization of the CloudProxy client inside the application:

```
CloudProxyClient* g_cloudproxyclient{nullptr};

g_cloudproxyclient = new CloudProxyClient();
g_cloudproxyclient->init(port, token.c_str());

```

### Message handling from/to the CloudProxy server:


* Subsription to the Event_SendMessageConfirmation



```
	g_cloudproxyclient->set_event_handler(CloudProxyClient::Event_SendMessageConfirmation, [](json_object* object){
		json_object *j_obj;
		const char* cloud_type{nullptr};
		if(!json_object_object_get_ex(object, "cloud_type", &j_obj) ||
		   (cloud_type = json_object_get_string(j_obj)) == nullptr)
		{
			qDebug("Can't read cloud_type");
			return;
		}

		if(!json_object_object_get_ex(object, "result", &j_obj))
		{
			qDebug("Can't read confirmation result");
			return;
		}

		qDebug("Confirmation result from %s: %d", cloud_type, (int)json_object_get_boolean(j_obj));
	});

   ```



* Subsription to the Event_ReceivedMessage

```
g_cloudproxyclient->set_event_handler(CloudProxyClient::Event_ReceivedMessage, [](json_object* object)
			json_object *j_obj;
			const char* cloud_type{nullptr};
			if(!json_object_object_get_ex(object, "cloud_type", &j_obj) ||
			   (cloud_type = json_object_get_string(j_obj)) == nullptr)
			{
				qDebug("Can't read cloud_type");
				return;
			}

			json_object *event_data;
			const char* data_str{nullptr};
			if(!json_object_object_get_ex(object, "data", &event_data) ||
			   (data_str = json_object_get_string(event_data)) == nullptr)
			{
				qDebug("Can't read event data");
				return;
			}

			qDebug("Received data from %s: %s", cloud_type, data_str);
	});
   ```


* Message sending:


```
qDebug() << "sendMessage to Azure: result: " << g_cloudproxyclient->sendMessage(CloudType::Azure, "{\"app_key\": \"app_value1111\"}");
qDebug() << "sendMessage to AWS: result: " << g_cloudproxyclient->sendMessage(CloudType::Aws, "{\"app_key\": \"app_value1111\"}");
```