include/rpcsvc/ypclnt.h

   1 /*
   2  * Copyright (c) 1992/3 Theo de Raadt <deraadt@fsa.ca>
   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  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. The name of the author may not be used to endorse or promote
  14  *    products derived from this software without specific prior written
  15  *    permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
  18  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
  21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  *
  29  * $FreeBSD$
  30  */
  31
  32 #ifndef _RPCSVC_YPCLNT_H_
  33 #define _RPCSVC_YPCLNT_H_
  34
  35 #include <sys/cdefs.h>
  36
  37 #define YPERR_BADARGS   1               /* args to function are bad */
  38 #define YPERR_RPC       2               /* RPC failure */
  39 #define YPERR_DOMAIN    3               /* can't bind to a server for domain */
  40 #define YPERR_MAP       4               /* no such map in server's domain */
  41 #define YPERR_KEY       5               /* no such key in map */
  42 #define YPERR_YPERR     6               /* some internal YP server or client error */
  43 #define YPERR_RESRC     7               /* local resource allocation failure */
  44 #define YPERR_NOMORE    8               /* no more records in map database */
  45 #define YPERR_PMAP      9               /* can't communicate with portmapper */
  46 #define YPERR_YPBIND    10              /* can't communicate with ypbind */
  47 #define YPERR_YPSERV    11              /* can't communicate with ypserv */
  48 #define YPERR_NODOM     12              /* local domain name not set */
  49 #define YPERR_BADDB     13              /* YP data base is bad */
  50 #define YPERR_VERS      14              /* YP version mismatch */
  51 #define YPERR_ACCESS    15              /* access violation */
  52 #define YPERR_BUSY      16              /* database is busy */
  53
  54 /*
  55  * Types of update operations
  56  */
  57 #define YPOP_CHANGE     1               /* change, do not add */
  58 #define YPOP_INSERT     2               /* add, do not change */
  59 #define YPOP_DELETE     3               /* delete this entry */
  60 #define YPOP_STORE      4               /* add, or change */
  61
  62 struct ypall_callback {
  63         /* return non-0 to stop getting called */
  64         int (*foreach)(unsigned long, char *, int, char *, int, void *);
  65         char *data;             /* opaque pointer for use of callback fn */
  66 };
  67
  68 struct dom_binding;
  69 struct ypmaplist;
  70 struct ypall_callback;
  71
  72 __BEGIN_DECLS
  73 int     yp_bind(char *dom);
  74 int     _yp_dobind(char *dom, struct dom_binding **ypdb);
  75 void    yp_unbind(char *dom);
  76 int     yp_get_default_domain(char **domp);
  77 int     yp_match(char *indomain, char *inmap, const char *inkey, int inkeylen,
  78             char **outval, int *outvallen);
  79 int     yp_first(char *indomain, char *inmap, char **outkey, int *outkeylen,
  80             char **outval, int *outvallen);
  81 int     yp_next(char *indomain, char *inmap, char *inkey, int inkeylen,
  82             char **outkey, int *outkeylen, char **outval, int *outvallen);
  83 int     yp_maplist(char *indomain, struct ypmaplist **outmaplist);
  84 int     yp_master(char *indomain, char *inmap, char **outname);
  85 int     yp_order(char *indomain, char *inmap, int *outorder);
  86 int     yp_all(char *indomain, char *inmap, struct ypall_callback *incallback);
  87 const char *yperr_string(int incode);
  88 const char *ypbinderr_string(int incode);
  89 int     ypprot_err(unsigned int incode);
  90 __END_DECLS
  91
  92 #endif /* _RPCSVC_YPCLNT_H_ */
  93