dict-client.h revision ff52f5c52ee6a4c8a9c79964d32b5d0ff0ae92e6
ff52f5c52ee6a4c8a9c79964d32b5d0ff0ae92e6Timo Sirainen#ifndef __DICT_CLIENT_H
ff52f5c52ee6a4c8a9c79964d32b5d0ff0ae92e6Timo Sirainen#define __DICT_CLIENT_H
ff52f5c52ee6a4c8a9c79964d32b5d0ff0ae92e6Timo Sirainen
ff52f5c52ee6a4c8a9c79964d32b5d0ff0ae92e6Timo Sirainen#define DEFAULT_DICT_SERVER_SOCKET_PATH "/var/run/dovecot/dict-server"
ff52f5c52ee6a4c8a9c79964d32b5d0ff0ae92e6Timo Sirainen
ff52f5c52ee6a4c8a9c79964d32b5d0ff0ae92e6Timo Sirainen#define DICT_CLIENT_PROTOCOL_MAJOR_VERSION 1
ff52f5c52ee6a4c8a9c79964d32b5d0ff0ae92e6Timo Sirainen#define DICT_CLIENT_PROTOCOL_MINOR_VERSION 0
ff52f5c52ee6a4c8a9c79964d32b5d0ff0ae92e6Timo Sirainen
ff52f5c52ee6a4c8a9c79964d32b5d0ff0ae92e6Timo Sirainen#define DICT_CLIENT_MAX_LINE_LENGTH (64*1024)
ff52f5c52ee6a4c8a9c79964d32b5d0ff0ae92e6Timo Sirainen
ff52f5c52ee6a4c8a9c79964d32b5d0ff0ae92e6Timo Sirainenenum {
ff52f5c52ee6a4c8a9c79964d32b5d0ff0ae92e6Timo Sirainen /* <major-version> <minor-version> <user> <dict uri> */
ff52f5c52ee6a4c8a9c79964d32b5d0ff0ae92e6Timo Sirainen DICT_PROTOCOL_CMD_HELLO = 'H',
ff52f5c52ee6a4c8a9c79964d32b5d0ff0ae92e6Timo Sirainen
ff52f5c52ee6a4c8a9c79964d32b5d0ff0ae92e6Timo Sirainen DICT_PROTOCOL_CMD_LOOKUP = 'L', /* <key> */
ff52f5c52ee6a4c8a9c79964d32b5d0ff0ae92e6Timo Sirainen DICT_PROTOCOL_CMD_ITERATE = 'I', /* <recurse> <path> */
ff52f5c52ee6a4c8a9c79964d32b5d0ff0ae92e6Timo Sirainen
ff52f5c52ee6a4c8a9c79964d32b5d0ff0ae92e6Timo Sirainen DICT_PROTOCOL_CMD_BEGIN = 'B', /* <id> */
ff52f5c52ee6a4c8a9c79964d32b5d0ff0ae92e6Timo Sirainen DICT_PROTOCOL_CMD_COMMIT = 'C', /* <id> */
ff52f5c52ee6a4c8a9c79964d32b5d0ff0ae92e6Timo Sirainen DICT_PROTOCOL_CMD_ROLLBACK = 'R', /* <id> */
ff52f5c52ee6a4c8a9c79964d32b5d0ff0ae92e6Timo Sirainen
ff52f5c52ee6a4c8a9c79964d32b5d0ff0ae92e6Timo Sirainen DICT_PROTOCOL_CMD_SET = 'S', /* <id> <key> <value> */
ff52f5c52ee6a4c8a9c79964d32b5d0ff0ae92e6Timo Sirainen DICT_PROTOCOL_CMD_ATOMIC_INC = 'A' /* <id> <key> <diff> */
ff52f5c52ee6a4c8a9c79964d32b5d0ff0ae92e6Timo Sirainen};
ff52f5c52ee6a4c8a9c79964d32b5d0ff0ae92e6Timo Sirainen
ff52f5c52ee6a4c8a9c79964d32b5d0ff0ae92e6Timo Sirainenenum {
ff52f5c52ee6a4c8a9c79964d32b5d0ff0ae92e6Timo Sirainen /* For LOOKUP command */
ff52f5c52ee6a4c8a9c79964d32b5d0ff0ae92e6Timo Sirainen DICT_PROTOCOL_REPLY_OK = 'O', /* <value> */
ff52f5c52ee6a4c8a9c79964d32b5d0ff0ae92e6Timo Sirainen DICT_PROTOCOL_REPLY_NOTFOUND = 'N',
ff52f5c52ee6a4c8a9c79964d32b5d0ff0ae92e6Timo Sirainen DICT_PROTOCOL_REPLY_FAIL = 'F'
ff52f5c52ee6a4c8a9c79964d32b5d0ff0ae92e6Timo Sirainen};
ff52f5c52ee6a4c8a9c79964d32b5d0ff0ae92e6Timo Sirainen
ff52f5c52ee6a4c8a9c79964d32b5d0ff0ae92e6Timo Sirainenconst char *dict_client_escape(const char *src);
ff52f5c52ee6a4c8a9c79964d32b5d0ff0ae92e6Timo Sirainenconst char *dict_client_unescape(const char *src);
ff52f5c52ee6a4c8a9c79964d32b5d0ff0ae92e6Timo Sirainen
ff52f5c52ee6a4c8a9c79964d32b5d0ff0ae92e6Timo Sirainenvoid dict_client_register(void);
ff52f5c52ee6a4c8a9c79964d32b5d0ff0ae92e6Timo Sirainenvoid dict_client_unregister(void);
ff52f5c52ee6a4c8a9c79964d32b5d0ff0ae92e6Timo Sirainen
ff52f5c52ee6a4c8a9c79964d32b5d0ff0ae92e6Timo Sirainen#endif