include/rpc/pmap_clnt.h

   1 /*      $NetBSD: pmap_clnt.h,v 1.9 2000/06/02 22:57:55 fvdl Exp $       */
   2
   3 /*-
   4  * SPDX-License-Identifier: BSD-3-Clause
   5  *
   6  * Copyright (c) 2009, Sun Microsystems, Inc.
   7  * All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions are met:
  11  * - Redistributions of source code must retain the above copyright notice,
  12  *   this list of conditions and the following disclaimer.
  13  * - Redistributions in binary form must reproduce the above copyright notice,
  14  *   this list of conditions and the following disclaimer in the documentation
  15  *   and/or other materials provided with the distribution.
  16  * - Neither the name of Sun Microsystems, Inc. nor the names of its
  17  *   contributors may be used to endorse or promote products derived
  18  *   from this software without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  24  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  30  * POSSIBILITY OF SUCH DAMAGE.
  31  *
  32  *      from: @(#)pmap_clnt.h 1.11 88/02/08 SMI
  33  *      from: @(#)pmap_clnt.h   2.1 88/07/29 4.0 RPCSRC
  34  * $FreeBSD$
  35  */
  36
  37 /*
  38  * pmap_clnt.h
  39  * Supplies C routines to get to portmap services.
  40  *
  41  * Copyright (C) 1984, Sun Microsystems, Inc.
  42  */
  43
  44 /*
  45  * Usage:
  46  *      success = pmap_set(program, version, protocol, port);
  47  *      success = pmap_unset(program, version);
  48  *      port = pmap_getport(address, program, version, protocol);
  49  *      head = pmap_getmaps(address);
  50  *      clnt_stat = pmap_rmtcall(address, program, version, procedure,
  51  *              xdrargs, argsp, xdrres, resp, tout, port_ptr)
  52  *              (works for udp only.)
  53  *      clnt_stat = clnt_broadcast(program, version, procedure,
  54  *              xdrargs, argsp, xdrres, resp, eachresult)
  55  *              (like pmap_rmtcall, except the call is broadcasted to all
  56  *              locally connected nets.  For each valid response received,
  57  *              the procedure eachresult is called.  Its form is:
  58  *      done = eachresult(resp, raddr)
  59  *              bool_t done;
  60  *              caddr_t resp;
  61  *              struct sockaddr_in raddr;
  62  *              where resp points to the results of the call and raddr is the
  63  *              address if the responder to the broadcast.
  64  */
  65
  66 #ifndef _RPC_PMAP_CLNT_H_
  67 #define _RPC_PMAP_CLNT_H_
  68 #include <sys/cdefs.h>
  69
  70 __BEGIN_DECLS
  71 extern bool_t           pmap_set(u_long, u_long, int, int);
  72 extern bool_t           pmap_unset(u_long, u_long);
  73 extern struct pmaplist  *pmap_getmaps(struct sockaddr_in *);
  74 extern enum clnt_stat   pmap_rmtcall(struct sockaddr_in *,
  75                                      u_long, u_long, u_long,
  76                                      xdrproc_t, caddr_t,
  77                                      xdrproc_t, caddr_t,
  78                                      struct timeval, u_long *);
  79 extern enum clnt_stat   clnt_broadcast(u_long, u_long, u_long,
  80                                        xdrproc_t, void *,
  81                                        xdrproc_t, void *,
  82                                        resultproc_t);
  83 extern u_short          pmap_getport(struct sockaddr_in *,
  84                                      u_long, u_long, u_int);
  85 __END_DECLS
  86
  87 #endif /* !_RPC_PMAP_CLNT_H_ */