include/rpcsvc/ypclnt.h

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