am 6cdab387: Merge "Restore <nsswitch.h> which is BSD API, not private."
[android-sdk/platform-bionic.git] / libc / dns / include / resolv_cache.h
1 /*
2  * Copyright (C) 2008 The Android Open Source Project
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *  * Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  *  * Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in
12  *    the documentation and/or other materials provided with the
13  *    distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
18  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
19  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
21  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
22  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
23  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
25  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 #ifndef _RESOLV_CACHE_H_
29 #define _RESOLV_CACHE_H_
31 #include <stddef.h>
32 #include <sys/cdefs.h>
34 struct __res_state;
35 struct resolv_cache;  /* forward */
37 /* Gets the cache for a network. Returned cache might be NULL. */
38 __LIBC_HIDDEN__
39 extern struct resolv_cache* __get_res_cache(unsigned netid);
41 /* sets the name server addresses to the provided res_state structure. The
42  * name servers are retrieved from the cache which is associated
43  * with the network to which the res_state structure is associated */
44 __LIBC_HIDDEN__
45 extern void _resolv_populate_res_for_net(struct __res_state* statp);
47 typedef enum {
48     RESOLV_CACHE_UNSUPPORTED,  /* the cache can't handle that kind of queries */
49                                /* or the answer buffer is too small */
50     RESOLV_CACHE_NOTFOUND,     /* the cache doesn't know about this query */
51     RESOLV_CACHE_FOUND         /* the cache found the answer */
52 } ResolvCacheStatus;
54 __LIBC_HIDDEN__
55 extern ResolvCacheStatus
56 _resolv_cache_lookup( struct resolv_cache*  cache,
57                       const void*           query,
58                       int                   querylen,
59                       void*                 answer,
60                       int                   answersize,
61                       int                  *answerlen );
63 /* add a (query,answer) to the cache, only call if _resolv_cache_lookup
64  * did return RESOLV_CACHE_NOTFOUND
65  */
66 __LIBC_HIDDEN__
67 extern void
68 _resolv_cache_add( struct resolv_cache*  cache,
69                    const void*           query,
70                    int                   querylen,
71                    const void*           answer,
72                    int                   answerlen );
74 /* Notify the cache a request failed */
75 __LIBC_HIDDEN__
76 extern void
77 _resolv_cache_query_failed( struct resolv_cache* cache,
78                    const void* query,
79                    int         querylen);
81 #endif /* _RESOLV_CACHE_H_ */