include/rpc/pmap_clnt.h

   1 /*-
   2  * Copyright (c) 2009, Sun Microsystems, Inc.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are met:
   7  * - Redistributions of source code must retain the above copyright notice,
   8  *   this list of conditions and the following disclaimer.
   9  * - Redistributions in binary form must reproduce the above copyright notice,
  10  *   this list of conditions and the following disclaimer in the documentation
  11  *   and/or other materials provided with the distribution.
  12  * - Neither the name of Sun Microsystems, Inc. nor the names of its
  13  *   contributors may be used to endorse or promote products derived
  14  *   from this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  17  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  20  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  25  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  26  * POSSIBILITY OF SUCH DAMAGE.
  27  *
  28  *      from: @(#)pmap_clnt.h 1.11 88/02/08 SMI
  29  *      from: @(#)pmap_clnt.h   2.1 88/07/29 4.0 RPCSRC
  30  * $NetBSD: pmap_clnt.h,v 1.9 2000/06/02 22:57:55 fvdl Exp $
  31  * $FreeBSD: src/include/rpc/pmap_clnt.h,v 1.14 2002/04/28 15:18:45 des Exp $
  32  * $DragonFly: src/include/rpc/pmap_clnt.h,v 1.7 2005/11/13 12:27:04 swildner 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_PMAP_CLNT_H_
  66 #define _RPC_PMAP_CLNT_H_
  67 #include <sys/cdefs.h>
  68
  69 __BEGIN_DECLS
  70 bool_t           pmap_set(u_long, u_long, int, u_short);
  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, void *,
  77                                 xdrproc_t, void *, resultproc_t);
  78 u_short          pmap_getport(struct sockaddr_in *, u_long, u_long, u_int);
  79 void             pmap_getport_timeout(struct timeval *, struct timeval *);
  80 __END_DECLS
  81
  82 #endif /* !_RPC_PMAP_CLNT_H_ */