Merge from vendor branch GROFF:
[dragonfly.git] / include / rpc / pmap_clnt.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, MERCHANTABILITY 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  *      from: @(#)pmap_clnt.h 1.11 88/02/08 SMI
30  *      from: @(#)pmap_clnt.h   2.1 88/07/29 4.0 RPCSRC
31  * $FreeBSD: src/include/rpc/pmap_clnt.h,v 1.11 1999/08/27 23:45:04 peter Exp $
32  * $DragonFly: src/include/rpc/pmap_clnt.h,v 1.6 2004/02/26 13:58:26 joerg Exp $
33  */
34
35 /*
36  * pmap_clnt.h
37  * Supplies C routines to get to portmap services.
38  *
39  * Copyright (C) 1984, Sun Microsystems, Inc.
40  */
41
42 /*
43  * Usage:
44  *      void pmap_getport_timeout(&otv, &ntv);
45  *      success = pmap_set(program, version, protocol, port);
46  *      success = pmap_unset(program, version);
47  *      port = pmap_getport(address, program, version, protocol);
48  *      head = pmap_getmaps(address);
49  *      clnt_stat = pmap_rmtcall(address, program, version, procedure,
50  *              xdrargs, argsp, xdrres, resp, tout, port_ptr)
51  *              (works for udp only.)
52  *      clnt_stat = clnt_broadcast(program, version, procedure,
53  *              xdrargs, argsp, xdrres, resp, eachresult)
54  *              (like pmap_rmtcall, except the call is broadcasted to all
55  *              locally connected nets.)  For each valid response received,
56  *              the procedure eachresult is called.  Its form is:
57  *      done = eachresult(resp, raddr)
58  *              bool_t done;
59  *              caddr_t resp;
60  *              struct sockaddr_in raddr;
61  *              where resp points to the results of the call and raddr is the
62  *              address if the responder to the broadcast.
63  */
64
65 #ifndef _RPC_PMAPCLNT_H
66 #define _RPC_PMAPCLNT_H
67 #include <sys/cdefs.h>
68
69 __BEGIN_DECLS
70 bool_t           pmap_set(u_long, u_long, int, int);
71 bool_t           pmap_unset(u_long, u_long);
72 struct pmaplist *pmap_getmaps(struct sockaddr_in *);
73 enum clnt_stat   pmap_rmtcall(struct sockaddr_in *, u_long, u_long, u_long,
74                               xdrproc_t, caddr_t, xdrproc_t, caddr_t,
75                               struct timeval, u_long *);
76 enum clnt_stat   clnt_broadcast(u_long, u_long, u_long, xdrproc_t, char *,
77                                 xdrproc_t, char *, bool_t (*) (caddr_t,
78                                 struct sockaddr_in *));
79 u_short          pmap_getport(struct sockaddr_in *, u_long, u_long, u_int);
80 void             pmap_getport_timeout(struct timeval *, struct timeval *);
81 __END_DECLS
82
83 #endif /* !_RPC_PMAPCLNT_H */