/usr/include/ttutil.h is in libtokyotyrant-dev 1.1.40-4.2build1.
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 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 | /*************************************************************************************************
* The utility API of Tokyo Tyrant
* Copyright (C) 2006-2010 Mikio Hirabayashi
* This file is part of Tokyo Tyrant.
* Tokyo Tyrant is free software; you can redistribute it and/or modify it under the terms of
* the GNU Lesser General Public License as published by the Free Software Foundation; either
* version 2.1 of the License or any later version. Tokyo Tyrant is distributed in the hope
* that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
* License for more details.
* You should have received a copy of the GNU Lesser General Public License along with Tokyo
* Tyrant; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
* Boston, MA 02111-1307 USA.
*************************************************************************************************/
#ifndef _TTUTIL_H /* duplication check */
#define _TTUTIL_H
#if defined(__cplusplus)
#define __TTUTIL_CLINKAGEBEGIN extern "C" {
#define __TTUTIL_CLINKAGEEND }
#else
#define __TTUTIL_CLINKAGEBEGIN
#define __TTUTIL_CLINKAGEEND
#endif
__TTUTIL_CLINKAGEBEGIN
#include <tcutil.h>
#include <tchdb.h>
#include <tcbdb.h>
#include <tcfdb.h>
#include <tctdb.h>
#include <tcadb.h>
#include <pthread.h>
/*************************************************************************************************
* basic utilities
*************************************************************************************************/
#define TTIOBUFSIZ 65536 /* size of an I/O buffer */
#define TTADDRBUFSIZ 1024 /* size of an address buffer */
typedef struct { /* type of structure for a socket */
int fd; /* file descriptor */
char buf[TTIOBUFSIZ]; /* reading buffer */
char *rp; /* reading pointer */
char *ep; /* end pointer */
bool end; /* end flag */
double to; /* timeout */
double dl; /* deadline time */
} TTSOCK;
/* String containing the version information. */
extern const char *ttversion;
/* Get the primary name of the local host.
`name' specifies the pointer to the region into which the host name is written. The size of
the buffer should be equal to or more than `TTADDRBUFSIZ' bytes.
If successful, the return value is true, else, it is false. */
bool ttgetlocalhostname(char *name);
/* Get the address of a host.
`name' specifies the name of the host.
`addr' specifies the pointer to the region into which the address is written. The size of the
buffer should be equal to or more than `TTADDRBUFSIZ' bytes.
If successful, the return value is true, else, it is false. */
bool ttgethostaddr(const char *name, char *addr);
/* Open a client socket of TCP/IP stream to a server.
`addr' specifies the address of the server.
`port' specifies the port number of the server.
The return value is the file descriptor of the stream, or -1 on error. */
int ttopensock(const char *addr, int port);
/* Open a client socket of UNIX domain stream to a server.
`path' specifies the path of the socket file.
The return value is the file descriptor of the stream, or -1 on error. */
int ttopensockunix(const char *path);
/* Open a server socket of TCP/IP stream to clients.
`addr' specifies the address of the server. If it is `NULL', every network address is binded.
`port' specifies the port number of the server.
The return value is the file descriptor of the stream, or -1 on error. */
int ttopenservsock(const char *addr, int port);
/* Open a server socket of UNIX domain stream to clients.
`addr' specifies the address of the server. If it is `NULL', every network address is binded.
`port' specifies the port number of the server.
The return value is the file descriptor of the stream, or -1 on error. */
int ttopenservsockunix(const char *path);
/* Accept a TCP/IP connection from a client.
`fd' specifies the file descriptor.
`addr' specifies the pointer to the region into which the client address is written. The size
of the buffer should be equal to or more than `TTADDRBUFSIZ' bytes.
`pp' specifies the pointer to a variable to which the client port is assigned. If it is
`NULL', it is not used.
The return value is the file descriptor of the stream, or -1 on error. */
int ttacceptsock(int fd, char *addr, int *pp);
/* Accept a UNIX domain connection from a client.
`fd' specifies the file descriptor.
The return value is the file descriptor of the stream, or -1 on error. */
int ttacceptsockunix(int fd);
/* Shutdown and close a socket.
`fd' specifies the file descriptor.
If successful, the return value is true, else, it is false. */
bool ttclosesock(int fd);
/* Wait an I/O event of a socket.
`fd' specifies the file descriptor.
`mode' specifies the kind of events; 0 for reading, 1 for writing, 2 for exception.
`timeout' specifies the timeout in seconds.
If successful, the return value is true, else, it is false. */
bool ttwaitsock(int fd, int mode, double timeout);
/* Create a socket object.
`fd' specifies the file descriptor.
The return value is the socket object. */
TTSOCK *ttsocknew(int fd);
/* Delete a socket object.
`sock' specifies the socket object. */
void ttsockdel(TTSOCK *sock);
/* Set the lifetime of a socket object.
`sock' specifies the socket object.
`lifetime' specifies the lifetime seconds of each task. By default, there is no limit. */
void ttsocksetlife(TTSOCK *sock, double lifetime);
/* Send data by a socket.
`sock' specifies the socket object.
`buf' specifies the pointer to the region of the data to send.
`size' specifies the size of the buffer.
If successful, the return value is true, else, it is false. */
bool ttsocksend(TTSOCK *sock, const void *buf, int size);
/* Send formatted data by a socket.
`sock' specifies the socket object.
`format' specifies the printf-like format string.
The conversion character `%' can be used with such flag characters as `s', `d', `o', `u',
`x', `X', `c', `e', `E', `f', `g', `G', `@', `?', `%'. `@' works as with `s' but escapes meta
characters of XML. `?' works as with `s' but escapes meta characters of URL. The other
conversion character work as with each original.
The other arguments are used according to the format string.
If successful, the return value is true, else, it is false. */
bool ttsockprintf(TTSOCK *sock, const char *format, ...);
/* Receive data by a socket.
`sock' specifies the socket object.
`buf' specifies the pointer to the region of the data to be received.
`size' specifies the size of the buffer.
If successful, the return value is true, else, it is false. False is returned if the socket
is closed before receiving the specified size of data. */
bool ttsockrecv(TTSOCK *sock, char *buf, int size);
/* Receive one byte by a socket.
`sock' specifies the socket object.
The return value is the received byte. If some error occurs or the socket is closed by the
server, -1 is returned. */
int ttsockgetc(TTSOCK *sock);
/* Push a character back to a socket.
`sock' specifies the socket object.
`c' specifies the character. */
void ttsockungetc(TTSOCK *sock, int c);
/* Receive one line by a socket.
`sock' specifies the socket object.
`buf' specifies the pointer to the region of the data to be received.
`size' specifies the size of the buffer.
If successful, the return value is true, else, it is false. False is returned if the socket
is closed before receiving linefeed. */
bool ttsockgets(TTSOCK *sock, char *buf, int size);
/* Receive one line by a socket into allocated buffer.
`sock' specifies the socket object.
If successful, the return value is the pointer to the result buffer, else, it is `NULL'.
`NULL' is returned if the socket is closed before receiving linefeed.
Because the region of the return value is allocated with the `malloc' call, it should be
released with the `free' call when it is no longer in use. */
char *ttsockgets2(TTSOCK *sock);
/* Receive an 32-bit integer by a socket.
`sock' specifies the socket object.
The return value is the 32-bit integer. */
uint32_t ttsockgetint32(TTSOCK *sock);
/* Receive an 64-bit integer by a socket.
`sock' specifies the socket object.
The return value is the 64-bit integer. */
uint64_t ttsockgetint64(TTSOCK *sock);
/* Check whehter a socket is end.
`sock' specifies the socket object.
The return value is true if the socket is end, else, it is false. */
bool ttsockcheckend(TTSOCK *sock);
/* Check the size of prefetched data in a socket.
`sock' specifies the socket object.
The return value is the size of the prefetched data. */
int ttsockcheckpfsiz(TTSOCK *sock);
/* Fetch the resource of a URL by HTTP.
`url' specifies the URL.
`reqheads' specifies a map object contains request header names and their values. The header
"X-TT-Timeout" specifies the timeout in seconds. If it is `NULL', it is not used.
`resheads' specifies a map object to store response headers their values. If it is NULL, it
is not used. Each key of the map is an uncapitalized header name. The key "STATUS" means the
status line.
`resbody' specifies a extensible string object to store the entity body of the result. If it
is `NULL', it is not used.
The return value is the response code or -1 on network error. */
int tthttpfetch(const char *url, TCMAP *reqheads, TCMAP *resheads, TCXSTR *resbody);
/* Serialize a real number.
`num' specifies a real number.
`buf' specifies the pointer to the region into which the result is written. The size of the
buffer should be 16 bytes. */
void ttpackdouble(double num, char *buf);
/* Redintegrate a serialized real number.
`buf' specifies the pointer to the region of the serialized real number. The size of the
buffer should be 16 bytes.
The return value is the original real number. */
double ttunpackdouble(const char *buf);
/*************************************************************************************************
* server utilities
*************************************************************************************************/
#define TTDEFPORT 0 /* default port of the server */
#define TTMAGICNUM 0xc8 /* magic number of each command */
#define TTCMDPUT 0x10 /* ID of put command */
#define TTCMDPUTKEEP 0x11 /* ID of putkeep command */
#define TTCMDPUTCAT 0x12 /* ID of putcat command */
#define TTCMDPUTSHL 0x13 /* ID of putshl command */
#define TTCMDPUTNR 0x18 /* ID of putnr command */
#define TTCMDOUT 0x20 /* ID of out command */
#define TTCMDGET 0x30 /* ID of get command */
#define TTCMDMGET 0x31 /* ID of mget command */
#define TTCMDVSIZ 0x38 /* ID of vsiz command */
#define TTCMDITERINIT 0x50 /* ID of iterinit command */
#define TTCMDITERNEXT 0x51 /* ID of iternext command */
#define TTCMDFWMKEYS 0x58 /* ID of fwmkeys command */
#define TTCMDADDINT 0x60 /* ID of addint command */
#define TTCMDADDDOUBLE 0x61 /* ID of adddouble command */
#define TTCMDEXT 0x68 /* ID of ext command */
#define TTCMDSYNC 0x70 /* ID of sync command */
#define TTCMDOPTIMIZE 0x71 /* ID of optimize command */
#define TTCMDVANISH 0x72 /* ID of vanish command */
#define TTCMDCOPY 0x73 /* ID of copy command */
#define TTCMDRESTORE 0x74 /* ID of restore command */
#define TTCMDSETMST 0x78 /* ID of setmst command */
#define TTCMDRNUM 0x80 /* ID of rnum command */
#define TTCMDSIZE 0x81 /* ID of size command */
#define TTCMDSTAT 0x88 /* ID of stat command */
#define TTCMDMISC 0x90 /* ID of misc command */
#define TTCMDREPL 0xa0 /* ID of repl command */
#define TTTIMERMAX 8 /* maximum number of timers */
/* Debian addons */
#define _TTDEFSOCK "/var/run/tokyotyrant/tokyotyrant.sock"
#define _TTDEFMPORT 1978 /* default port of master server */
typedef struct _TTTIMER { /* type of structure for a timer */
pthread_t thid; /* thread ID */
bool alive; /* alive flag */
struct _TTSERV *serv; /* server object */
double freq_timed; /* frequency of timed handler */
void (*do_timed)(void *); /* call back function for timed handler */
void *opq_timed; /* opaque pointer for timed handler */
} TTTIMER;
typedef struct _TTREQ { /* type of structure for a server */
pthread_t thid; /* thread ID */
bool alive; /* alive flag */
struct _TTSERV *serv; /* server object */
int epfd; /* polling file descriptor */
double mtime; /* last modified time */
bool keep; /* keep-alive flag */
int idx; /* ordinal index */
} TTREQ;
typedef struct _TTSERV { /* type of structure for a server */
char host[TTADDRBUFSIZ]; /* host name */
char addr[TTADDRBUFSIZ]; /* host address */
uint16_t port; /* port number */
TCLIST *queue; /* queue of requests */
pthread_mutex_t qmtx; /* mutex for the queue */
pthread_cond_t qcnd; /* condition variable for the queue */
pthread_mutex_t tmtx; /* mutex for the timer */
pthread_cond_t tcnd; /* condition variable for the timer */
int thnum; /* number of threads */
double timeout; /* timeout milliseconds of each task */
bool term; /* terminate flag */
void (*do_log)(int, const char *, void *); /* call back function for logging */
void *opq_log; /* opaque pointer for logging */
TTTIMER timers[TTTIMERMAX]; /* timer objects */
int timernum; /* number of timer objects */
void (*do_task)(TTSOCK *, void *, TTREQ *); /* call back function for task */
void *opq_task; /* opaque pointer for task */
void (*do_term)(void *); /* call back gunction for termination */
void *opq_term; /* opaque pointer for termination */
} TTSERV;
enum { /* enumeration for logging levels */
TTLOGDEBUG, /* debug */
TTLOGINFO, /* information */
TTLOGERROR, /* error */
TTLOGSYSTEM /* system */
};
/* Create a server object.
The return value is the server object. */
TTSERV *ttservnew(void);
/* Delete a server object.
`serv' specifies the server object. */
void ttservdel(TTSERV *serv);
/* Configure a server object.
`serv' specifies the server object.
`host' specifies the name or the address. If it is `NULL', If it is `NULL', every network
address is binded.
`port' specifies the port number. If it is not less than 0, UNIX domain socket is binded and
the host name is treated as the path of the socket file.
If successful, the return value is true, else, it is false. */
bool ttservconf(TTSERV *serv, const char *host, int port);
/* Set tuning parameters of a server object.
`serv' specifies the server object.
`thnum' specifies the number of worker threads. By default, the number is 5.
`timeout' specifies the timeout seconds of each task. If it is not more than 0, no timeout is
specified. By default, there is no timeout. */
void ttservtune(TTSERV *serv, int thnum, double timeout);
/* Set the logging handler of a server object.
`serv' specifies the server object.
`do_log' specifies the pointer to a function to do with a log message. Its first parameter is
the log level, one of `TTLOGDEBUG', `TTLOGINFO', `TTLOGERROR'. Its second parameter is the
message string. Its third parameter is the opaque pointer.
`opq' specifies the opaque pointer to be passed to the handler. It can be `NULL'. */
void ttservsetloghandler(TTSERV *serv, void (*do_log)(int, const char *, void *), void *opq);
/* Add a timed handler to a server object.
`serv' specifies the server object.
`freq' specifies the frequency of execution in seconds.
`do_timed' specifies the pointer to a function to do with a event. Its parameter is the
opaque pointer.
`opq' specifies the opaque pointer to be passed to the handler. It can be `NULL'. */
void ttservaddtimedhandler(TTSERV *serv, double freq, void (*do_timed)(void *), void *opq);
/* Set the response handler of a server object.
`serv' specifies the server object.
`do_task' specifies the pointer to a function to do with a task. Its first parameter is
the socket object connected to the client. Its second parameter is the opaque pointer. Its
third parameter is the request object.
`opq' specifies the opaque pointer to be passed to the handler. It can be `NULL'. */
void ttservsettaskhandler(TTSERV *serv, void (*do_task)(TTSOCK *, void *, TTREQ *), void *opq);
/* Set the termination handler of a server object.
`serv' specifies the server object.
`do_term' specifies the pointer to a function to do with a task. Its parameter is the opaque
pointer.
`opq' specifies the opaque pointer to be passed to the handler. It can be `NULL'. */
void ttservsettermhandler(TTSERV *serv, void (*do_term)(void *), void *opq);
/* Start the service of a server object.
`serv' specifies the server object.
If successful, the return value is true, else, it is false. */
bool ttservstart(TTSERV *serv);
/* Send the terminate signal to a server object.
`serv' specifies the server object.
If successful, the return value is true, else, it is false. */
bool ttservkill(TTSERV *serv);
/* Call the logging function of a server object.
`serv' specifies the server object.
`level' specifies the logging level.
`format' specifies the message format.
The other arguments are used according to the format string. */
void ttservlog(TTSERV *serv, int level, const char *format, ...);
/* Check whether a server object is killed.
`serv' specifies the server object.
The return value is true if the server is killed, or false if not. */
bool ttserviskilled(TTSERV *serv);
/* Break a simple server expression.
`expr' specifies the simple server expression. It is composed of two substrings separated
by ":". The former field specifies the name or the address of the server. The latter field
specifies the port number. If the latter field is omitted, the default port number is
specified.
`pp' specifies the pointer to a variable to which the port number is assigned. If it is
`NULL', it is not used.
The return value is the string of the host name.
Because the region of the return value is allocated with the `malloc' call, it should be
released with the `free' call when it is no longer in use. */
char *ttbreakservexpr(const char *expr, int *pp);
/*************************************************************************************************
* features for experts
*************************************************************************************************/
#define _TT_VERSION "1.1.40"
#define _TT_LIBVER 323
#define _TT_PROTVER "0.91"
/* Switch the process into the background.
If successful, the return value is true, else, it is false. */
bool ttdaemonize(void);
/* Get the load average of the system.
The return value is the load average of the system. */
double ttgetloadavg(void);
/* Convert a string to a time stamp.
`str' specifies the string.
The return value is the time stamp. */
uint64_t ttstrtots(const char *str);
/* Get the command name of a command ID number.
`id' specifies the command ID number.
The return value is the string of the command name. */
const char *ttcmdidtostr(int id);
/* tricks for backward compatibility */
#define tcrdbqrysetmax(TC_tdb, TC_max) \
tcrdbqrysetlimit((TC_tdb), (TC_max), 0)
__TTUTIL_CLINKAGEEND
#endif /* duplication check */
/* END OF FILE */
|