Kaa client C SDK
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
ext_log_storage.h
Go to the documentation of this file.
1 /*
2  * Copyright 2014-2016 CyberVision, Inc.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
24 #ifndef EXT_LOG_STORAGE_H_
25 #define EXT_LOG_STORAGE_H_
26 
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30 
31 #include <stddef.h>
32 
33 #include "kaa_error.h"
34 
35 
39 typedef struct {
40  char *data;
41  size_t size;
42  uint16_t bucket_id;
44 
45 
46 
58 
59 
60 
72 
73 
74 
87 
111 kaa_error_t ext_log_storage_write_next_record(void *context, char *buffer, size_t buffer_len, uint16_t *bucket_id, size_t *record_len);
112 
113 
114 
123 kaa_error_t ext_log_storage_remove_by_bucket_id(void *context, uint16_t bucket_id);
124 
125 
126 
135 kaa_error_t ext_log_storage_unmark_by_bucket_id(void *context, uint16_t bucket_id);
136 
137 
138 
146 size_t ext_log_storage_get_total_size(const void *context);
147 
148 
149 
157 size_t ext_log_storage_get_records_count(const void *context);
158 
159 
160 
168 kaa_error_t ext_log_storage_destroy(void *context);
169 
170 #ifdef __cplusplus
171 } /* extern "C" */
172 #endif
173 
174 #endif /* EXT_LOG_STORAGE_H_ */
kaa_error_t ext_log_storage_allocate_log_record_buffer(void *context, kaa_log_record_t *record)
Allocates the data buffer to serialize a log entry into.
kaa_error_t ext_log_storage_destroy(void *context)
Destroys the log storage (which may decide to self-destroy).
kaa_error_t ext_log_storage_add_log_record(void *context, kaa_log_record_t *record)
Adds a log entry to the log storage.
kaa_error_t
Definition: kaa_error.h:31
size_t ext_log_storage_get_total_size(const void *context)
Returns total size occupied by logs in the log storage.
size_t size
Size of data.
Definition: ext_log_storage.h:41
Kaa error codes.
kaa_error_t ext_log_storage_write_next_record(void *context, char *buffer, size_t buffer_len, uint16_t *bucket_id, size_t *record_len)
Writes the next unmarked log entry into the supplied buffer and marks it with bucket_id the record si...
uint16_t bucket_id
Bucket ID of this record.
Definition: ext_log_storage.h:42
kaa_error_t ext_log_storage_remove_by_bucket_id(void *context, uint16_t bucket_id)
Removes from the storage all records marked with the provided bucket_id.
Wrapper for a serialized log entry.
Definition: ext_log_storage.h:39
size_t ext_log_storage_get_records_count(const void *context)
Returns total log records count.
kaa_error_t ext_log_storage_unmark_by_bucket_id(void *context, uint16_t bucket_id)
Unmarks all records marked with the provided bucket_id.
kaa_error_t ext_log_storage_deallocate_log_record_buffer(void *context, kaa_log_record_t *record)
Deallocates the data buffer of a log record.
char * data
Serialized data.
Definition: ext_log_storage.h:40