etc/services - sync with NetBSD-8
[minix.git] / external / bsd / libevent / man / deprecated.3
blob040c8ee19bf78483ebd63f92863c620396884cf5
1 .TH "deprecated" 3 "Tue Jan 27 2015" "libevent" \" -*- nroff -*-
2 .ad l
3 .nh
4 .SH NAME
5 deprecated \- Deprecated List 
7 .IP "\fBGlobal \fBevbuffer_readline\fP (struct evbuffer *buffer)\fP" 1c
8 This function is deprecated because its behavior is not correct for almost any protocol, and also because it's wholly subsumed by \fBevbuffer_readln()\fP\&. 
9 .IP "\fBGlobal \fBevbuffer_setcb\fP (struct evbuffer *buffer, evbuffer_cb cb, void *cbarg)\fP" 1c
10 This function is deprecated because it clears all previous callbacks set on the evbuffer, which can cause confusing behavior if multiple parts of the code all want to add their own callbacks on a buffer\&. Instead, use \fBevbuffer_add()\fP, evbuffer_del(), and evbuffer_setflags() to manage your own evbuffer callbacks without interfering with callbacks set by others\&. 
11 .IP "\fBGlobal \fBevdns_add_server_port\fP (evutil_socket_t socket, int flags, evdns_request_callback_fn_type callback, void *user_data)\fP" 1c
12 This function is deprecated because it does not allow the caller to specify which even_base it uses\&. The recommended function is \fBevdns_add_server_port_with_base()\fP\&. 
13 .IP "\fBGlobal \fBevdns_clear_nameservers_and_suspend\fP (void)\fP" 1c
14 This function is deprecated because it does not allow the caller to specify which evdns_base it applies to\&. The recommended function is \fBevdns_base_clear_nameservers_and_suspend()\fP\&. 
15 .IP "\fBGlobal \fBevdns_count_nameservers\fP (void)\fP" 1c
16 This function is deprecated because it does not allow the caller to specify which evdns_base it applies to\&. The recommended function is \fBevdns_base_count_nameservers()\fP\&. 
17 .IP "\fBGlobal \fBevdns_get_global_base\fP (void)\fP" 1c
18 This function is deprecated because use of the global evdns_base is error-prone\&.  
19 .IP "\fBGlobal \fBevdns_init\fP (void)\fP" 1c
20 This function is deprecated because it always uses the current event base, and is easily confused by multiple calls to \fBevent_init()\fP, and so is not safe for multithreaded use\&. Additionally, it allocates a global structure that only one thread can use\&. The replacement is \fBevdns_base_new()\fP\&. 
21 .IP "\fBGlobal \fBevdns_nameserver_add\fP (unsigned long int address)\fP" 1c
22 This function is deprecated because it does not allow the caller to specify which evdns_base it applies to\&. The recommended function is \fBevdns_base_nameserver_add()\fP\&. 
23 .IP "\fBGlobal \fBevdns_nameserver_ip_add\fP (const char *ip_as_string)\fP" 1c
24 This function is deprecated because it does not allow the caller to specify which evdns_base it applies to\&. The recommended function is \fBevdns_base_nameserver_ip_add()\fP\&. 
25 .IP "\fBGlobal \fBevdns_resolv_conf_parse\fP (int flags, const char *const filename)\fP" 1c
26 This function is deprecated because it does not allow the caller to specify which evdns_base it applies to\&. The recommended function is \fBevdns_base_resolv_conf_parse()\fP\&. 
27 .IP "\fBGlobal \fBevdns_resolve_ipv4\fP (const char *name, int flags, evdns_callback_type callback, void *ptr)\fP" 1c
28 This function is deprecated because it does not allow the caller to specify which evdns_base it applies to\&. The recommended function is \fBevdns_base_resolve_ipv4()\fP\&. 
29 .IP "\fBGlobal \fBevdns_resolve_reverse\fP (const struct in_addr *in, int flags, evdns_callback_type callback, void *ptr)\fP" 1c
30 This function is deprecated because it does not allow the caller to specify which evdns_base it applies to\&. The recommended function is \fBevdns_base_resolve_reverse()\fP\&. 
31 .IP "\fBGlobal \fBevdns_resolve_reverse_ipv6\fP (const struct in6_addr *in, int flags, evdns_callback_type callback, void *ptr)\fP" 1c
32 This function is deprecated because it does not allow the caller to specify which evdns_base it applies to\&. The recommended function is \fBevdns_base_resolve_reverse_ipv6()\fP\&. 
33 .IP "\fBGlobal \fBevdns_resume\fP (void)\fP" 1c
34 This function is deprecated because it does not allow the caller to specify which evdns_base it applies to\&. The recommended function is \fBevdns_base_resume()\fP\&. 
35 .IP "\fBGlobal \fBevdns_search_add\fP (const char *domain)\fP" 1c
36 This function is deprecated because it does not allow the caller to specify which evdns_base it applies to\&. The recommended function is \fBevdns_base_search_add()\fP\&. 
37 .IP "\fBGlobal \fBevdns_search_clear\fP (void)\fP" 1c
38 This function is deprecated because it does not allow the caller to specify which evdns_base it applies to\&. The recommended function is \fBevdns_base_search_clear()\fP\&.  
39 .IP "\fBGlobal \fBevdns_search_ndots_set\fP (const int ndots)\fP" 1c
40 This function is deprecated because it does not allow the caller to specify which evdns_base it applies to\&. The recommended function is \fBevdns_base_search_ndots_set()\fP\&. 
41 .IP "\fBGlobal \fBevdns_set_option\fP (const char *option, const char *val, int flags)\fP" 1c
42 This function is deprecated because it does not allow the caller to specify which evdns_base it applies to\&. The recommended function is \fBevdns_base_set_option()\fP\&. 
43 .IP "\fBGlobal \fBevdns_shutdown\fP (int fail_requests)\fP" 1c
44 This function is deprecated because it does not allow the caller to specify which evdns_base it applies to\&. The recommended function is evdns_base_shutdown()\&. 
45 .IP "\fBFile \fBevent_compat\&.h\fP \fP" 1c
46 All functions in this file are by definition deprecated\&.  
47 .IP "\fBGlobal \fBevent_dispatch\fP (void)\fP" 1c
48 This function is deprecated because it is easily confused by multiple calls to \fBevent_init()\fP, and because it is not safe for multithreaded use\&. The replacement is \fBevent_base_dispatch()\fP\&. 
49 .IP "\fBGlobal \fBevent_get_method\fP (void)\fP" 1c
50 This function is obsolete, and has been replaced by \fBevent_base_get_method()\fP\&. Its use is deprecated because it relies on the 'current' base configured by \fBevent_init()\fP\&. 
51 .IP "\fBGlobal \fBevent_init\fP (void)\fP" 1c
52 This function is deprecated because it replaces the 'current' \fBevent_base\fP, and is totally unsafe for multithreaded use\&. The replacement is \fBevent_base_new()\fP\&. 
53 .IP "\fBGlobal \fBevent_loop\fP (int)\fP" 1c
54 This function is deprecated because it uses the event base from the last call to event_init, and is therefore not safe for multithreaded use\&. The replacement is \fBevent_base_loop()\fP\&. 
55 .IP "\fBGlobal \fBevent_loopbreak\fP (void)\fP" 1c
56 This function is deprecated because it uses the event base from the last call to event_init, and is therefore not safe for multithreaded use\&. The replacement is \fBevent_base_loopbreak()\fP\&. 
57 .IP "\fBGlobal \fBevent_loopexit\fP (const struct timeval *)\fP" 1c
58 This function is deprecated because it uses the event base from the last call to event_init, and is therefore not safe for multithreaded use\&. The replacement is \fBevent_base_loopexit()\fP\&. 
59 .IP "\fBGlobal \fBevent_once\fP (evutil_socket_t, short, void(*)(evutil_socket_t, short, void *), void *, const struct timeval *)\fP" 1c
60 This function is obsolete, and has been replaced by \fBevent_base_once()\fP\&. Its use is deprecated because it relies on the 'current' base configured by \fBevent_init()\fP\&. 
61 .IP "\fBGlobal \fBevent_priority_init\fP (int)\fP" 1c
62 This function is deprecated because it is easily confused by multiple calls to \fBevent_init()\fP, and because it is not safe for multithreaded use\&. The replacement is \fBevent_base_priority_init()\fP\&. 
63 .IP "\fBGlobal \fBevent_set\fP (struct event *, evutil_socket_t, short, void(*)(evutil_socket_t, short, void *), void *)\fP" 1c
64 \fBevent_set()\fP is not recommended for new code, because it requires a subsequent call to \fBevent_base_set()\fP to be safe under most circumstances\&. Use \fBevent_assign()\fP or \fBevent_new()\fP instead\&.  
65 .IP "\fBGlobal \fBevhttp_connection_new\fP (const char *address, unsigned short port)\fP" 1c
66 It does not allow an event base to be specified  
67 .IP "\fBGlobal \fBevhttp_connection_set_base\fP (struct evhttp_connection *evcon, struct \fBevent_base\fP *base)\fP" 1c
68 XXXX Why?  
69 .IP "\fBGlobal \fBevhttp_decode_uri\fP (const char *uri)\fP" 1c
70 This function is deprecated; you probably want to use evhttp_get_decoded_uri instead\&. 
71 .IP "\fBGlobal \fBevhttp_parse_query\fP (const char *uri, struct evkeyvalq *headers)\fP" 1c
72 This function is deprecated as of Libevent 2\&.0\&.9\&. Use evhttp_uri_parse and evhttp_parse_query_str instead\&. 
73 .IP "\fBGlobal \fBevhttp_start\fP (const char *address, unsigned short port)\fP" 1c
74 It does not allow an event base to be specified 
75 .IP "\fBModule \fBMisnamed functions\fP \fP" 1c
76 These macros are deprecated because their names don't follow Libevent's naming conventions\&. Use evtag_encode_int and evtag_encode_int64 instead\&. 
77 .IP "\fBModule \fBsignal_* macros\fP \fP" 1c
78 These macros are deprecated because their naming is inconsistent with the rest of Libevent\&. Use the evsignal_* macros instead\&.
79 .PP
80 .IP "\fBModule \fBtimeout_* macros\fP \fP" 1c
81 These macros are deprecated because their naming is inconsistent with the rest of Libevent\&. Use the evtimer_* macros instead\&.
82 .PP
83 .PP