summaryrefslogtreecommitdiff
path: root/nis/rpcsvc/nislib.h
diff options
context:
space:
mode:
Diffstat (limited to 'nis/rpcsvc/nislib.h')
-rw-r--r--nis/rpcsvc/nislib.h282
1 files changed, 190 insertions, 92 deletions
diff --git a/nis/rpcsvc/nislib.h b/nis/rpcsvc/nislib.h
index b01270b22d..fa3ee4f65d 100644
--- a/nis/rpcsvc/nislib.h
+++ b/nis/rpcsvc/nislib.h
@@ -24,57 +24,144 @@
__BEGIN_DECLS
-/*
-** nis_names
-*/
-extern nis_result *nis_lookup __P ((__const nis_name, const u_long));
-extern nis_result *nis_add __P ((__const nis_name, const nis_object *));
-extern nis_result *nis_remove __P ((__const nis_name, const nis_object *));
-extern nis_result *nis_modify __P ((__const nis_name, const nis_object *));
-/*
-** nis_table
-*/
-extern nis_result *nis_list __P ((__const nis_name, const u_long,
- int (*)(__const nis_name,
- __const nis_object *,
- __const void *), __const void *));
-extern nis_result *nis_add_entry __P ((__const nis_name, __const nis_object *,
- __const u_long));
-extern nis_result *nis_modify_entry __P ((__const nis_name,
- __const nis_object *,
- __const u_long));
-extern nis_result *nis_remove_entry __P ((__const nis_name,
- __const nis_object *,
- __const u_long));
-extern nis_result *nis_first_entry __P ((__const nis_name));
-extern nis_result *nis_next_entry __P ((__const nis_name, __const netobj *));
+typedef const char *const_nis_name;
+
+/* nis_names: These functions are used to locate and manipulate all NIS+
+ * objects except the NIS+ entry objects.
+ *
+ * nis_lookup (name, flags) resolves a NIS+ name and returns a copy of
+ * that object from a NIS+ server.
+ * const nis_name name: name of the object to be resolved
+ * u_long flags: logically ORing zero or more flags (FOLLOW_LINKS,
+ * HARD_LOOKUP, [NO_CACHE], MASTER_ONLY, EXPAND_NAME)
+ *
+ * nis_add (name, obj) adds objects to the NIS+ namespace.
+ * const nis_name name: fully qualified NIS+ name.
+ * const nis_object *obj: object members zo_name and zo_domain will be
+ * constructed from name.
+ *
+ * nis_remove (name, obj) removes objects from the NIS+ namespace.
+ * const nis_name name: fully qualified NIS+ name.
+ * const nis_object *obj: if not NULL, it is assumed to point to a copy
+ * of the object being removed. In this case, if
+ * the object on the server does not have the same
+ * object identifier as the object being passed,
+ * the operation will fail with the NIS_NOTSAMEOBJ
+ * error.
+ *
+ * nis_modify (name, obj) can change specific attributes of an object
+ * that already exists in the namespace.
+ */
+extern nis_result *nis_lookup __P ((const_nis_name name, u_long flags));
+extern nis_result *nis_add __P ((const_nis_name name, const nis_object *obj));
+extern nis_result *nis_remove __P ((const_nis_name name,
+ const nis_object *obj));
+extern nis_result *nis_modify __P ((const_nis_name name,
+ const nis_object *obj));
+
+/* nis_tables: These functions are used to search and modify NIS+ tables.
+ *
+ * nis_list (table_name, flags, callback(table_name, obj, userdata), userdata)
+ * search a table in the NIS+ namespace.
+ * const nis_name table_name: indexed name ([xx=yy],table.dir)
+ * u_long flags: logically ORing one or more flags (FOLLOW_LINKS,
+ * [FOLLOW_PATH], HARD_LOOKUP, [ALL_RESULTS], [NO_CACHE],
+ * MASTER_ONLY, EXPAND_NAME, RETURN_RESULT)
+ * callback(): callback is an optional pointer to a function that will
+ * process the ENTRY type objects that are returned from the
+ * search. If this pointer is NULL, then all entries that match
+ * the search criteria are returned in the nis_result structure,
+ * otherwise this function will be called once for each
+ * entry returned.
+ * void *userdata: passed to callback function along with the returned
+ * entry object.
+ *
+ * nis_add_entry (table_name, obj, flags) will add the NIS+ object to the
+ * NIS+ table_name.
+ * const nis_name table_name
+ * const nis_object *obj
+ * u_long flags: 0, ADD_OVERWRITE, RETURN_RESULT
+ *
+ * nis_modify_entry (name, obj, flags) modifies an object identified by name.
+ * const nis_name name: object identifier
+ * const nis_object *obj: should point to an entry with the EN_MODIFIED
+ * flag set in each column that contains new
+ * information.
+ * u_long flags: 0, MOD_SAMEOBJ, RETURN_RESULT
+ *
+ * nis_remove_entry (table_name, obj, flags) removes a set of entries
+ * identified by table_name from the table.
+ * const nis_name table_name: indexed NIS+ name
+ * const nis_object *obj: if obj is non-null, it is presumed to point to
+ * a cached copy of the entry. When the removal is
+ * attempted, and the object that would be removed
+ * is not the same as the cached object pointed to
+ * by object then the operation will fail with an
+ * NIS_NOTSAMEOBJ error
+ * u_long flags: 0, REM_MULTIPLE
+ *
+ * nis_first_entry (table_name) fetches entries from a table one at a time.
+ * const nis_name table_name
+ *
+ * nis_next_entry (table_name, cookie) retrieves the "next" entry from a
+ * table specified by table_name.
+ * const nis_name table_name:
+ * const netobj *cookie: The value of cookie from the nis_result structure
+ * form the previous call.
+ */
+extern nis_result *nis_list __P ((const_nis_name name, u_long flags,
+ int (*callback)(const_nis_name table_name,
+ const nis_object *obj,
+ const void *userdata),
+ const void *userdata));
+extern nis_result *nis_add_entry __P ((const_nis_name table_name,
+ const nis_object *obj, u_long flags));
+extern nis_result *nis_modify_entry __P ((const_nis_name name,
+ const nis_object *obj,
+ u_long flags));
+extern nis_result *nis_remove_entry __P ((const_nis_name table_name,
+ const nis_object *obj,
+ u_long flags));
+extern nis_result *nis_first_entry __P ((const_nis_name table_name));
+extern nis_result *nis_next_entry __P ((const_nis_name table_name,
+ const netobj *cookie));
/*
** nis_server
*/
-extern nis_error nis_mkdir __P ((__const nis_name, __const nis_server *));
-extern nis_error nis_rmdir __P ((__const nis_name, __const nis_server *));
-extern nis_error nis_servstate __P ((__const nis_server *, __const nis_tag *,
- __const int, nis_tag **));
-extern nis_error nis_stats __P ((__const nis_server *, __const nis_tag *,
- __const int, nis_tag **));
-extern void nis_freetags __P ((nis_tag *, __const int));
-extern nis_server **nis_getservlist __P ((__const nis_name));
-extern void nis_freeservlist __P ((nis_server **));
+extern nis_error nis_mkdir __P ((const_nis_name dirname,
+ const nis_server *machine));
+extern nis_error nis_rmdir __P ((const_nis_name dirname,
+ const nis_server *machine));
+extern nis_error nis_servstate __P ((const nis_server *machine,
+ const nis_tag *tags, int numtags,
+ nis_tag **result));
+extern nis_error nis_stats __P ((const nis_server *machine,
+ const nis_tag *tags, int numtags,
+ nis_tag **result));
+extern void nis_freetags __P ((nis_tag *tags, int numtags));
+extern nis_server **nis_getservlist __P ((const_nis_name dirname));
+extern void nis_freeservlist __P ((nis_server **machines));
+
/*
** nis_subr
*/
-extern nis_name nis_leaf_of __P ((__const nis_name));
-extern nis_name nis_leaf_of_r __P ((__const nis_name, char *, size_t));
-extern nis_name nis_name_of __P ((__const nis_name));
-extern nis_name nis_name_of_r __P ((__const nis_name, char *, size_t));
-extern nis_name nis_domain_of __P ((__const nis_name));
-extern nis_name nis_domain_of_r __P ((__const nis_name, char *, size_t));
-extern nis_name *nis_getnames __P ((__const nis_name));
-extern void nis_freenames __P ((nis_name *));
-extern name_pos nis_dir_cmp __P ((nis_name, nis_name));
-extern nis_object *nis_clone_object __P ((__const nis_object *, nis_object *));
-extern void nis_destroy_object __P ((nis_object *));
-extern void nis_print_object __P ((__const nis_object *));
+extern nis_name nis_leaf_of __P ((const_nis_name name));
+extern nis_name nis_leaf_of_r __P ((const_nis_name name, char *buffer,
+ size_t buflen));
+extern nis_name nis_name_of __P ((const_nis_name name));
+extern nis_name nis_name_of_r __P ((const_nis_name name, char *buffer,
+ size_t buflen));
+extern nis_name nis_domain_of __P ((const_nis_name name));
+extern nis_name nis_domain_of_r __P ((const_nis_name name, char *buffer,
+ size_t buflen));
+extern nis_name *nis_getnames __P ((const_nis_name name));
+extern void nis_freenames __P ((nis_name *namelist));
+extern name_pos nis_dir_cmp __P ((const_nis_name n1, const_nis_name n2));
+extern nis_object *nis_clone_object __P ((const nis_object *src,
+ nis_object *dest));
+extern void nis_destroy_object __P ((nis_object *obj));
+extern void nis_print_object __P ((const nis_object *obj));
+
/*
** nis_local_names
*/
@@ -82,81 +169,92 @@ extern nis_name nis_local_group __P ((void));
extern nis_name nis_local_directory __P ((void));
extern nis_name nis_local_principal __P ((void));
extern nis_name nis_local_host __P ((void));
+
/*
** nis_error
*/
-extern const char *nis_sperrno __P ((__const nis_error));
-extern void nis_perror __P ((__const nis_error, __const char *));
-extern void nis_lerror __P ((__const nis_error, __const char *));
-extern char *nis_sperror __P ((__const nis_error, __const char *));
-extern char *nis_sperror_r __P ((__const nis_error, __const char *,
- char *, size_t));
+extern const char *nis_sperrno __P ((const nis_error status));
+extern void nis_perror __P ((const nis_error status, const char *label));
+extern void nis_lerror __P ((const nis_error status, const char *label));
+extern char *nis_sperror __P ((const nis_error status, const char *label));
+extern char *nis_sperror_r __P ((const nis_error status, const char *label,
+ char *buffer, size_t buflen));
/*
** nis_groups
*/
-extern bool_t nis_ismember __P ((__const nis_name, __const nis_name));
-extern nis_error nis_addmember __P ((__const nis_name, __const nis_name));
-extern nis_error nis_removemember __P ((__const nis_name, __const nis_name));
-extern nis_error nis_creategroup __P ((__const nis_name, __const u_long));
-extern nis_error nis_destroygroup __P ((__const nis_name));
-extern void nis_print_group_entry __P ((__const nis_name));
-extern nis_error nis_verifygroup __P ((__const nis_name));
+extern bool_t nis_ismember __P ((const_nis_name principal,
+ const_nis_name group));
+extern nis_error nis_addmember __P ((const_nis_name member,
+ const_nis_name group));
+extern nis_error nis_removemember __P ((const_nis_name member,
+ const_nis_name group));
+extern nis_error nis_creategroup __P ((const_nis_name group, u_long flags));
+extern nis_error nis_destroygroup __P ((const_nis_name group));
+extern void nis_print_group_entry __P ((const_nis_name group));
+extern nis_error nis_verifygroup __P ((const_nis_name group));
+
/*
** nis_ping
*/
-extern void nis_ping __P ((__const nis_name, __const u_long,
- __const nis_object *));
-extern nis_result *nis_checkpoint __P ((__const nis_name));
+extern void nis_ping __P ((const_nis_name dirname, u_long utime,
+ const nis_object *dirobj));
+extern nis_result *nis_checkpoint __P ((const_nis_name dirname));
/*
** nis_print (XXX INTERNAL FUNCTIONS, SHOULD NOT BE USED !!)
*/
-extern void nis_print_result __P ((__const nis_result *));
-extern void nis_print_rights __P ((__const u_long));
-extern void nis_print_directory __P ((__const directory_obj *));
-extern void nis_print_group __P ((__const group_obj *));
-extern void nis_print_table __P ((__const table_obj *));
-extern void nis_print_link __P ((__const link_obj *));
-extern void nis_print_entry __P ((__const entry_obj *));
+extern void nis_print_result __P ((const nis_result *result));
+extern void nis_print_rights __P ((u_long rights));
+extern void nis_print_directory __P ((const directory_obj *dirobj));
+extern void nis_print_group __P ((const group_obj *grpobj));
+extern void nis_print_table __P ((const table_obj *tblobj));
+extern void nis_print_link __P ((const link_obj *lnkobj));
+extern void nis_print_entry __P ((const entry_obj *enobj));
+
/*
** nis_file (XXX INTERNAL FUNCTIONS, SHOULD NOT BE USED !!)
*/
extern directory_obj *readColdStartFile __P ((void));
-extern bool_t writeColdStartFile __P ((__const directory_obj *));
-extern nis_object *nis_read_obj __P ((__const char *));
-extern bool_t nis_write_obj __P ((__const char *, __const nis_object *));
+extern bool_t writeColdStartFile __P ((const directory_obj *dirobj));
+extern nis_object *nis_read_obj __P ((const char *obj));
+extern bool_t nis_write_obj __P ((const char *file, const nis_object *obj));
+
/*
** nis_clone - (XXX INTERNAL FUNCTIONS, SHOULD NOT BE USED !!)
*/
+extern directory_obj *nis_clone_directory __P ((const directory_obj *src,
+ directory_obj *dest));
+extern group_obj *nis_clone_group __P ((const group_obj *src,
+ group_obj *dest));
+extern table_obj *nis_clone_table __P ((const table_obj *src,
+ table_obj *dest));
+extern entry_obj *nis_clone_entry __P ((const entry_obj *src,
+ entry_obj *dest));
+extern link_obj *nis_clone_link __P ((const link_obj *src, link_obj *dest));
+extern objdata *nis_clone_objdata __P ((const objdata *src, objdata *dest));
+extern nis_result *nis_clone_result __P ((const nis_result *src,
+ nis_result *dest));
-extern directory_obj *nis_clone_directory __P ((__const directory_obj *,
- directory_obj *));
-extern group_obj *nis_clone_group __P ((__const group_obj *, group_obj *));
-extern table_obj *nis_clone_table __P ((__const table_obj *, table_obj *));
-extern entry_obj *nis_clone_entry __P ((__const entry_obj *, entry_obj *));
-extern link_obj *nis_clone_link __P ((__const link_obj *, link_obj *));
-extern objdata *nis_clone_objdata __P ((__const objdata *, objdata *));
-extern nis_result *nis_clone_result __P ((__const nis_result *, nis_result *));
/*
** nis_free - nis_freeresult
*/
-extern void nis_freeresult __P ((nis_result *));
-/* (XXX INTERNAL FUNCTIONS, SHOULD NOT BE USED !!) */
-extern void nis_free_attr __P ((nis_attr *));
-extern void nis_free_request __P ((ib_request *));
-extern void nis_free_endpoints __P ((endpoint *, unsigned int));
-extern void nis_free_servers __P ((nis_server *, unsigned int));
-extern void nis_free_directory __P ((directory_obj *));
-extern void nis_free_group __P ((group_obj *));
-extern void nis_free_table __P ((table_obj *));
-extern void nis_free_entry __P ((entry_obj *));
-extern void nis_free_link __P ((link_obj *));
-extern void nis_free_object __P ((nis_object *));
+extern void nis_freeresult __P ((nis_result *result));
+/* (XXX THE FOLLOWING ARE INTERNAL FUNCTIONS, SHOULD NOT BE USED !!) */
+extern void nis_free_attr __P ((nis_attr *attr));
+extern void nis_free_request __P ((ib_request *req));
+extern void nis_free_endpoints __P ((endpoint *ep, unsigned int count));
+extern void nis_free_servers __P ((nis_server *machine, unsigned int count));
+extern void nis_free_directory __P ((directory_obj *dirobj));
+extern void nis_free_group __P ((group_obj *grpobj));
+extern void nis_free_table __P ((table_obj *tblobj));
+extern void nis_free_entry __P ((entry_obj *enobj));
+extern void nis_free_link __P ((link_obj *lnkobj));
+extern void nis_free_object __P ((nis_object *obj));
/* This is the SUN definition, but I don't know for what we need
the directory_obj parameter */
/* extern fd_result *nis_finddirectory __P ((directory_obj *, nis_name)); */
-extern fd_result *__nis_finddirectory __P ((nis_name));
+extern fd_result *__nis_finddirectory __P ((const_nis_name name));
extern int __start_clock(int);
extern u_long __stop_clock(int);
generated by cgit v1.2.3 (git 2.39.1) at 2024-04-19 20:36:33 +0000