← Back to branch summary

~clint-fewbar/ubuntu/precise/gearmand/drop-unneeded-patches

« back to all changes in this revision

Viewing changes to libgearman-server/protocol_http.h

  • Committer: Bazaar Package Importer
  • Author(s): Monty Taylor
  • Date: 2009-09-28 21:43:31 UTC
  • mto: (1.2.3 upstream) (6.1.1 sid)
  • mto: This revision was merged to the branch mainline in revision 5.
  • Revision ID: james.westby@ubuntu.com-20090928214331-9bku0d3v1b1ypgp4
Import upstream version 0.10

Show diffs side-by-side

added added

removed removed

Lines of Context:
libgearman-server/protocol_http.h
 
1
/* Gearman server and library
 
2
 * Copyright (C) 2008 Brian Aker, Eric Day
 
3
 * All rights reserved.
 
4
 *
 
5
 * Use and distribution licensed under the BSD license.  See
 
6
 * the COPYING file in the parent directory for full text.
 
7
 */
 
8
 
 
9
/**
 
10
 * @file
 
11
 * @brief HTTP Protocol Declarations
 
12
 */
 
13
 
 
14
#ifndef __GEARMAN_PROTOCOL_HTTP_H__
 
15
#define __GEARMAN_PROTOCOL_HTTP_H__
 
16
 
 
17
#ifdef __cplusplus
 
18
extern "C" {
 
19
#endif
 
20
 
 
21
/**
 
22
 * @addtogroup gearman_protocol_http HTTP Protocol Functions
 
23
 * @ingroup gearman_protocol
 
24
 * This module provides a simple HTTP interface into the Gearman job server. It
 
25
 * is also meant to serve as an example of how other protocols can plug into
 
26
 * the server. This module will ignore all headers except:
 
27
 * Content-Length: SIZE
 
28
 * Connection: Keep-Alive
 
29
 * X-Gearman-Unique: UNIQUE_KEY
 
30
 * X-Gearman-Background: true
 
31
 * X-Gearman-Priority: HIGH | LOW
 
32
 * All HTTP requests are translated into SUBMIT_JOB requests, and only
 
33
 * WORK_COMPLETE, WORK_FAIL, and JOB_CREATED responses are returned.
 
34
 * JOB_CREATED packet are only sent back if the "X-Gearman-Background: true"
 
35
 * header is given.
 
36
 * @{
 
37
 */
 
38
 
 
39
/**
 
40
 * Get module configuration options.
 
41
 */
 
42
GEARMAN_API
 
43
gearman_return_t gearmand_protocol_http_conf(gearman_conf_st *conf);
 
44
 
 
45
/**
 
46
 * Initialize the HTTP protocol module.
 
47
 */
 
48
GEARMAN_API
 
49
gearman_return_t gearmand_protocol_http_init(gearmand_st *gearmand,
 
50
                                             gearman_conf_st *conf);
 
51
 
 
52
/**
 
53
 * De-initialize the HTTP protocol module.
 
54
 */
 
55
GEARMAN_API
 
56
gearman_return_t gearmand_protocol_http_deinit(gearmand_st *gearmand);
 
57
 
 
58
/** @} */
 
59
 
 
60
#ifdef __cplusplus
 
61
}
 
62
#endif
 
63
 
 
64
#endif /* __GEARMAN_PROTOCOL_HTTP_H__ */