[thirdparty/git.git] / protocol.h

#ifndef PROTOCOL_H
#define PROTOCOL_H

enum protocol_version {
	protocol_unknown_version = -1,
	protocol_v0 = 0,
	protocol_v1 = 1,
	protocol_v2 = 2,
};

/*
 * Used by a client to determine which protocol version to request be used when
 * communicating with a server, reflecting the configured value of the
 * 'protocol.version' config.  If unconfigured, a value of 'protocol_v0' is
 * returned.
 */
enum protocol_version get_protocol_version_config(void);

/*
 * Used by a server to determine which protocol version should be used based on
 * a client's request, communicated via the 'GIT_PROTOCOL' environment variable
 * by setting appropriate values for the key 'version'.  If a client doesn't
 * request a particular protocol version, a default of 'protocol_v0' will be
 * used.
 */
enum protocol_version determine_protocol_version_server(void);

/*
 * Used by a client to determine which protocol version the server is speaking
 * based on the server's initial response.
 */
enum protocol_version determine_protocol_version_client(const char *server_response);

#endif /* PROTOCOL_H */
Commit	Line	Data
373d70ef BW	1	#ifndef PROTOCOL_H
	2	#define PROTOCOL_H
	3
	4	enum protocol_version {
	5	protocol_unknown_version = -1,
	6	protocol_v0 = 0,
	7	protocol_v1 = 1,
8f6982b4	8	protocol_v2 = 2,
373d70ef BW	9	};
	10
	11	/*
	12	* Used by a client to determine which protocol version to request be used when
	13	* communicating with a server, reflecting the configured value of the
	14	* 'protocol.version' config. If unconfigured, a value of 'protocol_v0' is
	15	* returned.
	16	*/
55454427	17	enum protocol_version get_protocol_version_config(void);
373d70ef BW	18
	19	/*
	20	* Used by a server to determine which protocol version should be used based on
	21	* a client's request, communicated via the 'GIT_PROTOCOL' environment variable
	22	* by setting appropriate values for the key 'version'. If a client doesn't
	23	* request a particular protocol version, a default of 'protocol_v0' will be
	24	* used.
	25	*/
55454427	26	enum protocol_version determine_protocol_version_server(void);
373d70ef BW	27
	28	/*
	29	* Used by a client to determine which protocol version the server is speaking
	30	* based on the server's initial response.
	31	*/
55454427	32	enum protocol_version determine_protocol_version_client(const char *server_response);
373d70ef BW	33
373d70ef BW	34	#endif /* PROTOCOL_H */