/usr/include/sphinxclient.h is in libsphinxclient-dev 2.0.4-1.1ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 | //
// $Id: sphinxclient.h 3132 2012-03-01 11:38:42Z klirichek $
//
//
// Copyright (c) 2001-2012, Andrew Aksyonoff
// Copyright (c) 2008-2012, Sphinx Technologies Inc
// All rights reserved
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU Library General Public License. You should
// have received a copy of the LGPL license along with this program; if you
// did not, you can find it at http://www.gnu.org/
//
#ifndef _sphinxclient_
#define _sphinxclient_
#ifdef __cplusplus
extern "C" {
#endif
/// known searchd status codes
enum
{
SEARCHD_OK = 0,
SEARCHD_ERROR = 1,
SEARCHD_RETRY = 2,
SEARCHD_WARNING = 3
};
/// known match modes
enum
{
SPH_MATCH_ALL = 0,
SPH_MATCH_ANY = 1,
SPH_MATCH_PHRASE = 2,
SPH_MATCH_BOOLEAN = 3,
SPH_MATCH_EXTENDED = 4,
SPH_MATCH_FULLSCAN = 5,
SPH_MATCH_EXTENDED2 = 6
};
/// known ranking modes (ext2 only)
enum
{
SPH_RANK_PROXIMITY_BM25 = 0,
SPH_RANK_BM25 = 1,
SPH_RANK_NONE = 2,
SPH_RANK_WORDCOUNT = 3,
SPH_RANK_PROXIMITY = 4,
SPH_RANK_MATCHANY = 5,
SPH_RANK_FIELDMASK = 6,
SPH_RANK_SPH04 = 7,
SPH_RANK_EXPR = 8,
SPH_RANK_TOTAL = 9,
SPH_RANK_DEFAULT = SPH_RANK_PROXIMITY_BM25
};
/// known sort modes
enum
{
SPH_SORT_RELEVANCE = 0,
SPH_SORT_ATTR_DESC = 1,
SPH_SORT_ATTR_ASC = 2,
SPH_SORT_TIME_SEGMENTS = 3,
SPH_SORT_EXTENDED = 4,
SPH_SORT_EXPR = 5
};
/// known filter types
enum
{ SPH_FILTER_VALUES = 0,
SPH_FILTER_RANGE = 1,
SPH_FILTER_FLOATRANGE = 2
};
/// known attribute types
enum
{
SPH_ATTR_INTEGER = 1,
SPH_ATTR_TIMESTAMP = 2,
SPH_ATTR_ORDINAL = 3,
SPH_ATTR_BOOL = 4,
SPH_ATTR_FLOAT = 5,
SPH_ATTR_BIGINT = 6,
SPH_ATTR_STRING = 7,
SPH_ATTR_MULTI = 0x40000001UL,
SPH_ATTR_MULTI64 = 0x40000002UL
};
/// known grouping functions
enum
{ SPH_GROUPBY_DAY = 0,
SPH_GROUPBY_WEEK = 1,
SPH_GROUPBY_MONTH = 2,
SPH_GROUPBY_YEAR = 3,
SPH_GROUPBY_ATTR = 4,
SPH_GROUPBY_ATTRPAIR = 5
};
//////////////////////////////////////////////////////////////////////////
#if defined(_MSC_VER)
typedef __int64 sphinx_int64_t;
typedef unsigned __int64 sphinx_uint64_t;
#else // !defined(_MSC_VER)
typedef long long sphinx_int64_t;
typedef unsigned long long sphinx_uint64_t;
#endif // !defined(_MSC_VER)
typedef int sphinx_bool;
#define SPH_TRUE 1
#define SPH_FALSE 0
//////////////////////////////////////////////////////////////////////////
typedef struct st_sphinx_client sphinx_client;
typedef struct st_sphinx_wordinfo
{
const char * word;
int docs;
int hits;
} sphinx_wordinfo;
typedef struct st_sphinx_result
{
const char * error;
const char * warning;
int status;
int num_fields;
char ** fields;
int num_attrs;
char ** attr_names;
int * attr_types;
int num_matches;
void * values_pool;
int total;
int total_found;
int time_msec;
int num_words;
sphinx_wordinfo * words;
} sphinx_result;
typedef struct st_sphinx_excerpt_options
{
const char * before_match;
const char * after_match;
const char * chunk_separator;
const char * html_strip_mode;
const char * passage_boundary;
int limit;
int limit_passages;
int limit_words;
int around;
int start_passage_id;
sphinx_bool exact_phrase;
sphinx_bool single_passage;
sphinx_bool use_boundaries;
sphinx_bool weight_order;
sphinx_bool query_mode;
sphinx_bool force_all_words;
sphinx_bool load_files;
sphinx_bool allow_empty;
sphinx_bool emit_zones;
} sphinx_excerpt_options;
typedef struct st_sphinx_keyword_info
{
char * tokenized;
char * normalized;
int num_docs;
int num_hits;
} sphinx_keyword_info;
//////////////////////////////////////////////////////////////////////////
sphinx_client * sphinx_create ( sphinx_bool copy_args );
void sphinx_cleanup ( sphinx_client * client );
void sphinx_destroy ( sphinx_client * client );
const char * sphinx_error ( sphinx_client * client );
const char * sphinx_warning ( sphinx_client * client );
sphinx_bool sphinx_set_server ( sphinx_client * client, const char * host, int port );
sphinx_bool sphinx_set_connect_timeout ( sphinx_client * client, float seconds );
sphinx_bool sphinx_open ( sphinx_client * client );
sphinx_bool sphinx_close ( sphinx_client * client );
sphinx_bool sphinx_set_limits ( sphinx_client * client, int offset, int limit, int max_matches, int cutoff );
sphinx_bool sphinx_set_max_query_time ( sphinx_client * client, int max_query_time );
sphinx_bool sphinx_set_match_mode ( sphinx_client * client, int mode );
sphinx_bool sphinx_set_ranking_mode ( sphinx_client * client, int ranker, const char * rankexpr );
sphinx_bool sphinx_set_sort_mode ( sphinx_client * client, int mode, const char * sortby );
sphinx_bool sphinx_set_field_weights ( sphinx_client * client, int num_weights, const char ** field_names, const int * field_weights );
sphinx_bool sphinx_set_index_weights ( sphinx_client * client, int num_weights, const char ** index_names, const int * index_weights );
sphinx_bool sphinx_set_id_range ( sphinx_client * client, sphinx_uint64_t minid, sphinx_uint64_t maxid );
sphinx_bool sphinx_add_filter ( sphinx_client * client, const char * attr, int num_values, const sphinx_int64_t * values, sphinx_bool exclude );
sphinx_bool sphinx_add_filter_range ( sphinx_client * client, const char * attr, sphinx_int64_t umin, sphinx_int64_t umax, sphinx_bool exclude );
sphinx_bool sphinx_add_filter_float_range ( sphinx_client * client, const char * attr, float fmin, float fmax, sphinx_bool exclude );
sphinx_bool sphinx_set_geoanchor ( sphinx_client * client, const char * attr_latitude, const char * attr_longitude, float latitude, float longitude );
sphinx_bool sphinx_set_groupby ( sphinx_client * client, const char * attr, int groupby_func, const char * group_sort );
sphinx_bool sphinx_set_groupby_distinct ( sphinx_client * client, const char * attr );
sphinx_bool sphinx_set_retries ( sphinx_client * client, int count, int delay );
sphinx_bool sphinx_add_override ( sphinx_client * client, const char * attr, const sphinx_uint64_t * docids, int num_values, const unsigned int * values );
sphinx_bool sphinx_set_select ( sphinx_client * client, const char * select_list );
void sphinx_reset_filters ( sphinx_client * client );
void sphinx_reset_groupby ( sphinx_client * client );
sphinx_result * sphinx_query ( sphinx_client * client, const char * query, const char * index_list, const char * comment );
int sphinx_add_query ( sphinx_client * client, const char * query, const char * index_list, const char * comment );
sphinx_result * sphinx_run_queries ( sphinx_client * client );
int sphinx_get_num_results ( sphinx_client * client );
sphinx_uint64_t sphinx_get_id ( sphinx_result * result, int match );
int sphinx_get_weight ( sphinx_result * result, int match );
sphinx_int64_t sphinx_get_int ( sphinx_result * result, int match, int attr );
float sphinx_get_float ( sphinx_result * result, int match, int attr );
unsigned int * sphinx_get_mva ( sphinx_result * result, int match, int attr );
sphinx_uint64_t sphinx_get_mva64_value ( unsigned int * mva, int i );
const char * sphinx_get_string ( sphinx_result * result, int match, int attr );
void sphinx_init_excerpt_options ( sphinx_excerpt_options * opts );
char ** sphinx_build_excerpts ( sphinx_client * client, int num_docs, const char ** docs, const char * index, const char * words, sphinx_excerpt_options * opts );
int sphinx_update_attributes ( sphinx_client * client, const char * index, int num_attrs, const char ** attrs, int num_docs, const sphinx_uint64_t * docids, const sphinx_int64_t * values );
int sphinx_update_attributes_mva ( sphinx_client * client, const char * index, const char * attr, sphinx_uint64_t docid, int num_values, const unsigned int * values );
sphinx_keyword_info * sphinx_build_keywords ( sphinx_client * client, const char * query, const char * index, sphinx_bool hits, int * out_num_keywords );
char ** sphinx_status ( sphinx_client * client, int * num_rows, int * num_cols );
void sphinx_status_destroy ( char ** status, int num_rows, int num_cols );
/////////////////////////////////////////////////////////////////////////////
#ifdef __cplusplus
}
#endif
#endif // _sphinxclient_
//
// $Id: sphinxclient.h 3132 2012-03-01 11:38:42Z klirichek $
//
|