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
 30/*
 31 * Copyright (c) 1991, by Sun Microsystems Inc.
 32 */
 33
 34/*
 35 * This header file defines the interface to the NIS database. All
 36 * implementations of the database must export at least these routines.
 37 * They must also follow the conventions set herein. See the implementors
 38 * guide for specific semantics that are required.
 39 */
 40
 41#ifndef	_RPCSVC_NIS_DB_H
 42#define	_RPCSVC_NIS_DB_H
 43
 44
 45/* From: #pragma ident	"@(#)nis_db.h	1.8	94/05/03 SMI" */
 46
 47/*
 48 * Note: although the version of <rpcsvc/nis_db.h> shipped with Solaris
 49 * 2.5/2.5.x is actually older than this one (according to the ident
 50 * string), it contains changes and a few added functions. Those changes
 51 * have been hand merged into this file to bring it up to date.
 52 */
 53
 54#include <rpc/rpc.h>
 55#include <rpcsvc/nis.h>
 56
 57#ifdef	__cplusplus
 58extern "C" {
 59#endif
 60
 61enum db_status {
 62	DB_SUCCESS = 0,
 63	DB_NOTFOUND = 1,
 64	DB_NOTUNIQUE = 2,
 65	DB_BADTABLE = 3,
 66	DB_BADQUERY = 4,
 67	DB_BADOBJECT = 5,
 68	DB_MEMORY_LIMIT = 6,
 69	DB_STORAGE_LIMIT = 7,
 70	DB_INTERNAL_ERROR = 8
 71};
 72typedef enum db_status db_status;
 73
 74enum db_action {
 75	DB_LOOKUP = 0,
 76	DB_REMOVE = 1,
 77	DB_ADD = 2,
 78	DB_FIRST = 3,
 79	DB_NEXT = 4,
 80	DB_ALL = 5,
 81	DB_RESET_NEXT = 6
 82};
 83typedef enum db_action db_action;
 84
 85typedef entry_obj *entry_object_p;
 86
 87typedef struct {
 88	u_int db_next_desc_len;
 89	char *db_next_desc_val;
 90} db_next_desc;
 91
 92struct db_result {
 93	db_status status;
 94	db_next_desc nextinfo;
 95	struct {
 96		u_int objects_len;
 97		entry_object_p *objects_val;
 98	} objects;
 99	long ticks;
100};
101typedef struct db_result db_result;
102
103/*
104 * Prototypes for the database functions.
105 */
106
107extern bool_t db_initialize(char *);
108#ifdef ORIGINAL_DECLS
109extern bool_t db_create_table(char *, table_obj *);
110extern bool_t db_destroy_table(char *);
111#else
112extern db_status db_create_table(char *, table_obj *);
113extern db_status db_destroy_table(char *);
114#endif
115extern db_result *db_first_entry(char *, int, nis_attr *);
116extern db_result *db_next_entry(char *, db_next_desc *);
117extern db_result *db_reset_next_entry(char *, db_next_desc *);
118extern db_result *db_list_entries(char *, int, nis_attr *);
119extern db_result *db_add_entry(char *, int,  nis_attr *, entry_obj *);
120extern db_result *db_remove_entry(char *, int, nis_attr *);
121extern db_status db_checkpoint(char *);
122extern db_status db_standby(char *);
123#ifndef ORIGINAL_DECLS
124extern db_status db_table_exists(char *);
125extern db_status db_unload_table(char *);
126extern void db_free_result(db_result *);
127#endif
128
129#ifdef __cplusplus
130}
131#endif
132
133#endif	/* _RPCSVC_NIS_DB_H */