Debian Codegraph @

deps/libneon/doc/TODO

raw
1 /* List of interfaces needing reference documentation. -*- c -*- */
2
3 /* ne_session.h */
4
5 ### DONE: basics
6 ne_session *ne_session_create(const char *scheme, const char *hostname, int port);
7 void ne_session_destroy(ne_session *sess);
8 void ne_close_connection(ne_session *sess);
9 void ne_session_proxy(ne_session *sess, const char *hostname, int port);
10
11 ### DONE: error handling
12 void ne_set_error(ne_session *sess, const char *format, ...);
13 const char *ne_get_error(ne_session *sess);
14
15 ### DONE: options
16 void ne_set_useragent(ne_session *sess, const char *product);
17 void ne_set_expect100(ne_session *sess, int use_expect100);
18 void ne_set_persist(ne_session *sess, int persist);
19 void ne_set_read_timeout(ne_session *sess, int timeout);
20
21 ### TODO: progress + status callbcacks
22 void ne_set_progress(ne_session *sess, ne_progress progress, void *userdata);
23
24 ### TODO: status callback
25 typedef enum ne_conn_status;
26 typedef void (*ne_notify_status)(void *userdata, ne_conn_status status, const char *info);
27 void ne_set_status(ne_session *sess, ne_notify_status status, void *userdata);
28
29 ### DONE: SSL verification
30
31 typedef struct ne_ssl_dname;
32 char *ne_ssl_readable_dname(const ne_ssl_dname *dn);
33 typedef struct ne_ssl_certificate;
34 #define NE_SSL_*
35 typedef int (*ne_ssl_verify_fn)(void *userdata, int failures,
36 const ne_ssl_certificate *cert);
37 void ne_ssl_set_verify(ne_session *sess, ne_ssl_verify_fn fn, void *userdata);
38
39 ### DONE: SSL server certs
40 int ne_ssl_load_ca(ne_session *sess, const char *file);
41 int ne_ssl_load_default_ca(ne_session *sess);
42
43 ### TODO: SSL client certs
44 typedef int (*ne_ssl_keypw_fn)(void *userdata, char *pwbuf, size_t len);
45 void ne_ssl_keypw_prompt(ne_session *sess, ne_ssl_keypw_fn fn, void *ud);
46 int ne_ssl_load_pkcs12(ne_session *sess, const char *fn);
47 int ne_ssl_load_pem(ne_session *sess, const char *certfn, const char *keyfn);
48 typedef void (*ne_ssl_provide_fn)(void *userdata, ne_session *sess,
49 const ne_ssl_dname *server);
50 void ne_ssl_provide_ccert(ne_session *sess, ne_ssl_provide_fn fn, void *userdata);
51
52 #ifdef NEON_SSL
53 SSL_CTX *ne_ssl_get_context(ne_session *sess);
54 X509 *ne_ssl_server_cert(ne_session *req);
55 #endif
56
57 ### TODO: utility functions
58 int ne_version_pre_http11(ne_session *sess);
59 const char *ne_get_server_hostport(ne_session *sess);
60 const char *ne_get_scheme(ne_session *sess);
61 void ne_fill_server_uri(ne_session *sess, ne_uri *uri);
62
63 /* end of ne_session.h *****************************************/
64
65 /* ne_request.h */
66
67 ### DONE: request basics
68 ne_request *ne_request_create(ne_session *sess, const char *method, const char *path);
69 int ne_request_dispatch(ne_request *req);
70 void ne_request_destroy(ne_request *req);
71
72 ### DONE: request status
73 const ne_status *ne_get_status(ne_request *req);
74
75 ### TODO: request bodies
76 void ne_set_request_body_buffer(ne_request *req, const char *buf, size_t count);
77 int ne_set_request_body_fd(ne_request *req, int fd, size_t count);
78
79 typedef ssize_t (*ne_provide_body)(void *userdata,
80 char *buffer, size_t buflen);
81 void ne_set_request_body_provider(ne_request *req, size_t size,
82 ne_provide_body provider, void *userdata);
83
84 ### TODO: response bodies
85 typedef int (*ne_accept_response)(void *userdata, ne_request *req, ne_status *st);
86 int ne_accept_2xx(void *userdata, ne_request *req, ne_status *st);
87 int ne_accept_always(void *userdata, ne_request *req, ne_status *st);
88 void ne_add_response_body_reader(ne_request *req, ne_accept_response accpt,
89 ne_block_reader reader, void *userdata);
90
91 ### TODO: response headers
92 typedef void (*ne_header_handler)(void *userdata, const char *value);
93 void ne_add_response_header_handler(ne_request *req, const char *name,
94 ne_header_handler hdl, void *userdata);
95 void ne_add_response_header_catcher(ne_request *req,
96 ne_header_handler hdl, void *userdata);
97
98 void ne_duplicate_header(void *userdata, const char *value);
99 void ne_handle_numeric_header(void *userdata, const char *value);
100
101 ### DONE: request headers
102 void ne_add_request_header(ne_request *req, const char *name, const char *value);
103 void ne_print_request_header(ne_request *req, const char *name, const char *format, ...);
104
105 ### TODO: misc
106 ne_session *ne_get_session(ne_request *req);
107
108 ### TODO: caller-pulls request interface
109 int ne_begin_request(ne_request *req);
110 int ne_end_request(ne_request *req);
111 ssize_t ne_read_response_block(ne_request *req, char *buffer, size_t buflen);
112
113 ### TODO: hooks
114 typedef void (*ne_free_hooks)(void *cookie);
115 typedef void (*ne_create_request_fn)(void *userdata, ne_request *req,
116 const char *method, const char *path);
117 void ne_hook_create_request(ne_session *sess, ne_create_request_fn fn, void *userdata);
118
119 typedef void (*ne_pre_send_fn)(void *userdata, ne_buffer *header);
120 void ne_hook_pre_send(ne_session *sess, ne_pre_send_fn fn, void *userdata);
121
122 typedef int (*ne_post_send_fn)(void *userdata, const ne_status *status);
123 void ne_hook_post_send(ne_session *sess, ne_post_send_fn fn, void *userdata);
124
125 typedef void (*ne_destroy_fn)(void *userdata);
126 void ne_hook_destroy_request(ne_session *sess, ne_destroy_fn fn, void *userdata);
127
128 void ne_hook_destroy_session(ne_session *sess, ne_destroy_fn fn, void *userdata);
129
130 typedef void *(*ne_accessor_fn)(void *userdata);
131 void ne_hook_session_accessor(ne_session *sess, const char *id, ne_accessor_fn, void *userdata);
132 void ne_hook_request_accessor(ne_request *req, const char *id, ne_accessor_fn, void *userdata);
133
134 void *ne_null_accessor(void *userdata);
135
136 void *ne_session_hook_private(ne_session *sess, const char *id);
137
138 void *ne_request_hook_private(ne_request *req, const char *id);
139
140 /* ne_207.h */
141 /* ne_acl.h */
142 /* DONE: ne_alloc.h */
143 /* DONE: ne_auth.h */
144 /* ne_basic.h */
145 /* ne_compress.h */
146 /* ne_cookies.h */
147 /* ne_dates.h */
148 /* ne_locks.h */
149 /* ne_props.h */
150 /* ne_redirect.h */
151 /* ne_socket.h */
152 /* MOSTLY DONE: ne_string.h */
153 /* ne_uri.h */
154 /* ne_utils.h */
155 /* ne_xml.h */
156