include/rpcsvc/nis_db.h

   1 /*
   2  * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
   3  * unrestricted use provided that this legend is included on all tape
   4  * media and as a part of the software program in whole or part.  Users
   5  * may copy or modify Sun RPC without charge, but are not authorized
   6  * to license or distribute it to anyone else except as part of a product or
   7  * program developed by the user.
   8  *
   9  * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
  10  * WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
  11  * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
  12  *
  13  * Sun RPC is provided with no support and without any obligation on the
  14  * part of Sun Microsystems, Inc. to assist in its use, correction,
  15  * modification or enhancement.
  16  *
  17  * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
  18  * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
  19  * OR ANY PART THEREOF.
  20  *
  21  * In no event will Sun Microsystems, Inc. be liable for any lost revenue
  22  * or profits or other special, indirect and consequential damages, even if
  23  * Sun has been advised of the possibility of such damages.
  24  *
  25  * Sun Microsystems, Inc.
  26  * 2550 Garcia Avenue
  27  * Mountain View, California  94043
  28  *
  29  * $FreeBSD: src/include/rpcsvc/nis_db.h,v 1.5 1999/08/27 23:45:09 peter Exp $
  30  * $DragonFly: src/include/rpcsvc/nis_db.h,v 1.3 2004/02/25 15:12:54 joerg Exp $
  31  */
  32
  33 /*
  34  * Copyright (c) 1991, by Sun Microsystems Inc.
  35  */
  36
  37 /*
  38  * This header file defines the interface to the NIS database. All
  39  * implementations of the database must export at least these routines.
  40  * They must also follow the conventions set herein. See the implementors
  41  * guide for specific semantics that are required.
  42  */
  43
  44 #ifndef _RPCSVC_NIS_DB_H
  45 #define _RPCSVC_NIS_DB_H
  46
  47
  48 /* From: #pragma ident  "@(#)nis_db.h   1.8     94/05/03 SMI" */
  49
  50 /*
  51  * Note: although the version of <rpcsvc/nis_db.h> shipped with Solaris
  52  * 2.5/2.5.x is actually older than this one (according to the ident
  53  * string), it contains changes and a few added functions. Those changes
  54  * have been hand merged into this file to bring it up to date.
  55  */
  56
  57 #include <sys/cdefs.h>
  58
  59 #include <rpc/rpc.h>
  60 #include <rpcsvc/nis.h>
  61
  62 __BEGIN_DECLS
  63
  64 enum db_status {
  65         DB_SUCCESS = 0,
  66         DB_NOTFOUND = 1,
  67         DB_NOTUNIQUE = 2,
  68         DB_BADTABLE = 3,
  69         DB_BADQUERY = 4,
  70         DB_BADOBJECT = 5,
  71         DB_MEMORY_LIMIT = 6,
  72         DB_STORAGE_LIMIT = 7,
  73         DB_INTERNAL_ERROR = 8
  74 };
  75 typedef enum db_status db_status;
  76
  77 enum db_action {
  78         DB_LOOKUP = 0,
  79         DB_REMOVE = 1,
  80         DB_ADD = 2,
  81         DB_FIRST = 3,
  82         DB_NEXT = 4,
  83         DB_ALL = 5,
  84         DB_RESET_NEXT = 6
  85 };
  86 typedef enum db_action db_action;
  87
  88 typedef entry_obj *entry_object_p;
  89
  90 typedef struct {
  91         u_int db_next_desc_len;
  92         char *db_next_desc_val;
  93 } db_next_desc;
  94
  95 struct db_result {
  96         db_status status;
  97         db_next_desc nextinfo;
  98         struct {
  99                 u_int objects_len;
 100                 entry_object_p *objects_val;
 101         } objects;
 102         long ticks;
 103 };
 104 typedef struct db_result db_result;
 105
 106 /*
 107  * Prototypes for the database functions.
 108  */
 109
 110 bool_t           db_initialize(char *);
 111 #ifdef ORIGINAL_DECLS
 112 bool_t           db_create_table(char *, table_obj *);
 113 bool_t           db_destroy_table(char *);
 114 #else
 115 db_status        db_create_table(char *, table_obj *);
 116 db_status        db_destroy_table(char *);
 117 #endif
 118 db_result       *db_first_entry(char *, int, nis_attr *);
 119 db_result       *db_next_entry(char *, db_next_desc *);
 120 db_result       *db_reset_next_entry(char *, db_next_desc *);
 121 db_result       *db_list_entries(char *, int, nis_attr *);
 122 db_result       *db_add_entry(char *, int,  nis_attr *, entry_obj *);
 123 db_result       *db_remove_entry(char *, int, nis_attr *);
 124 db_status        db_checkpoint(char *);
 125 db_status        db_standby(char *);
 126 #ifndef ORIGINAL_DECLS
 127 db_status        db_table_exists(char *);
 128 db_status        db_unload_table(char *);
 129 void             db_free_result(db_result *);
 130 #endif
 131
 132 __END_DECLS
 133
 134 #endif  /* _RPCSVC_NIS_DB_H */