sunrpc/rpc/pmap_clnt.h

   1 /* @(#)pmap_clnt.h      2.1 88/07/29 4.0 RPCSRC; from 1.11 88/02/08 SMI */
   2 /*
   3  * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
   4  * unrestricted use provided that this legend is included on all tape
   5  * media and as a part of the software program in whole or part.  Users
   6  * may copy or modify Sun RPC without charge, but are not authorized
   7  * to license or distribute it to anyone else except as part of a product or
   8  * program developed by the user.
   9  *
  10  * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
  11  * WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
  12  * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
  13  *
  14  * Sun RPC is provided with no support and without any obligation on the
  15  * part of Sun Microsystems, Inc. to assist in its use, correction,
  16  * modification or enhancement.
  17  *
  18  * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
  19  * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
  20  * OR ANY PART THEREOF.
  21  *
  22  * In no event will Sun Microsystems, Inc. be liable for any lost revenue
  23  * or profits or other special, indirect and consequential damages, even if
  24  * Sun has been advised of the possibility of such damages.
  25  *
  26  * Sun Microsystems, Inc.
  27  * 2550 Garcia Avenue
  28  * Mountain View, California  94043
  29  */
  30
  31 /*
  32  * pmap_clnt.h
  33  * Supplies C routines to get to portmap services.
  34  *
  35  * Copyright (C) 1984, Sun Microsystems, Inc.
  36  */
  37
  38 #ifndef _RPC_PMAP_CLNT_H
  39 #define _RPC_PMAP_CLNT_H        1
  40
  41 #include <features.h>
  42 #include <rpc/types.h>
  43 #include <rpc/xdr.h>
  44 #include <rpc/clnt.h>
  45
  46 __BEGIN_DECLS
  47
  48 typedef bool_t (*resultproc_t) (caddr_t resp, struct sockaddr_in *raddr);
  49
  50 /*
  51  * Usage:
  52  *      success = pmap_set(program, version, protocol, port);
  53  *      success = pmap_unset(program, version);
  54  *      port = pmap_getport(address, program, version, protocol);
  55  *      head = pmap_getmaps(address);
  56  *      clnt_stat = pmap_rmtcall(address, program, version, procedure,
  57  *              xdrargs, argsp, xdrres, resp, tout, port_ptr)
  58  *              (works for udp only.)
  59  *      clnt_stat = clnt_broadcast(program, version, procedure,
  60  *              xdrargs, argsp, xdrres, resp, eachresult)
  61  *              (like pmap_rmtcall, except the call is broadcasted to all
  62  *              locally connected nets.  For each valid response received,
  63  *              the procedure eachresult is called.  Its form is:
  64  *      done = eachresult(resp, raddr)
  65  *              bool_t done;
  66  *              caddr_t resp;
  67  *              struct sockaddr_in raddr;
  68  *              where resp points to the results of the call and raddr is the
  69  *              address if the responder to the broadcast.
  70  */
  71
  72 extern bool_t pmap_set (__const u_long __program, __const u_long __vers,
  73                         int __protocol, u_short __port) __THROW;
  74 extern bool_t pmap_unset (__const u_long __program, __const u_long __vers)
  75      __THROW;
  76 extern struct pmaplist *pmap_getmaps (struct sockaddr_in *__address) __THROW;
  77 extern enum clnt_stat pmap_rmtcall (struct sockaddr_in *__addr,
  78                                     __const u_long __prog,
  79                                     __const u_long __vers,
  80                                     __const u_long __proc,
  81                                     xdrproc_t __xdrargs,
  82                                     caddr_t __argsp, xdrproc_t __xdrres,
  83                                     caddr_t __resp, struct timeval __tout,
  84                                     u_long *__port_ptr) __THROW;
  85 extern enum clnt_stat clnt_broadcast (__const u_long __prog,
  86                                       __const u_long __vers,
  87                                       __const u_long __proc, xdrproc_t __xargs,
  88                                       caddr_t __argsp, xdrproc_t __xresults,
  89                                       caddr_t __resultsp,
  90                                       resultproc_t __eachresult) __THROW;
  91 extern u_short pmap_getport (struct sockaddr_in *__address,
  92                              __const u_long __program,
  93                              __const u_long __version, u_int __protocol)
  94      __THROW;
  95
  96 __END_DECLS
  97
  98 #endif /* rpc/pmap_clnt.h */