summaryrefslogtreecommitdiff
path: root/inc/connectivity.h
blob: ed4795a66fd830b18a19da8dde6903f546bca7fd (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
/*
 * Copyright (c) 2017 Samsung Electronics Co., Ltd.
 *
 * Contact: Jin Yoon <jinny.yoon@samsung.com>
 *          Geunsun Lee <gs86.lee@samsung.com>
 *          Eunyoung Lee <ey928.lee@samsung.com>
 *          Junkyu Han <junkyu.han@samsung.com>
 *
 * Licensed under the Flora License, Version 1.1 (the License);
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://floralicense.org/license/
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an AS IS BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef __POSITION_FINDER_CONNECTIVITY_H__
#define __POSITION_FINDER_CONNECTIVITY_H__

#include "connectivity_internal.h"

typedef struct _connectivity_resource connectivity_resource_s;

typedef enum {
	CONNECTIVITY_TYPE_DEFAULT = 0,
	CONNECTIVITY_TYPE_IOTIVITY,
	CONNECTIVITY_TYPE_HTTP,
	CONNECTIVITY_TYPE_MAX
} connectivity_type_e;

/**
 * @brief Create connectivity resource and registers the resource in server.
 * @param[in] path The path of the resource
 * @param[in] type The string data to insert into the resource types (e.g. "org.tizen.light")
 * @param[out] out_resource_info A structure containing information about connectivity resource
 * @return 0 on success, otherwise a negative error value
 * @see uri_path length must be less than 128.
 * @see You must destroy resource by calling connectivity_unset_resource() if resource is no longer needed.
 */
extern int connectivity_set_resource(const char *path, const char *type, connectivity_resource_s **out_resource_info);

/**
 * @brief Releases all resource about connectivity.
 * @param[in] resource_info A structure containing information about connectivity resource
 */
extern void connectivity_unset_resource(connectivity_resource_s *resource);

/**
 * @brief Notifies a resource's value to observed clients.
 * @param[in] resource_info A structure containing information about connectivity resource
 * @param[in] key A key to be sended.
 * @param[in] value A value to be sended.
 * @return 0 on success, otherwise a negative error value
 * @see If key is already exists, current value will be replaced with new value.
 */
extern int connectivity_notify_bool(connectivity_resource_s *resource_info, const char *key, bool value);

/**
 * @brief Notifies a resource's value to observed clients.
 * @param[in] resource_info A structure containing information about connectivity resource
 * @param[in] key A key to be sended.
 * @param[in] value A value to be sended.
 * @return 0 on success, otherwise a negative error value
 * @see If key is already exists, current value will be replaced with new value.
 */
extern int connectivity_notify_int(connectivity_resource_s *resource_info, const char *key, int value);

/**
 * @brief Notifies a resource's value to observed clients.
 * @param[in] resource_info A structure containing information about connectivity resource
 * @param[in] key A key to be sended.
 * @param[in] value A value to be sended.
 * @return 0 on success, otherwise a negative error value
 * @see If key is already exists, current value will be replaced with new value.
 */
extern int connectivity_notify_double(connectivity_resource_s *resource_info, const char *key, double value);

/**
 * @brief Notifies a resource's value to observed clients.
 * @param[in] resource_info A structure containing information about connectivity resource
 * @param[in] key A key to be sended.
 * @param[in] value A value to be sended.
 * @return 0 on success, otherwise a negative error value
 * @see If key is already exists, current value will be replaced with new value.
 */
extern int connectivity_notify_string(connectivity_resource_s *resource_info, const char *key, const char *value);

/* Here is six new functions, I don't like a name of these functions, please recommand me a good name */
extern int connectivity_set_connectivity_type(connectivity_type_e connectivity_type);
extern int connectivity_notify_multi_add_bool(connectivity_resource_s *resource_info, const char *key, bool value);
extern int connectivity_notify_multi_add_int(connectivity_resource_s *resource_info, const char *key, int value);
extern int connectivity_notify_multi_add_double(connectivity_resource_s *resource_info, const char *key, double value);
extern int connectivity_notify_multi_add_string(connectivity_resource_s *resource_info, const char *key, const char *value);
extern int connectivity_notify_multi_perform(connectivity_resource_s *resource_info);

#endif /* __POSITION_FINDER_CONNECTIVITY_H__ */