diff options
| author | Daniel Stenberg <daniel@haxx.se> | 2008-12-03 09:59:50 +0000 |
|---|---|---|
| committer | Daniel Stenberg <daniel@haxx.se> | 2008-12-03 09:59:50 +0000 |
| commit | dd3594c6b3271e47d9b3bfcb1b6045b4da8820cd (patch) | |
| tree | 111418ac692ae2ebd0ce016175e072b7cde0cb29 /ares/ares.h | |
| parent | f7ea43151623042dc8e51d6c4076bdddf515f5a1 (diff) | |
| download | curl-dd3594c6b3271e47d9b3bfcb1b6045b4da8820cd.tar.gz | |
Introduce ares_dup(3) and new thoughts about API/ABI and how to move forwards.
Also discussed on the ml.
Diffstat (limited to 'ares/ares.h')
| -rw-r--r-- | ares/ares.h | 26 |
1 files changed, 24 insertions, 2 deletions
diff --git a/ares/ares.h b/ares/ares.h index 0f162e2a1..e4dc7e3d8 100644 --- a/ares/ares.h +++ b/ares/ares.h @@ -1,7 +1,7 @@ /* $Id$ */ /* Copyright 1998 by the Massachusetts Institute of Technology. - * Copyright (C) 2007 by Daniel Stenberg + * Copyright (C) 2007-2008 by Daniel Stenberg * * Permission to use, copy, modify, and distribute this * software and its documentation for any purpose and without @@ -180,6 +180,26 @@ typedef void (*ares_sock_state_cb)(void *data, struct apattern; +/* NOTE about the ares_options struct to users and developers. + + This struct will remain looking like this. It will not be extended nor + shrunk in future releases, but all new options will be set by ares_set_*() + options instead of with the ares_init_options() function. + + Eventually (in a galaxy far far away), all options will be settable by + ares_set_*() options and the ares_init_options() function will become + deprecated. + + ares_save_options() is considered deprecated as of right now. Use ares_dup() + instead! + + So, if new options are added they are not added to this struct. And they + are not "saved" with the ares_save_options() function but instead we + encourage the use of the ares_dup() function. Needless to say, if you add + config options to c-ares you need to make sure ares_dup() duplicates this + new option. + + */ struct ares_options { int flags; int timeout; /* in seconds or milliseconds, depending on options */ @@ -215,8 +235,10 @@ typedef void (*ares_nameinfo_callback)(void *arg, int status, int timeouts, int ares_init(ares_channel *channelptr); int ares_init_options(ares_channel *channelptr, struct ares_options *options, int optmask); -int ares_save_options(ares_channel channel, struct ares_options *options, int *optmask); +int ares_save_options(ares_channel channel, struct ares_options *options, + int *optmask); void ares_destroy_options(struct ares_options *options); +int ares_dup(ares_channel *dest, ares_channel src); void ares_destroy(ares_channel channel); void ares_cancel(ares_channel channel); void ares_send(ares_channel channel, const unsigned char *qbuf, int qlen, |