aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/libs/libevent/include/event2/rpc_struct.h
blob: 6afbd0c647d3b44a07a9e8aa8e4234704c3bbfa3 (plain) (blame)
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
/* 
 * Copyright (c) 2006-2007 Niels Provos <provos@citi.umich.edu> 
 * Copyright (c) 2007-2012 Niels Provos and Nick Mathewson 
 * 
 * Redistribution and use in source and binary forms, with or without 
 * modification, are permitted provided that the following conditions 
 * are met: 
 * 1. Redistributions of source code must retain the above copyright 
 *    notice, this list of conditions and the following disclaimer. 
 * 2. Redistributions in binary form must reproduce the above copyright 
 *    notice, this list of conditions and the following disclaimer in the 
 *    documentation and/or other materials provided with the distribution. 
 * 3. The name of the author may not be used to endorse or promote products 
 *    derived from this software without specific prior written permission. 
 * 
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
 */ 
#ifndef EVENT2_RPC_STRUCT_H_INCLUDED_
#define EVENT2_RPC_STRUCT_H_INCLUDED_
 
#ifdef __cplusplus 
extern "C" { 
#endif 
 
/** @file event2/rpc_struct.h 
 
  Structures used by rpc.h.  Using these structures directly may harm 
  forward compatibility: be careful! 
 
 */ 
 
/* Fix so that people don't have to run with <sys/queue.h> */
#ifndef TAILQ_ENTRY
#define EVENT_DEFINED_TQENTRY_
#define TAILQ_ENTRY(type)						\
struct {								\
	struct type *tqe_next;	/* next element */			\
	struct type **tqe_prev;	/* address of previous next element */	\
}
#endif /* !TAILQ_ENTRY */

/** 
 * provides information about the completed RPC request. 
 */ 
struct evrpc_status { 
#define EVRPC_STATUS_ERR_NONE		0 
#define EVRPC_STATUS_ERR_TIMEOUT	1 
#define EVRPC_STATUS_ERR_BADPAYLOAD	2 
#define EVRPC_STATUS_ERR_UNSTARTED	3 
#define EVRPC_STATUS_ERR_HOOKABORTED	4 
	int error; 
 
	/* for looking at headers or other information */ 
	struct evhttp_request *http_req; 
}; 
 
/* the structure below needs to be synchronized with evrpc_req_generic */ 
 
/* Encapsulates a request */ 
struct evrpc { 
	TAILQ_ENTRY(evrpc) next; 
 
	/* the URI at which the request handler lives */ 
	const char* uri; 
 
	/* creates a new request structure */ 
	void *(*request_new)(void *); 
	void *request_new_arg; 
 
	/* frees the request structure */ 
	void (*request_free)(void *); 
 
	/* unmarshals the buffer into the proper request structure */ 
	int (*request_unmarshal)(void *, struct evbuffer *); 
 
	/* creates a new reply structure */ 
	void *(*reply_new)(void *); 
	void *reply_new_arg; 
 
	/* frees the reply structure */ 
	void (*reply_free)(void *); 
 
	/* verifies that the reply is valid */ 
	int (*reply_complete)(void *); 
 
	/* marshals the reply into a buffer */ 
	void (*reply_marshal)(struct evbuffer*, void *); 
 
	/* the callback invoked for each received rpc */ 
	void (*cb)(struct evrpc_req_generic *, void *); 
	void *cb_arg; 
 
	/* reference for further configuration */ 
	struct evrpc_base *base; 
}; 
 
#ifdef EVENT_DEFINED_TQENTRY_
#undef TAILQ_ENTRY
#endif

#ifdef __cplusplus 
} 
#endif 
 
#endif /* EVENT2_RPC_STRUCT_H_INCLUDED_ */