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
|
/* Copyright (c) 2010, Vsevolod Stakhov
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED ''AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL Rambler BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef LIBKVSTORAGECLIENT_H_
#define LIBKVSTORAGECLIENT_H_
#include <glib.h>
/* Errors */
enum rspamd_kvstorage_error {
KVSTORAGE_ERROR_OK = 0,
KVSTORAGE_ERROR_TIMEOUT,
KVSTORAGE_ERROR_NOT_EXIST,
KVSTORAGE_ERROR_NOT_STORED,
KVSTORAGE_ERROR_SERVER_ERROR,
KVSTORAGE_ERROR_INTERNAL_ERROR
};
/* Forwarded definition */
struct rspamd_kvstorage_connection;
/* Callbacks for async API */
typedef void (*kvstorage_connect_cb) (enum rspamd_kvstorage_error code,
struct rspamd_kvstorage_connection *conn, gpointer user_data);
typedef void (*kvstorage_read_cb) (enum rspamd_kvstorage_error code, const gpointer key,
const gpointer value, gsize datalen, struct rspamd_kvstorage_connection *conn,
gpointer user_data);
typedef void (*kvstorage_write_cb) (enum rspamd_kvstorage_error code, const gpointer key, struct rspamd_kvstorage_connection *conn,
gpointer user_data);
/* Asynced API */
/**
* Create async connection with rspamd
* @param host hostname, ip or unix socket for a server
* @param port port number in host byte order
* @param tv timeout for operations
* @param cb callback
* @param ud user data for callback
* @param conn target connection
*/
enum rspamd_kvstorage_error rspamd_kvstorage_connect_async (const gchar *host,
guint16 port, struct timeval *tv, kvstorage_connect_cb cb, gpointer ud,
struct rspamd_kvstorage_connection **conn);
/**
* Read key asynced
* @param conn connection structure
* @param key key to read
* @param cb callback
* @param ud user data for callback
*/
enum rspamd_kvstorage_error rspamd_kvstorage_get_async (struct rspamd_kvstorage_connection *conn,
const gpointer key, kvstorage_read_cb cb, gpointer ud);
/**
* Write key asynced
* @param conn connection structure
* @param key key to set
* @param value data to write
* @param cb callback
* @param ud user data for callback
*/
enum rspamd_kvstorage_error rspamd_kvstorage_set_async (struct rspamd_kvstorage_connection *conn,
const gpointer key, const gpointer value, gsize len, guint expire, kvstorage_write_cb cb, gpointer ud);
/**
* Delete key asynced
* @param conn connection structure
* @param key key to delete
* @param cb callback
* @param ud user data for callback
*/
enum rspamd_kvstorage_error rspamd_kvstorage_delete_async (struct rspamd_kvstorage_connection *conn,
const gpointer key, kvstorage_write_cb cb, gpointer ud);
/**
* Close connection
* @param conn connection structure
*/
enum rspamd_kvstorage_error rspamd_kvstorage_close_async (struct rspamd_kvstorage_connection *conn);
/* Synced API */
/**
* Create sync connection with rspamd
* @param host hostname, ip or unix socket for a server
* @param port port number in host byte order
* @param tv timeout for operations
* @param conn target connection
*/
enum rspamd_kvstorage_error rspamd_kvstorage_connect_sync (const gchar *host,
guint16 port, struct timeval *tv,
struct rspamd_kvstorage_connection **conn);
/**
* Read key synced
* @param conn connection structure
* @param key key to read
* @param value value readed
*/
enum rspamd_kvstorage_error rspamd_kvstorage_get_sync (struct rspamd_kvstorage_connection *conn,
const gpointer key, gpointer **value);
/**
* Write key synced
* @param conn connection structure
* @param key key to set
* @param value data to write
*/
enum rspamd_kvstorage_error rspamd_kvstorage_set_sync (struct rspamd_kvstorage_connection *conn,
const gpointer key, const gpointer value, gsize len, guint expire);
/**
* Delete key synced
* @param conn connection structure
* @param key key to delete
*/
enum rspamd_kvstorage_error rspamd_kvstorage_delete_sync (struct rspamd_kvstorage_connection *conn,
const gpointer key);
/**
* Close connection
* @param conn connection structure
*/
enum rspamd_kvstorage_error rspamd_kvstorage_close_sync (struct rspamd_kvstorage_connection *conn);
#endif /* LIBKVSTORAGECLIENT_H_ */
|
