remoteprotocol.h File Reference

Remote protocol version and message numbers. More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	XAPIAN_REMOTE_PROTOCOL_MAJOR_VERSION   39
#define	XAPIAN_REMOTE_PROTOCOL_MINOR_VERSION   1

Enumerations
enum	message_type {   MSG_ALLTERMS, MSG_COLLFREQ, MSG_DOCUMENT, MSG_TERMEXISTS,   MSG_TERMFREQ, MSG_VALUESTATS, MSG_KEEPALIVE, MSG_DOCLENGTH,   MSG_QUERY, MSG_TERMLIST, MSG_POSITIONLIST, MSG_POSTLIST,   MSG_REOPEN, MSG_UPDATE, MSG_ADDDOCUMENT, MSG_CANCEL_,   MSG_DELETEDOCUMENTTERM_, MSG_COMMIT, MSG_REPLACEDOCUMENT_, MSG_REPLACEDOCUMENTTERM,   MSG_DELETEDOCUMENT, MSG_WRITEACCESS, MSG_GETMETADATA, MSG_SETMETADATA_,   MSG_ADDSPELLING_, MSG_REMOVESPELLING, MSG_GETMSET, MSG_SHUTDOWN,   MSG_METADATAKEYLIST, MSG_FREQS, MSG_UNIQUETERMS, MSG_DELETEDOCUMENTTERM,   MSG_REPLACEDOCUMENT, MSG_CANCEL, MSG_SETMETADATA, MSG_ADDSPELLING,   MSG_MAX }
	Message types (client -> server). More...
enum	reply_type {   REPLY_UPDATE, REPLY_EXCEPTION, REPLY_DONE, REPLY_ALLTERMS,   REPLY_COLLFREQ, REPLY_DOCDATA, REPLY_TERMDOESNTEXIST, REPLY_TERMEXISTS,   REPLY_TERMFREQ, REPLY_VALUESTATS, REPLY_DOCLENGTH, REPLY_STATS,   REPLY_TERMLIST, REPLY_POSITIONLIST, REPLY_POSTLISTSTART, REPLY_POSTLISTITEM,   REPLY_VALUE, REPLY_ADDDOCUMENT, REPLY_RESULTS, REPLY_METADATA,   REPLY_METADATAKEYLIST, REPLY_FREQS, REPLY_UNIQUETERMS, REPLY_MAX }
	Reply types (server -> client). More...

Detailed Description

Remote protocol version and message numbers.

Definition in file remoteprotocol.h.

Macro Definition Documentation

XAPIAN_REMOTE_PROTOCOL_MAJOR_VERSION

#define XAPIAN_REMOTE_PROTOCOL_MAJOR_VERSION   39

Definition at line 53 of file remoteprotocol.h.

Referenced by RemoteServer::msg_update(), and RemoteDatabase::update_stats().

XAPIAN_REMOTE_PROTOCOL_MINOR_VERSION

#define XAPIAN_REMOTE_PROTOCOL_MINOR_VERSION   1

Definition at line 54 of file remoteprotocol.h.

Referenced by RemoteServer::msg_update(), and RemoteDatabase::update_stats().

Enumeration Type Documentation

message_type

enum message_type

Message types (client -> server).

When modifying this list, you probably need to update the array of function pointers in net/remoteserver.cc too.

Enumerator
MSG_ALLTERMS
MSG_COLLFREQ
MSG_DOCUMENT
MSG_TERMEXISTS
MSG_TERMFREQ
MSG_VALUESTATS
MSG_KEEPALIVE
MSG_DOCLENGTH
MSG_QUERY
MSG_TERMLIST
MSG_POSITIONLIST
MSG_POSTLIST
MSG_REOPEN
MSG_UPDATE
MSG_ADDDOCUMENT
MSG_CANCEL_
MSG_DELETEDOCUMENTTERM_
MSG_COMMIT
MSG_REPLACEDOCUMENT_
MSG_REPLACEDOCUMENTTERM
MSG_DELETEDOCUMENT
MSG_WRITEACCESS
MSG_GETMETADATA
MSG_SETMETADATA_
MSG_ADDSPELLING_
MSG_REMOVESPELLING
MSG_GETMSET
MSG_SHUTDOWN
MSG_METADATAKEYLIST
MSG_FREQS
MSG_UNIQUETERMS
MSG_DELETEDOCUMENTTERM
MSG_REPLACEDOCUMENT
MSG_CANCEL
MSG_SETMETADATA
MSG_ADDSPELLING
MSG_MAX

Definition at line 61 of file remoteprotocol.h.

reply_type

enum reply_type

Reply types (server -> client).

Enumerator
REPLY_UPDATE
REPLY_EXCEPTION
REPLY_DONE
REPLY_ALLTERMS
REPLY_COLLFREQ
REPLY_DOCDATA
REPLY_TERMDOESNTEXIST
REPLY_TERMEXISTS
REPLY_TERMFREQ
REPLY_VALUESTATS
REPLY_DOCLENGTH
REPLY_STATS
REPLY_TERMLIST
REPLY_POSITIONLIST
REPLY_POSTLISTSTART
REPLY_POSTLISTITEM
REPLY_VALUE
REPLY_ADDDOCUMENT
REPLY_RESULTS
REPLY_METADATA
REPLY_METADATAKEYLIST
REPLY_FREQS
REPLY_UNIQUETERMS
REPLY_MAX

Definition at line 102 of file remoteprotocol.h.