xref: /openbsd/include/rpc/pmap_clnt.h (revision 898184e3)
1 /*	$OpenBSD: pmap_clnt.h,v 1.7 2010/09/01 14:43:34 millert Exp $	*/
2 /*	$NetBSD: pmap_clnt.h,v 1.5 1994/12/04 01:12:42 cgd Exp $	*/
3 
4 /*
5  * Copyright (c) 2010, Oracle America, Inc.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions are
9  * met:
10  *
11  *     * Redistributions of source code must retain the above copyright
12  *       notice, this list of conditions and the following disclaimer.
13  *     * Redistributions in binary form must reproduce the above
14  *       copyright notice, this list of conditions and the following
15  *       disclaimer in the documentation and/or other materials
16  *       provided with the distribution.
17  *     * Neither the name of the "Oracle America, Inc." nor the names of its
18  *       contributors may be used to endorse or promote products derived
19  *       from this software without specific prior written permission.
20  *
21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  *   FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25  *   COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
26  *   INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  *   DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
28  *   GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29  *   INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
30  *   WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
31  *   NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33  *
34  *	from: @(#)pmap_clnt.h 1.11 88/02/08 SMI
35  *	@(#)pmap_clnt.h	2.1 88/07/29 4.0 RPCSRC
36  */
37 
38 /*
39  * pmap_clnt.h
40  * Supplies C routines to get to portmap services.
41  */
42 
43 /*
44  * Usage:
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 extern bool_t		pmap_set(unsigned long, unsigned long, unsigned int,
71 			    int);
72 extern bool_t		pmap_unset(unsigned long, unsigned long);
73 extern struct pmaplist	*pmap_getmaps(struct sockaddr_in *);
74 extern enum clnt_stat	pmap_rmtcall(struct sockaddr_in *, unsigned long,
75 			    unsigned long, unsigned long, xdrproc_t, caddr_t,
76 			    xdrproc_t, caddr_t, struct timeval,
77 			    unsigned long *);
78 extern enum clnt_stat	clnt_broadcast(unsigned long, unsigned long,
79 			    unsigned long, xdrproc_t, char *, xdrproc_t, char *,
80 			    bool_t (*)(caddr_t, struct sockaddr_in *));
81 extern unsigned short	pmap_getport(struct sockaddr_in *, unsigned long,
82 			    unsigned long, unsigned int);
83 __END_DECLS
84 
85 #endif /* !_RPC_PMAPCLNT_H */
86