Back to index

lightning-sunbird  0.9+nobinonly
plresolv.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is the Netscape Portable Runtime (NSPR).
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998-2000
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either the GNU General Public License Version 2 or later (the "GPL"), or
00026  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 /*
00039  * plresolv.h - asynchronous name resolution using DNS 
00040  */
00041 
00042 #ifndef _PLRESOLV_H_
00043 #define _PLRESOLV_H_
00044 
00045 /*
00046 ** THIS IS WORK IN PROGRESS. DO NOT ATTEMPT TO USE ANY PORTION OF THIS
00047 ** API UNTIL THIS MESSAGE NO LONGER EXISTS. IF YOU DO, THEN YOU SURRENDER
00048 ** THE RIGHT TO COMPLAIN ABOUT ANY CONTENT.
00049 */
00050 
00051 #if defined(XP_UNIX)
00052 
00053 #include <prtypes.h>
00054 #include <prnetdb.h>
00055 
00056 NSPR_BEGIN_EXTERN_C
00057 
00058 #define PL_RESOLVE_MAXHOSTENTBUF        1024
00059 #define PL_RESOLVE_DEFAULT_TIMEOUT      0
00060 
00061 /* Error return codes */
00062 #define PL_RESOLVE_OK            0
00063 #define PL_RESOLVE_EWINIT        1           /* Failed to initialize window */
00064 #define PL_RESOLVE_EMAKE         2           /* Failed to create request */
00065 #define PL_RESOLVE_ELAUNCH       3           /* Error launching Async request */
00066 #define PL_RESOLVE_ETIMEDOUT     4           /* Request timed-out */
00067 #define PL_RESOLVE_EINVAL        5           /* Invalid argument */
00068 #define PL_RESOLVE_EOVERFLOW     6           /* Buffer Overflow */
00069 #define PL_RESOLVE_EUNKNOWN      7           /* berserk error */
00070 
00071 /* ----------- Function Prototypes ----------------*/
00072 
00073 PR_EXTERN(PRStatus) PL_ResolveName(
00074     const char *name, unsigned char *buf,
00075     PRIntn bufsize, PRIntervalTime timeout,
00076     PRHostEnt *hostentry, PRIntervalTime *ttl);
00077 
00078 PR_EXTERN(PRStatus) PL_ResolveAddr(
00079     const PRNetAddr *address, unsigned char *buf,
00080     PRIntn bufsize, PRIntervalTime timeout,
00081     PRHostEnt *hostentry, PRIntervalTime *ttl);
00082 
00083 typedef struct PLResolveStats {
00084     int re_errors;
00085     int re_nu_look;
00086     int re_na_look;
00087     int re_replies;
00088     int re_requests;
00089     int re_resends;
00090     int re_sent;
00091     int re_timeouts;
00092 } PLResolveStats;
00093 
00094 typedef struct PLResoveInfo {
00095     PRBool enabled;
00096     PRUint32 numNameLookups;
00097     PRUint32 numAddrLookups;
00098     PRUint32 numLookupsInProgress;
00099     PLResolveStats stats;
00100 } PLResoveInfo;
00101 
00102 PR_EXTERN(void) PL_ResolveInfo(PLResoveInfo *info);
00103 
00104 NSPR_END_EXTERN_C
00105 
00106 #endif /* defined(XP_UNIX) */
00107 
00108 #endif /* _PLRESOLV_H_ */