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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
|
/*
* Copyright (c) 2000 - 2016 Samsung Electronics Co., Ltd. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
*/
/**
*
* @ingroup SLP_PG
* @defgroup bundle_PG Bundle
* @brief A simple string-based dictionary ADT.
* @{
<h1 class="pg">Introduction</h1>
<p> Bundle is a string based Dictionary ADT. A dictionary is an ordered or unordered list of key element pairs, where keys are used to locate elements in the list. </p><br/>
<p> ADT (Abstract data type) An Abstract Data type is defined as a mathematical model of the data objects that make up a data type as well
as the functions that operate on these objects.</p>
<h1 class="pg">Features</h1>
<ul>
<li> Bundle provides string based Dictionary ADT to
map/store key-value pairs. Eg. Clock </li>
<li> Bundle provides Application Data Exchange (ADE):
<ul>
<li> Transfer application argument between caller and callee by creating a bundle and storing key-value pairs in it. </li>
<li> This bundle object can be passed between applications by encoding and decoding the bundle objects. </li>
</ul> </li>
</ul>
<h1 class="pg">Properties</h1>
<ul>
<li>Only string type is allowed for key and value.</li>
<li>Each key and value is duplicated into the bundle object.</li>
<li>Unlimited number of key/value pairs. (Memory limit is still to be considered)</li>
<li>No key overlap : You cannot assign new values with existing key.</li>
</ul>
<h1 class="pg">Bundle Logical View diagram</h1>
\image html SLP_bundle_PG_images_logical_view.png "Picture 1. Logical view"
<h1 class="pg">Functional architecture diagram</h1>
\image html SLP_bundle_PG_image01.png "Picture 2. Functional architecture"
<p> Bundle requests are received by the Bundle interface. It passes the requests to bundle manager. Bundle Manager checks the type of the request and handles it accordingly. If string key-value needs to be handled in the request it interacts with String manager to provide the required functionality. If the request is based on array of string key-value pair then, Bundle manager interacts with Array manager to provide the required functionality.</p>
<h1 class="pg"> Bundle encode decode life cycle </h1>
\image html SLP_bundle_PG_images_encode_decode.png "Picture 2. Encode decode life cycle"
<h1 class="pg"> Bundle export import life cycle </h1>
\image html SLP_bundle_PG_images_export_import.png "Picture 2. Export import life cycle"
<h1 class="pg">API list and description</h1>
<ul>
<li>bundle_create() : Create a bundle object.</li>
<li>bundle_free() : Free a bundle object.</li>
<li>bundle_add() : Add a key/value pair into the bundle object.</li>
<li>bundle_del() : Delete a key/value pair by given key from the bundle object.</li>
<li>bundle_get_val() : Get a value by key.</li>
<li>bundle_get_count() : Get number of key/value pairs in the bundle object.</li>
<li>bundle_dup() : Duplicate give bundle object</li>
<li>bundle_iterate() : Run iterator function for each key/value pair in the bundle object.</li>
<li>bundle_encode() : Encode bundle object into a byte code.</li>
<li>bundle_decode() : Decode byt code into a bundle object.</li>
<li></li>
</ul>
<h1 class="pg">Programming Guide</h1>
<p> bundle library is very easy to use, and the sample code below would enough to understand how to use bundle. </p><br>
<p>Detailed API instructions are in API reference in doxygen document.</p>
<h2 class="pg">Note</h2>
<ul>
<li>Only string type(char *) keys/values are allowed.</li>
<li>A bundle object must be freed certainly by bundle_free(). </li>
<li>Values retrived by bundle_get_val() cannot be modified.<br> If you want to modify value string, duplicate it.</li>
</ul>
<h2 class="pg"> Header file </h2>
<p> header file name: <strong> bundle.h </strong></p>
<h2 class="pg">Code</h2>
@code
#include <stdio.h>
#include <bundle.h>
// This is a sample iterator callback function
void print_bundle_item(const char *key, const char *val, void *data);
// Sample code
int
main(int argc, char **argv)
{
char *str;
int count;
bundle *b, *b_dup;
// Create a new bundle object
b = bundle_new();
// Add a string with key "a"
bundle_add(b, "a", "123abc");
// Add another string with key "b"
bundle_add("b", "456def");
// str = "123abc"
// You cannot modify string!
str = bundle_get_val(b, "a");
// Run iterator function with each items
bundle_iterate(b, print_bundle_item, NULL);
// count = 2
count = bundle_get_count(b);
// Delete an item with key "a"
bundle_del(b, "a");
// count = 1
count = bundle_get_count(b);
// If "a" key is requested, NULL is returned
// str = NULL, errno = ENOKEY
str = bundle_get_val(b, "a");
// Duplicate bundle object
b_dup = bundle_dup(b);
// Free bundle objects
bundle_free(b);
bundle_free(b_dup);
return 0;
}
void
print_bundle_item(const char *key, const char *val, void *data)
{
printf("%s -> %s\n", key, val);
}
@endcode
* @}
*/
|
