Contiki-NG
result.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2010, Swedish Institute of Computer Science
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  * notice, this list of conditions and the following disclaimer in the
12  * documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the Institute nor the names of its contributors
14  * may be used to endorse or promote products derived from this software
15  * without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  */
29 
30 /**
31  * \file
32  * Declarations for the result acquisition API.
33  * \author
34  * Nicolas Tsiftes <nvt@sics.se>
35  */
36 
37 #ifndef RESULT_H
38 #define RESULT_H
39 
40 #include "index.h"
41 #include "relation.h"
42 #include "storage.h"
43 
44 #define RESULT_TUPLE_INVALID(tuple) ((tuple) == NULL)
45 #define RESULT_TUPLE_SIZE(handle) (handle).rel->row_length
46 
47 typedef unsigned char *tuple_t;
48 
49 #define DB_HANDLE_FLAG_INDEX_STEP 0x01
50 #define DB_HANDLE_FLAG_SEARCH_INDEX 0x02
51 #define DB_HANDLE_FLAG_PROCESSING 0x04
52 
53 struct db_handle {
54  index_iterator_t index_iterator;
55  tuple_id_t tuple_id;
56  tuple_id_t current_row;
57  relation_t *rel;
58  relation_t *left_rel;
59  relation_t *join_rel;
60  relation_t *right_rel;
61  relation_t *result_rel;
62  attribute_t *left_join_attr;
63  attribute_t *right_join_attr;
64  tuple_t tuple;
65  uint8_t flags;
66  uint8_t ncolumns;
67  void *adt;
68 };
69 typedef struct db_handle db_handle_t;
70 
71 db_result_t db_get_value(attribute_value_t *value,
72  db_handle_t *handle, unsigned col);
73 db_result_t db_phy_to_value(attribute_value_t *value,
74  attribute_t *attr, unsigned char *ptr);
75 db_result_t db_value_to_phy(unsigned char *ptr,
76  attribute_t *attr, attribute_value_t *value);
77 long db_value_to_long(attribute_value_t *value);
78 db_result_t db_free(db_handle_t *handle);
79 
80 #endif /* !RESULT_H */
The storage interface used by the database.