ldd.1, capget.2, clone.2, create_module.2, fallocate.2, futex.2, get_kernel_syms.2, get_thread_area.2, getcpu.2, getitimer.2, getpid.2, io_cancel.2, io_destroy.2, io_getevents.2, io_setup.2, io_submit.2, ioctl_list.2, mkdir.2, mknod.2, pciconfig_read.2, pivot_root.2, posix_fadvise.2, query_module.2, sendfile.2, set_thread_area.2, setns.2, unshare.2, __setfpucw.3, a64l.3, addseverity.3, argz_add.3, bindresvport.3, cabs.3, cacos.3, cacosh.3, canonicalize_file_name.3, carg.3, casin.3, casinh.3, catan.3, catanh.3, ccos.3, ccosh.3, cerf.3, cexp.3, cexp2.3, cimag.3, clog.3, clog10.3, clog2.3, cmsg.3, conj.3, cpow.3, cproj.3, creal.3, csin.3, csinh.3, csqrt.3, ctan.3, ctanh.3, des_crypt.3, envz_add.3, fdim.3, fma.3, fmax.3, fmemopen.3, fmin.3, fmtmsg.3, fpclassify.3, gamma.3, getpt.3, getrpcent.3, getrpcport.3, getttyent.3, isgreater.3, key_setsecret.3, lgamma.3, malloc_hook.3, mempcpy.3, nan.3, netlink.3, nextafter.3, putgrent.3, remove.3, remquo.3, rpc.3, rtime.3, rtnetlink.3, setaliasent.3, setnetgrent.3, signbit.3, significand.3, sincos.3, stdin.3, tgamma.3, xcrypt.3, xdr.3, cciss.4, hpsa.4, mouse.4, pts.4, sk98lin.4, tty_ioctl.4, wavelan.4, hosts.equiv.5, rpc.5, tzfile.5, boot.7, complex.7, ddp.7, fifo.7, futex.7, icmp.7, ip.7, ipv6.7, netdevice.7, netlink.7, packet.7, raw.7, rtnetlink.7, socket.7, tcp.7, udp.7, unix.7, x25.7, sync.8: Global fix: Put copyright info at top of page, followed by blank line and LICENSE
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-03-10 09:29:51 +00:00
|
|
|
.\" This page was taken from the 4.4BSD-Lite CDROM (BSD license)
|
|
|
|
.\"
|
2013-03-10 09:29:13 +00:00
|
|
|
.\" %%%LICENSE_START(BSD_ONELINE_CDROM)
|
2006-05-31 22:43:24 +00:00
|
|
|
.\" This page was taken from the 4.4BSD-Lite CDROM (BSD license)
|
epoll_create.2, epoll_ctl.2, epoll_wait.2, eventfd.2, fallocate.2, futex.2, getcpu.2, getitimer.2, ioctl_list.2, ioprio_set.2, migrate_pages.2, move_pages.2, pciconfig_read.2, sendfile.2, setns.2, signalfd.2, spu_create.2, spu_run.2, sysinfo.2, timerfd_create.2, backtrace.3, cmsg.3, error.3, getpt.3, getrpcent.3, getrpcport.3, getsubopt.3, offsetof.3, program_invocation_name.3, rpc.3, rpmatch.3, rtnetlink.3, xdr.3, cciss.4, hpsa.4, pts.4, charmap.5, dir_colors.5, elf.5, gai.conf.5, locale.5, nscd.conf.5, nss.5, resolv.conf.5, rpc.5, arp.7, cpuset.7, ddp.7, epoll.7, fifo.7, futex.7, icmp.7, ip.7, ipv6.7, mailaddr.7, netdevice.7, packet.7, raw.7, regex.7, rtnetlink.7, socket.7, spufs.7, tcp.7, udp.7, unix.7, x25.7, ldconfig.8, nscd.8: Global fix: s/END_LICENSE/LICENSE_END/
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-03-12 09:26:07 +00:00
|
|
|
.\" %%%LICENSE_END
|
2006-05-31 22:43:24 +00:00
|
|
|
.\"
|
2004-11-03 13:51:07 +00:00
|
|
|
.\" @(#)rpc.3n 2.4 88/08/08 4.0 RPCSRC; from 1.19 88/06/24 SMI
|
2007-12-07 19:41:16 +00:00
|
|
|
.\"
|
2007-12-30 15:55:22 +00:00
|
|
|
.\" 2007-12-30, mtk, Convert function prototypes to modern C syntax
|
2007-12-07 19:41:16 +00:00
|
|
|
.\"
|
2013-09-26 13:06:36 +00:00
|
|
|
.TH RPC 3 2013-09-26 "" "Linux Programmer's Manual"
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH NAME
|
|
|
|
rpc \- library routines for remote procedure calls
|
getent.1, intro.1, time.1, _exit.2, _syscall.2, accept.2, access.2, acct.2, adjtimex.2, alarm.2, alloc_hugepages.2, arch_prctl.2, bdflush.2, bind.2, brk.2, cacheflush.2, capget.2, chdir.2, chmod.2, chown.2, chroot.2, clock_getres.2, clock_nanosleep.2, clone.2, close.2, connect.2, create_module.2, delete_module.2, dup.2, epoll_create.2, epoll_ctl.2, epoll_wait.2, eventfd.2, execve.2, exit_group.2, faccessat.2, fchmodat.2, fchownat.2, fcntl.2, flock.2, fork.2, fstatat.2, fsync.2, futex.2, futimesat.2, get_kernel_syms.2, get_robust_list.2, get_thread_area.2, getcpu.2, getdents.2, getdomainname.2, getgid.2, getgroups.2, gethostname.2, getitimer.2, getpagesize.2, getpeername.2, getpid.2, getpriority.2, getresuid.2, getrlimit.2, getrusage.2, getsid.2, getsockname.2, getsockopt.2, gettid.2, gettimeofday.2, getuid.2, getunwind.2, getxattr.2, idle.2, init_module.2, inotify_add_watch.2, inotify_init.2, inotify_rm_watch.2, intro.2, io_cancel.2, io_destroy.2, io_getevents.2, io_setup.2, io_submit.2, ioctl.2, ioctl_list.2, ioperm.2, iopl.2, ioprio_set.2, ipc.2, kcmp.2, kill.2, killpg.2, link.2, linkat.2, listen.2, listxattr.2, llseek.2, lookup_dcookie.2, lseek.2, madvise.2, migrate_pages.2, mincore.2, mkdir.2, mkdirat.2, mknod.2, mknodat.2, mlock.2, mmap.2, mmap2.2, modify_ldt.2, mount.2, move_pages.2, mprotect.2, mq_getsetattr.2, mremap.2, msgctl.2, msgget.2, msgop.2, msync.2, nanosleep.2, nfsservctl.2, nice.2, open.2, openat.2, outb.2, pause.2, pciconfig_read.2, perf_event_open.2, perfmonctl.2, personality.2, pipe.2, pivot_root.2, poll.2, posix_fadvise.2, prctl.2, pread.2, process_vm_readv.2, ptrace.2, query_module.2, quotactl.2, read.2, readahead.2, readdir.2, readlink.2, readlinkat.2, readv.2, reboot.2, recv.2, remap_file_pages.2, removexattr.2, rename.2, renameat.2, rmdir.2, rt_sigqueueinfo.2, sched_get_priority_max.2, sched_rr_get_interval.2, sched_setaffinity.2, sched_setparam.2, sched_setscheduler.2, sched_yield.2, select.2, semctl.2, semget.2, semop.2, send.2, sendfile.2, set_thread_area.2, set_tid_address.2, seteuid.2, setfsgid.2, setfsuid.2, setgid.2, setpgid.2, setresuid.2, setreuid.2, setsid.2, setuid.2, setup.2, setxattr.2, shmctl.2, shmget.2, shmop.2, shutdown.2, sigaction.2, sigaltstack.2, signal.2, signalfd.2, sigpending.2, sigprocmask.2, sigreturn.2, sigsuspend.2, sigwaitinfo.2, socket.2, socketcall.2, socketpair.2, splice.2, stat.2, statfs.2, stime.2, swapon.2, symlink.2, symlinkat.2, sync.2, sync_file_range.2, sysctl.2, sysfs.2, sysinfo.2, syslog.2, tee.2, time.2, timerfd_create.2, times.2, tkill.2, truncate.2, umask.2, umount.2, uname.2, unimplemented.2, unlink.2, unlinkat.2, uselib.2, ustat.2, utime.2, utimensat.2, vfork.2, vhangup.2, vm86.2, vmsplice.2, wait.2, wait4.2, write.2, CPU_SET.3, INFINITY.3, MB_CUR_MAX.3, MB_LEN_MAX.3, __setfpucw.3, a64l.3, abort.3, abs.3, acos.3, acosh.3, addseverity.3, adjtime.3, aio_cancel.3, aio_error.3, aio_fsync.3, aio_read.3, aio_return.3, aio_suspend.3, aio_write.3, alloca.3, argz_add.3, asin.3, asinh.3, asprintf.3, assert.3, assert_perror.3, atan.3, atan2.3, atanh.3, atexit.3, atof.3, atoi.3, backtrace.3, basename.3, bcmp.3, bcopy.3, bindresvport.3, bsd_signal.3, bsearch.3, bstring.3, btowc.3, btree.3, byteorder.3, bzero.3, cabs.3, cacos.3, cacosh.3, canonicalize_file_name.3, carg.3, casin.3, casinh.3, catan.3, catanh.3, catgets.3, catopen.3, cbrt.3, ccos.3, ccosh.3, ceil.3, cerf.3, cexp.3, cexp2.3, cfree.3, cimag.3, clearenv.3, clock.3, clock_getcpuclockid.3, clog.3, clog10.3, clog2.3, closedir.3, cmsg.3, confstr.3, conj.3, copysign.3, cos.3, cosh.3, cpow.3, cproj.3, creal.3, crypt.3, csin.3, csinh.3, csqrt.3, ctan.3, ctanh.3, ctermid.3, ctime.3, daemon.3, dbopen.3, des_crypt.3, difftime.3, dirfd.3, div.3, dl_iterate_phdr.3, dlopen.3, dprintf.3, drand48.3, drand48_r.3, dysize.3, ecvt.3, ecvt_r.3, encrypt.3, end.3, endian.3, envz_add.3, erf.3, erfc.3, err.3, errno.3, error.3, ether_aton.3, euidaccess.3, exec.3, exit.3, exp.3, exp10.3, exp2.3, expm1.3, fabs.3, fclose.3, fcloseall.3, fdim.3, fenv.3, ferror.3, fexecve.3, fflush.3, ffs.3, fgetgrent.3, fgetpwent.3, fgetwc.3, fgetws.3, finite.3, flockfile.3, floor.3, fma.3, fmax.3, fmemopen.3, fmin.3, fmod.3, fmtmsg.3, fnmatch.3, fopen.3, fpathconf.3, fpclassify.3, fpurge.3, fputwc.3, fputws.3, fread.3, frexp.3, fseek.3, fseeko.3, ftime.3, ftok.3, fts.3, ftw.3, futimes.3, fwide.3, gamma.3, gcvt.3, getaddrinfo.3, getaddrinfo_a.3, getauxval.3, getcontext.3, getcwd.3, getdate.3, getdirentries.3, getdtablesize.3, getenv.3, getfsent.3, getgrent.3, getgrent_r.3, getgrnam.3, getgrouplist.3, gethostbyname.3, gethostid.3, getipnodebyname.3, getline.3, getloadavg.3, getlogin.3, getmntent.3, getnameinfo.3, getnetent.3, getnetent_r.3, getopt.3, getpass.3, getprotoent.3, getprotoent_r.3, getpt.3, getpw.3, getpwent.3, getpwent_r.3, getpwnam.3, getrpcent.3, getrpcent_r.3, getrpcport.3, gets.3, getservent.3, getservent_r.3, getspnam.3, getttyent.3, getumask.3, getusershell.3, getutent.3, getw.3, getwchar.3, glob.3, grantpt.3, gsignal.3, hash.3, hsearch.3, hypot.3, iconv.3, iconv_close.3, iconv_open.3, ilogb.3, index.3, inet.3, inet_ntop.3, inet_pton.3, infnan.3, initgroups.3, insque.3, intro.3, isalpha.3, isatty.3, isgreater.3, iswalnum.3, iswalpha.3, iswblank.3, iswcntrl.3, iswctype.3, iswdigit.3, iswgraph.3, iswlower.3, iswprint.3, iswpunct.3, iswspace.3, iswupper.3, iswxdigit.3, j0.3, key_setsecret.3, ldexp.3, lgamma.3, lio_listio.3, localeconv.3, lockf.3, log.3, log10.3, log1p.3, log2.3, logb.3, login.3, longjmp.3, lrint.3, lround.3, lsearch.3, lseek64.3, makecontext.3, makedev.3, malloc.3, malloc_hook.3, mblen.3, mbrlen.3, mbrtowc.3, mbsinit.3, mbsnrtowcs.3, mbsrtowcs.3, mbstowcs.3, mbtowc.3, memccpy.3, memchr.3, memcmp.3, memcpy.3, memfrob.3, memmem.3, memmove.3, mempcpy.3, memset.3, mkdtemp.3, mkfifo.3, mkfifoat.3, mkstemp.3, mktemp.3, modf.3, mpool.3, mq_close.3, mq_getattr.3, mq_notify.3, mq_open.3, mq_receive.3, mq_send.3, mq_unlink.3, mtrace.3, nan.3, netlink.3, nextafter.3, nl_langinfo.3, offsetof.3, on_exit.3, opendir.3, openpty.3, perror.3, popen.3, posix_fallocate.3, posix_memalign.3, posix_openpt.3, pow.3, pow10.3, printf.3, profil.3, program_invocation_name.3, psignal.3, pthread_kill_other_threads_np.3, ptsname.3, putenv.3, putgrent.3, putpwent.3, puts.3, putwchar.3, qecvt.3, qsort.3, queue.3, raise.3, rand.3, random.3, random_r.3, rcmd.3, re_comp.3, readdir.3, realpath.3, recno.3, regex.3, remainder.3, remove.3, remquo.3, resolver.3, rewinddir.3, rexec.3, rint.3, round.3, rpc.3, rpmatch.3, rtime.3, rtnetlink.3, scalb.3, scalbln.3, scandir.3, scandirat.3, scanf.3, seekdir.3, sem_close.3, sem_destroy.3, sem_getvalue.3, sem_init.3, sem_open.3, sem_post.3, sem_unlink.3, sem_wait.3, setaliasent.3, setbuf.3, setenv.3, setjmp.3, setlocale.3, setlogmask.3, setnetgrent.3, shm_open.3, siginterrupt.3, signbit.3, significand.3, sigpause.3, sigqueue.3, sigset.3, sigsetops.3, sigvec.3, sin.3, sincos.3, sinh.3, sleep.3, sockatmark.3, sqrt.3, statvfs.3, stdarg.3, stdin.3, stdio.3, stdio_ext.3, stpcpy.3, stpncpy.3, strcasecmp.3, strcat.3, strchr.3, strcmp.3, strcoll.3, strcpy.3, strdup.3, strerror.3, strfmon.3, strfry.3, strftime.3, string.3, strlen.3, strnlen.3, strpbrk.3, strptime.3, strsep.3, strsignal.3, strspn.3, strstr.3, strtod.3, strtoimax.3, strtok.3, strtol.3, strtoul.3, strverscmp.3, strxfrm.3, swab.3, sysconf.3, syslog.3, system.3, sysv_signal.3, tan.3, tanh.3, tcgetpgrp.3, tcgetsid.3, telldir.3, tempnam.3, termios.3, tgamma.3, timegm.3, timeradd.3, tmpfile.3, tmpnam.3, toascii.3, toupper.3, towctrans.3, towlower.3, towupper.3, trunc.3, tsearch.3, ttyname.3, ttyslot.3, tzset.3, ualarm.3, ulimit.3, ungetwc.3, unlocked_stdio.3, unlockpt.3, updwtmp.3, usleep.3, wcpcpy.3, wcpncpy.3, wcrtomb.3, wcscasecmp.3, wcscat.3, wcschr.3, wcscmp.3, wcscpy.3, wcscspn.3, wcsdup.3, wcslen.3, wcsncasecmp.3, wcsncat.3, wcsncmp.3, wcsncpy.3, wcsnlen.3, wcsnrtombs.3, wcspbrk.3, wcsrchr.3, wcsrtombs.3, wcsspn.3, wcsstr.3, wcstoimax.3, wcstok.3, wcstombs.3, wcswidth.3, wctob.3, wctomb.3, wctrans.3, wctype.3, wcwidth.3, wmemchr.3, wmemcmp.3, wmemcpy.3, wmemmove.3, wmemset.3, wordexp.3, wprintf.3, xcrypt.3, xdr.3, y0.3, cciss.4, console.4, console_codes.4, console_ioctl.4, dsp56k.4, fd.4, full.4, hd.4, hpsa.4, initrd.4, intro.4, lp.4, mem.4, mouse.4, null.4, pts.4, ram.4, random.4, rtc.4, sk98lin.4, st.4, tty.4, ttyS.4, tty_ioctl.4, vcs.4, wavelan.4, acct.5, charmap.5, dir_colors.5, filesystems.5, ftpusers.5, group.5, host.conf.5, hosts.5, hosts.equiv.5, intro.5, issue.5, locale.5, motd.5, networks.5, nologin.5, nscd.conf.5, passwd.5, proc.5, protocols.5, resolv.conf.5, rpc.5, securetty.5, services.5, shells.5, termcap.5, ttytype.5, utmp.5, armscii-8.7, arp.7, ascii.7, bootparam.7, capabilities.7, charsets.7, complex.7, cp1251.7, credentials.7, ddp.7, environ.7, epoll.7, fifo.7, futex.7, glob.7, hier.7, icmp.7, inotify.7, intro.7, ip.7, ipv6.7, iso_8859-1.7, iso_8859-10.7, iso_8859-11.7, iso_8859-13.7, iso_8859-14.7, iso_8859-15.7, iso_8859-16.7, iso_8859-2.7, iso_8859-3.7, iso_8859-4.7, iso_8859-5.7, iso_8859-6.7, iso_8859-7.7, iso_8859-8.7, iso_8859-9.7, koi8-r.7, koi8-u.7, locale.7, mailaddr.7, man.7, mq_overview.7, netdevice.7, netlink.7, numa.7, packet.7, path_resolution.7, pipe.7, posixoptions.7, pthreads.7, pty.7, raw.7, regex.7, rtld-audit.7, rtnetlink.7, sem_overview.7, shm_overview.7, sigevent.7, signal.7, socket.7, standards.7, suffixes.7, svipc.7, tcp.7, termio.7, time.7, udp.7, udplite.7, unicode.7, unix.7, uri.7, utf-8.7, x25.7, nscd.8, sync.8, tzselect.8, zdump.8, zic.8: Global fix: remove unneeded double quotes in .SH headings
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-02-24 18:01:36 +00:00
|
|
|
.SH SYNOPSIS AND DESCRIPTION
|
2004-11-03 13:51:07 +00:00
|
|
|
These routines allow C programs to make procedure
|
|
|
|
calls on other machines across the network.
|
2007-12-30 15:55:22 +00:00
|
|
|
First, the client calls a procedure to send a data packet to the server.
|
2004-11-03 13:51:07 +00:00
|
|
|
Upon receipt of the packet, the server calls a dispatch routine
|
2007-12-30 15:55:22 +00:00
|
|
|
to perform the requested service, and then sends back a reply.
|
2004-11-03 13:51:07 +00:00
|
|
|
Finally, the procedure call returns to the client.
|
2005-09-19 11:39:32 +00:00
|
|
|
.\" .LP
|
2007-12-30 15:55:22 +00:00
|
|
|
.\" We don't have an rpc_secure.3 page at the moment -- MTK, 19 Sep 05
|
2005-09-19 11:39:32 +00:00
|
|
|
.\" Routines that are used for Secure RPC (DES authentication) are described in
|
|
|
|
.\" .BR rpc_secure (3).
|
|
|
|
.\" Secure RPC can be used only if DES encryption is available.
|
2004-11-03 13:51:07 +00:00
|
|
|
.LP
|
2007-12-30 15:55:22 +00:00
|
|
|
To take use of these routines, include the header file
|
|
|
|
.IR "<rpc/rpc.h>" .
|
2008-01-12 08:26:19 +00:00
|
|
|
|
2007-12-30 15:55:22 +00:00
|
|
|
The prototypes below make use of the following types:
|
|
|
|
.in +4n
|
2008-01-12 08:26:19 +00:00
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
|
2013-06-05 14:14:24 +00:00
|
|
|
.BI "typedef int " bool_t ;
|
2007-12-30 15:55:22 +00:00
|
|
|
|
2013-06-05 14:14:24 +00:00
|
|
|
.BI "typedef bool_t (*" xdrproc_t ") (XDR *, void *, ...);"
|
2007-12-30 15:55:22 +00:00
|
|
|
|
2013-06-05 14:14:24 +00:00
|
|
|
.BI "typedef bool_t (*" resultproc_t ") (caddr_t " resp ,
|
|
|
|
.BI " struct sockaddr_in *" raddr );
|
2007-12-30 15:55:22 +00:00
|
|
|
.fi
|
2008-01-12 08:26:19 +00:00
|
|
|
.in
|
2007-12-30 15:55:22 +00:00
|
|
|
.LP
|
|
|
|
See the header files for the declarations of the
|
|
|
|
.IR AUTH ,
|
|
|
|
.IR CLIENT ,
|
|
|
|
.IR SVCXPRT ,
|
|
|
|
and
|
|
|
|
.IR XDR
|
|
|
|
types.
|
2004-11-03 13:51:07 +00:00
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "void auth_destroy(AUTH *" auth );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
|
|
|
A macro that destroys the authentication information associated with
|
|
|
|
.IR auth .
|
2007-12-30 15:55:22 +00:00
|
|
|
Destruction usually involves deallocation of private data structures.
|
2007-04-12 22:42:49 +00:00
|
|
|
The use of
|
2004-11-03 13:51:07 +00:00
|
|
|
.I auth
|
|
|
|
is undefined after calling
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR auth_destroy ().
|
2004-11-03 13:51:07 +00:00
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "AUTH *authnone_create(void);"
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
2007-12-30 15:55:22 +00:00
|
|
|
Create and return an RPC
|
accept.2, access.2, acct.2, clock_nanosleep.2, mbind.2, mincore.2, remap_file_pages.2, sched_setscheduler.2, set_mempolicy.2, splice.2, stat.2, syslog.2, timer_create.2, timerfd_create.2, truncate.2, fenv.3, ferror.3, fflush.3, fgetwc.3, fgetws.3, flockfile.3, fputwc.3, fputws.3, fread.3, getopt.3, gets.3, getwchar.3, glob.3, iconv.3, longjmp.3, pow.3, printf.3, puts.3, putwchar.3, regex.3, rpc.3, scanf.3, setjmp.3, termios.3, unlocked_stdio.3, wcswidth.3, hd.4, rtc.4, st.4, core.5, dir_colors.5, elf.5, proc.5, arp.7, ascii.7, boot.7, bootparam.7, charsets.7, futex.7, ip.7, iso_8859-11.7, man-pages.7, man.7, mdoc.samples.7, path_resolution.7, pipe.7, posixoptions.7, unicode.7, unix.7, uri.7, utf-8.7, ld.so.8: s/non-/non/
The tendency in English, as prescribed in style guides like
Chicago MoS, is towards removing hyphens after prefixes
like "non-" etc.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-01-16 17:20:12 +00:00
|
|
|
authentication handle that passes nonusable authentication
|
2007-04-12 22:42:49 +00:00
|
|
|
information with each remote procedure call.
|
2007-12-30 15:55:22 +00:00
|
|
|
This is the default authentication used by RPC.
|
2004-11-03 13:51:07 +00:00
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "AUTH *authunix_create(char *" host ", int " uid ", int " gid ,
|
|
|
|
.BI " int " len ", int *" aup_gids );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
2007-12-30 15:55:22 +00:00
|
|
|
Create and return an RPC authentication handle that contains
|
2004-11-03 13:51:07 +00:00
|
|
|
authentication information.
|
|
|
|
The parameter
|
|
|
|
.I host
|
2007-12-30 15:55:22 +00:00
|
|
|
is the name of the machine on which the information was created;
|
2004-11-03 13:51:07 +00:00
|
|
|
.I uid
|
2007-12-30 15:55:22 +00:00
|
|
|
is the user's user ID;
|
2004-11-03 13:51:07 +00:00
|
|
|
.I gid
|
2007-12-30 15:55:22 +00:00
|
|
|
is the user's current group ID;
|
2004-11-03 13:51:07 +00:00
|
|
|
.I len
|
|
|
|
and
|
|
|
|
.I aup_gids
|
|
|
|
refer to a counted array of groups to which the user belongs.
|
|
|
|
It is easy to impersonate a user.
|
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "AUTH *authunix_create_default(void);"
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
|
|
|
Calls
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR authunix_create ()
|
2004-11-03 13:51:07 +00:00
|
|
|
with the appropriate parameters.
|
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 16:01:21 +00:00
|
|
|
.BI "int callrpc(char *" host ", unsigned long " prognum ,
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI " unsigned long " versnum ", unsigned long " procnum ,
|
2008-07-17 13:33:33 +00:00
|
|
|
.BI " xdrproc_t " inproc ", char *" in ,
|
|
|
|
.BI " xdrproc_t " outproc ", char *" out );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
|
|
|
Call the remote procedure associated with
|
|
|
|
.IR prognum ,
|
|
|
|
.IR versnum ,
|
|
|
|
and
|
|
|
|
.I procnum
|
|
|
|
on the machine,
|
|
|
|
.IR host .
|
|
|
|
The parameter
|
|
|
|
.I in
|
|
|
|
is the address of the procedure's argument(s), and
|
|
|
|
.I out
|
|
|
|
is the address of where to place the result(s);
|
|
|
|
.I inproc
|
|
|
|
is used to encode the procedure's parameters, and
|
|
|
|
.I outproc
|
|
|
|
is used to decode the procedure's results.
|
|
|
|
This routine returns zero if it succeeds, or the value of
|
|
|
|
.B "enum clnt_stat"
|
|
|
|
cast to an integer if it fails.
|
|
|
|
The routine
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR clnt_perrno ()
|
2004-11-03 13:51:07 +00:00
|
|
|
is handy for translating failure statuses into messages.
|
|
|
|
.IP
|
|
|
|
Warning: calling remote procedures with this routine
|
2007-12-30 15:55:22 +00:00
|
|
|
uses UDP/IP as a transport; see
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR clntudp_create ()
|
2004-11-03 13:51:07 +00:00
|
|
|
for restrictions.
|
2007-12-30 15:55:22 +00:00
|
|
|
You do not have control of timeouts or authentication using this routine.
|
2004-11-03 13:51:07 +00:00
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "enum clnt_stat clnt_broadcast(unsigned long " prognum ,
|
|
|
|
.BI " unsigned long " versnum ", unsigned long " procnum ,
|
2008-07-17 13:33:33 +00:00
|
|
|
.BI " xdrproc_t " inproc ", char *" in ,
|
|
|
|
.BI " xdrproc_t " outproc ", char *" out ,
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI " resultproc_t " eachresult );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
|
|
|
Like
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR callrpc (),
|
2004-11-03 13:51:07 +00:00
|
|
|
except the call message is broadcast to all locally
|
2007-04-12 22:42:49 +00:00
|
|
|
connected broadcast nets.
|
2007-12-30 15:55:22 +00:00
|
|
|
Each time it receives a response, this routine calls
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR eachresult (),
|
2004-11-03 13:51:07 +00:00
|
|
|
whose form is:
|
|
|
|
.IP
|
2007-12-30 15:55:22 +00:00
|
|
|
.in +4n
|
2004-11-03 13:51:07 +00:00
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "eachresult(char *" out ", struct sockaddr_in *" addr );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
2007-12-30 15:55:22 +00:00
|
|
|
.in
|
2004-11-03 13:51:07 +00:00
|
|
|
.IP
|
|
|
|
where
|
|
|
|
.I out
|
|
|
|
is the same as
|
|
|
|
.I out
|
|
|
|
passed to
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR clnt_broadcast (),
|
2004-11-03 13:51:07 +00:00
|
|
|
except that the remote procedure's output is decoded there;
|
|
|
|
.I addr
|
|
|
|
points to the address of the machine that sent the results.
|
|
|
|
If
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR eachresult ()
|
2004-11-03 13:51:07 +00:00
|
|
|
returns zero,
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR clnt_broadcast ()
|
2007-12-30 15:55:22 +00:00
|
|
|
waits for more replies; otherwise it returns with appropriate status.
|
2004-11-03 13:51:07 +00:00
|
|
|
.IP
|
|
|
|
Warning: broadcast sockets are limited in size to the
|
2007-04-12 22:42:49 +00:00
|
|
|
maximum transfer unit of the data link.
|
2007-12-30 15:55:22 +00:00
|
|
|
For ethernet, this value is 1500 bytes.
|
2004-11-03 13:51:07 +00:00
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "enum clnt_stat clnt_call(CLIENT *" clnt ", unsigned long " procnum ,
|
2008-07-17 13:33:33 +00:00
|
|
|
.BI " xdrproc_t " inproc ", char *" in ,
|
|
|
|
.BI " xdrproc_t " outproc ", char *" out ,
|
|
|
|
.BI " struct timeval " tout );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
|
|
|
A macro that calls the remote procedure
|
|
|
|
.I procnum
|
|
|
|
associated with the client handle,
|
|
|
|
.IR clnt ,
|
2007-12-30 15:55:22 +00:00
|
|
|
which is obtained with an RPC client creation routine such as
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR clnt_create ().
|
2004-11-03 13:51:07 +00:00
|
|
|
The parameter
|
|
|
|
.I in
|
|
|
|
is the address of the procedure's argument(s), and
|
|
|
|
.I out
|
|
|
|
is the address of where to place the result(s);
|
|
|
|
.I inproc
|
|
|
|
is used to encode the procedure's parameters, and
|
|
|
|
.I outproc
|
|
|
|
is used to decode the procedure's results;
|
|
|
|
.I tout
|
|
|
|
is the time allowed for results to come back.
|
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "clnt_destroy(CLIENT *" clnt );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
2007-12-30 15:55:22 +00:00
|
|
|
A macro that destroys the client's RPC handle.
|
2007-04-12 22:42:49 +00:00
|
|
|
Destruction usually involves deallocation
|
2004-11-03 13:51:07 +00:00
|
|
|
of private data structures, including
|
|
|
|
.I clnt
|
2007-04-12 22:42:49 +00:00
|
|
|
itself.
|
|
|
|
Use of
|
2004-11-03 13:51:07 +00:00
|
|
|
.I clnt
|
|
|
|
is undefined after calling
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR clnt_destroy ().
|
2007-12-30 15:55:22 +00:00
|
|
|
If the RPC library opened the associated socket, it will close it also.
|
2004-11-03 13:51:07 +00:00
|
|
|
Otherwise, the socket remains open.
|
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "CLIENT *clnt_create(char *" host ", unsigned long " prog ,
|
|
|
|
.BI " unsigned long " vers ", char *" proto );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
|
|
|
Generic client creation routine.
|
|
|
|
.I host
|
2007-12-30 15:55:22 +00:00
|
|
|
identifies the name of the remote host where the server is located.
|
2004-11-03 13:51:07 +00:00
|
|
|
.I proto
|
2007-04-12 22:42:49 +00:00
|
|
|
indicates which kind of transport protocol to use.
|
|
|
|
The currently supported values for this field are \(lqudp\(rq
|
2004-11-03 13:51:07 +00:00
|
|
|
and \(lqtcp\(rq.
|
|
|
|
Default timeouts are set, but can be modified using
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR clnt_control ().
|
2004-11-03 13:51:07 +00:00
|
|
|
.IP
|
2007-12-30 15:55:22 +00:00
|
|
|
Warning: Using UDP has its shortcomings.
|
intro.1, _syscall.2, access.2, arch_prctl.2, cacheflush.2, chown.2, clock_getres.2, clone.2, create_module.2, fcntl.2, flock.2, get_kernel_syms.2, get_robust_list.2, get_thread_area.2, getcpu.2, getpriority.2, getrlimit.2, getrusage.2, ioprio_set.2, kexec_load.2, madvise.2, mbind.2, migrate_pages.2, mknod.2, mmap.2, mount.2, move_pages.2, mprotect.2, open.2, pause.2, pciconfig_read.2, perf_event_open.2, prctl.2, ptrace.2, query_module.2, read.2, reboot.2, recv.2, s390_runtime_instr.2, sched_setscheduler.2, select_tut.2, send.2, set_mempolicy.2, setfsgid.2, setfsuid.2, sigaction.2, spu_create.2, spu_run.2, stime.2, swapon.2, syslog.2, timer_create.2, timer_getoverrun.2, times.2, tkill.2, umount.2, unimplemented.2, ustat.2, vm86.2, wait.2, abs.3, aio_read.3, aio_write.3, bsd_signal.3, catgets.3, clearenv.3, cmsg.3, dbopen.3, dirfd.3, dlopen.3, exec.3, fenv.3, ferror.3, fmemopen.3, fnmatch.3, fopen.3, futimes.3, getaddrinfo.3, getifaddrs.3, getipnodebyname.3, hsearch.3, if_nameindex.3, inet_pton.3, mblen.3, mbrlen.3, mbsrtowcs.3, mbtowc.3, mcheck.3, memfrob.3, mq_notify.3, netlink.3, posix_memalign.3, printf.3, pthread_attr_setscope.3, pthread_cleanup_push.3, pthread_kill_other_threads_np.3, pthread_self.3, pthread_setcancelstate.3, pthread_setconcurrency.3, raise.3, resolver.3, rpc.3, rtime.3, rtnetlink.3, scanf.3, setbuf.3, setnetgrent.3, shm_open.3, sigpause.3, sigset.3, sigwait.3, sockatmark.3, strcasecmp.3, strcmp.3, strdup.3, strftime.3, strptime.3, strsignal.3, strverscmp.3, sysv_signal.3, termios.3, wcrtomb.3, wcsnlen.3, wcsnrtombs.3, wcsrtombs.3, wctomb.3, wprintf.3, console_codes.4, cpuid.4, msr.4, rtc.4, sk98lin.4, st.4, tty.4, charmap.5, core.5, elf.5, hosts.equiv.5, proc.5, resolv.conf.5, services.5, slabinfo.5, arp.7, bootparam.7, capabilities.7, charsets.7, cpuset.7, ddp.7, epoll.7, feature_test_macros.7, futex.7, hier.7, icmp.7, inotify.7, ip.7, ipv6.7, man-pages.7, mdoc.7, mdoc.samples.7, netdevice.7, netlink.7, numa.7, packet.7, path_resolution.7, posixoptions.7, pthreads.7, raw.7, rtld-audit.7, rtnetlink.7, sem_overview.7, sigevent.7, socket.7, spufs.7, tcp.7, udp.7, unicode.7, uri.7, utf-8.7, intro.8, ldconfig.8, sync.8: Global fix: fix placement of word "only"
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-03-31 08:53:00 +00:00
|
|
|
Since UDP-based RPC messages can hold only up to 8 Kbytes of encoded data,
|
2004-11-03 13:51:07 +00:00
|
|
|
this transport cannot be used for procedures that take
|
|
|
|
large arguments or return huge results.
|
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "bool_t clnt_control(CLIENT *" cl ", int " req ", char *" info );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
|
|
|
A macro used to change or retrieve various information
|
|
|
|
about a client object.
|
|
|
|
.I req
|
|
|
|
indicates the type of operation, and
|
|
|
|
.I info
|
2007-04-12 22:42:49 +00:00
|
|
|
is a pointer to the information.
|
2007-12-30 15:55:22 +00:00
|
|
|
For both UDP and TCP, the supported values of
|
2004-11-03 13:51:07 +00:00
|
|
|
.I req
|
|
|
|
and their argument types and what they do are:
|
|
|
|
.IP
|
2007-12-30 05:48:25 +00:00
|
|
|
.in +4n
|
2004-11-03 13:51:07 +00:00
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
\fBCLSET_TIMEOUT\fP \fIstruct timeval\fP // set total timeout
|
|
|
|
\fBCLGET_TIMEOUT\fP \fIstruct timeval\fP // get total timeout
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
2007-12-30 05:48:25 +00:00
|
|
|
.in
|
2004-11-03 13:51:07 +00:00
|
|
|
.IP
|
|
|
|
Note: if you set the timeout using
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR clnt_control (),
|
2004-11-03 13:51:07 +00:00
|
|
|
the timeout parameter passed to
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR clnt_call ()
|
2004-11-03 13:51:07 +00:00
|
|
|
will be ignored in all future calls.
|
|
|
|
.IP
|
2007-12-30 05:48:25 +00:00
|
|
|
.in +4n
|
2004-11-03 13:51:07 +00:00
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
\fBCLGET_SERVER_ADDR\fP \fIstruct sockaddr_in \fP // get server's address
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
2007-12-30 05:48:25 +00:00
|
|
|
.in
|
2004-11-03 13:51:07 +00:00
|
|
|
.IP
|
2007-12-30 15:55:22 +00:00
|
|
|
The following operations are valid for UDP only:
|
2004-11-03 13:51:07 +00:00
|
|
|
.IP
|
2007-12-30 05:48:25 +00:00
|
|
|
.in +4n
|
2004-11-03 13:51:07 +00:00
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
\fBCLSET_RETRY_TIMEOUT\fP \fIstruct timeval\fP // set the retry timeout
|
|
|
|
\fBCLGET_RETRY_TIMEOUT\fP \fIstruct timeval\fP // get the retry timeout
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
2007-12-30 05:48:25 +00:00
|
|
|
.in
|
2004-11-03 13:51:07 +00:00
|
|
|
.IP
|
2007-12-30 15:55:22 +00:00
|
|
|
The retry timeout is the time that "UDP RPC"
|
2004-11-03 13:51:07 +00:00
|
|
|
waits for the server to reply before
|
|
|
|
retransmitting the request.
|
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "clnt_freeres(CLIENT * " clnt ", xdrproc_t " outproc ", char *" out );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
2007-12-30 15:55:22 +00:00
|
|
|
A macro that frees any data allocated by the RPC/XDR
|
|
|
|
system when it decoded the results of an RPC call.
|
2007-04-12 22:42:49 +00:00
|
|
|
The parameter
|
2004-11-03 13:51:07 +00:00
|
|
|
.I out
|
|
|
|
is the address of the results, and
|
|
|
|
.I outproc
|
2007-12-30 15:55:22 +00:00
|
|
|
is the XDR routine describing the results.
|
|
|
|
This routine returns one if the results were successfully freed,
|
2004-11-03 13:51:07 +00:00
|
|
|
and zero otherwise.
|
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "void clnt_geterr(CLIENT *" clnt ", struct rpc_err *" errp );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
|
|
|
A macro that copies the error structure out of the client
|
2007-12-30 15:55:22 +00:00
|
|
|
handle to the structure at address
|
2004-11-03 13:51:07 +00:00
|
|
|
.IR errp .
|
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "void clnt_pcreateerror(char *" s );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
2007-12-30 15:55:22 +00:00
|
|
|
Print a message to standard error indicating why a client RPC
|
2004-11-03 13:51:07 +00:00
|
|
|
handle could not be created.
|
|
|
|
The message is prepended with string
|
|
|
|
.I s
|
|
|
|
and a colon.
|
|
|
|
Used when a
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR clnt_create (),
|
|
|
|
.BR clntraw_create (),
|
|
|
|
.BR clnttcp_create (),
|
2004-11-03 13:51:07 +00:00
|
|
|
or
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR clntudp_create ()
|
2004-11-03 13:51:07 +00:00
|
|
|
call fails.
|
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "void clnt_perrno(enum clnt_stat " stat );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
|
|
|
Print a message to standard error corresponding
|
|
|
|
to the condition indicated by
|
|
|
|
.IR stat .
|
|
|
|
Used after
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR callrpc ().
|
2004-11-03 13:51:07 +00:00
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "clnt_perror(CLIENT *" clnt ", char *" s );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
2007-12-30 15:55:22 +00:00
|
|
|
Print a message to standard error indicating why an RPC call failed;
|
2004-11-03 13:51:07 +00:00
|
|
|
.I clnt
|
|
|
|
is the handle used to do the call.
|
|
|
|
The message is prepended with string
|
|
|
|
.I s
|
|
|
|
and a colon.
|
|
|
|
Used after
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR clnt_call ().
|
2004-11-03 13:51:07 +00:00
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "char *clnt_spcreateerror(char *" s );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
|
|
|
Like
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR clnt_pcreateerror (),
|
2007-12-30 15:55:22 +00:00
|
|
|
except that it returns a string instead of printing to the standard error.
|
2004-11-03 13:51:07 +00:00
|
|
|
.IP
|
2007-12-30 15:55:22 +00:00
|
|
|
Bugs: returns pointer to static data that is overwritten on each call.
|
2004-11-03 13:51:07 +00:00
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "char *clnt_sperrno(enum clnt_stat " stat );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
|
|
|
Take the same arguments as
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR clnt_perrno (),
|
2007-12-30 15:55:22 +00:00
|
|
|
but instead of sending a message to the standard error indicating why an RPC
|
|
|
|
call failed, return a pointer to a string which contains the message.
|
|
|
|
The string ends with a NEWLINE.
|
2004-11-03 13:51:07 +00:00
|
|
|
.IP
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR clnt_sperrno ()
|
2004-11-03 13:51:07 +00:00
|
|
|
is used instead of
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR clnt_perrno ()
|
2004-11-03 13:51:07 +00:00
|
|
|
if the program does not have a standard error (as a program
|
2007-12-30 15:55:22 +00:00
|
|
|
running as a server quite likely does not), or if the programmer
|
2004-11-03 13:51:07 +00:00
|
|
|
does not want the message to be output with
|
2007-06-14 06:25:37 +00:00
|
|
|
.BR printf (3),
|
2004-11-03 13:51:07 +00:00
|
|
|
or if a message format different than that supported by
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR clnt_perrno ()
|
2004-11-03 13:51:07 +00:00
|
|
|
is to be used.
|
|
|
|
Note: unlike
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR clnt_sperror ()
|
2004-11-03 13:51:07 +00:00
|
|
|
and
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR clnt_spcreaterror (),
|
|
|
|
.BR clnt_sperrno ()
|
2004-11-03 13:51:07 +00:00
|
|
|
returns pointer to static data, but the
|
|
|
|
result will not get overwritten on each call.
|
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "char *clnt_sperror(CLIENT *" rpch ", char *" s );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
|
|
|
Like
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR clnt_perror (),
|
2004-11-03 13:51:07 +00:00
|
|
|
except that (like
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR clnt_sperrno ())
|
2004-11-03 13:51:07 +00:00
|
|
|
it returns a string instead of printing to standard error.
|
|
|
|
.IP
|
2007-12-30 15:55:22 +00:00
|
|
|
Bugs: returns pointer to static data that is overwritten on each call.
|
2004-11-03 13:51:07 +00:00
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "CLIENT *clntraw_create(unsigned long " prognum \
|
|
|
|
", unsigned long " versnum );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
2007-12-30 15:55:22 +00:00
|
|
|
This routine creates a toy RPC client for the remote program
|
2004-11-03 13:51:07 +00:00
|
|
|
.IR prognum ,
|
|
|
|
version
|
|
|
|
.IR versnum .
|
|
|
|
The transport used to pass messages to the service is
|
|
|
|
actually a buffer within the process's address space, so the
|
2007-12-30 15:55:22 +00:00
|
|
|
corresponding RPC server should live in the same address space; see
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR svcraw_create ().
|
2007-12-30 15:55:22 +00:00
|
|
|
This allows simulation of RPC and acquisition of RPC
|
|
|
|
overheads, such as round trip times, without any kernel interference.
|
|
|
|
This routine returns NULL if it fails.
|
2004-11-03 13:51:07 +00:00
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "CLIENT *clnttcp_create(struct sockaddr_in *" addr ,
|
|
|
|
.BI " unsigned long " prognum ", unsigned long " versnum ,
|
|
|
|
.BI " int *" sockp ", unsigned int " sendsz \
|
|
|
|
", unsigned int " recvsz );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
2007-12-30 15:55:22 +00:00
|
|
|
This routine creates an RPC client for the remote program
|
2004-11-03 13:51:07 +00:00
|
|
|
.IR prognum ,
|
|
|
|
version
|
|
|
|
.IR versnum ;
|
2007-12-30 15:55:22 +00:00
|
|
|
the client uses TCP/IP as a transport.
|
|
|
|
The remote program is located at Internet address
|
2004-11-03 13:51:07 +00:00
|
|
|
.IR *addr .
|
|
|
|
If
|
2009-03-30 20:23:02 +00:00
|
|
|
.\"The following inline font conversion is necessary for the hyphen indicator
|
time.1, _syscall.2, acct.2, getsockname.2, nanosleep.2, pciconfig_read.2, sched_get_priority_max.2, umask.2, uname.2, ustat.2, INFINITY.3, argz_add.3, atexit.3, bsearch.3, byteorder.3, carg.3, closedir.3, dlopen.3, drand48.3, envz_add.3, errno.3, ether_aton.3, exp10.3, finite.3, flockfile.3, fseeko.3, getcontext.3, getmntent.3, getnetent.3, getprotoent.3, getrpcent.3, getservent.3, iconv_close.3, iconv_open.3, initgroups.3, login.3, longjmp.3, mbsinit.3, memccpy.3, memmem.3, mempcpy.3, offsetof.3, on_exit.3, pow10.3, pthread_cancel.3, pthread_cleanup_push.3, rpc.3, rpmatch.3, setenv.3, setjmp.3, setlogmask.3, sockatmark.3, strfmon.3, strptime.3, strverscmp.3, swab.3, tcgetpgrp.3, tmpfile.3, toascii.3, y0.3, null.4, tty.4, tty_ioctl.4, hosts.equiv.5, environ.7, path_resolution.7, tzselect.8: Convert inline formatting (\fX...\fP) to dot-directive formatting
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-06-07 15:25:32 +00:00
|
|
|
.I addr\->sin_port
|
2004-11-03 13:51:07 +00:00
|
|
|
is zero, then it is set to the actual port that the remote
|
|
|
|
program is listening on (the remote
|
|
|
|
.B portmap
|
2007-04-12 22:42:49 +00:00
|
|
|
service is consulted for this information).
|
|
|
|
The parameter
|
2004-11-03 13:51:07 +00:00
|
|
|
.I sockp
|
|
|
|
is a socket; if it is
|
2007-12-16 15:39:37 +00:00
|
|
|
.BR RPC_ANYSOCK ,
|
2004-11-03 13:51:07 +00:00
|
|
|
then this routine opens a new one and sets
|
|
|
|
.IR sockp .
|
2007-12-30 15:55:22 +00:00
|
|
|
Since TCP-based RPC uses buffered I/O,
|
2004-11-03 13:51:07 +00:00
|
|
|
the user may specify the size of the send and receive buffers
|
|
|
|
with the parameters
|
|
|
|
.I sendsz
|
|
|
|
and
|
|
|
|
.IR recvsz ;
|
|
|
|
values of zero choose suitable defaults.
|
2007-12-30 15:55:22 +00:00
|
|
|
This routine returns NULL if it fails.
|
2004-11-03 13:51:07 +00:00
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 16:01:21 +00:00
|
|
|
.BI "CLIENT *clntudp_create(struct sockaddr_in *" addr ,
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI " unsigned long " prognum ", unsigned long " versnum ,
|
|
|
|
.BI " struct timeval " wait ", int *" sockp );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
2007-12-30 15:55:22 +00:00
|
|
|
This routine creates an RPC client for the remote program
|
2004-11-03 13:51:07 +00:00
|
|
|
.IR prognum ,
|
|
|
|
version
|
|
|
|
.IR versnum ;
|
2007-12-30 15:55:22 +00:00
|
|
|
the client uses use UDP/IP as a transport.
|
|
|
|
The remote program is located at Internet address
|
2004-11-03 13:51:07 +00:00
|
|
|
.IR addr .
|
|
|
|
If
|
time.1, _syscall.2, acct.2, getsockname.2, nanosleep.2, pciconfig_read.2, sched_get_priority_max.2, umask.2, uname.2, ustat.2, INFINITY.3, argz_add.3, atexit.3, bsearch.3, byteorder.3, carg.3, closedir.3, dlopen.3, drand48.3, envz_add.3, errno.3, ether_aton.3, exp10.3, finite.3, flockfile.3, fseeko.3, getcontext.3, getmntent.3, getnetent.3, getprotoent.3, getrpcent.3, getservent.3, iconv_close.3, iconv_open.3, initgroups.3, login.3, longjmp.3, mbsinit.3, memccpy.3, memmem.3, mempcpy.3, offsetof.3, on_exit.3, pow10.3, pthread_cancel.3, pthread_cleanup_push.3, rpc.3, rpmatch.3, setenv.3, setjmp.3, setlogmask.3, sockatmark.3, strfmon.3, strptime.3, strverscmp.3, swab.3, tcgetpgrp.3, tmpfile.3, toascii.3, y0.3, null.4, tty.4, tty_ioctl.4, hosts.equiv.5, environ.7, path_resolution.7, tzselect.8: Convert inline formatting (\fX...\fP) to dot-directive formatting
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-06-07 15:25:32 +00:00
|
|
|
.I addr\->sin_port
|
2004-11-03 13:51:07 +00:00
|
|
|
is zero, then it is set to actual port that the remote
|
|
|
|
program is listening on (the remote
|
|
|
|
.B portmap
|
2007-04-12 22:42:49 +00:00
|
|
|
service is consulted for this information).
|
|
|
|
The parameter
|
2004-11-03 13:51:07 +00:00
|
|
|
.I sockp
|
|
|
|
is a socket; if it is
|
2007-12-16 15:39:37 +00:00
|
|
|
.BR RPC_ANYSOCK ,
|
2004-11-03 13:51:07 +00:00
|
|
|
then this routine opens a new one and sets
|
|
|
|
.IR sockp .
|
2007-12-30 15:55:22 +00:00
|
|
|
The UDP transport resends the call message in intervals of
|
2007-12-13 20:46:52 +00:00
|
|
|
.I wait
|
2007-12-30 15:55:22 +00:00
|
|
|
time until a response is received or until the call times out.
|
2004-11-03 13:51:07 +00:00
|
|
|
The total time for the call to time out is specified by
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR clnt_call ().
|
2004-11-03 13:51:07 +00:00
|
|
|
.IP
|
intro.1, _syscall.2, access.2, arch_prctl.2, cacheflush.2, chown.2, clock_getres.2, clone.2, create_module.2, fcntl.2, flock.2, get_kernel_syms.2, get_robust_list.2, get_thread_area.2, getcpu.2, getpriority.2, getrlimit.2, getrusage.2, ioprio_set.2, kexec_load.2, madvise.2, mbind.2, migrate_pages.2, mknod.2, mmap.2, mount.2, move_pages.2, mprotect.2, open.2, pause.2, pciconfig_read.2, perf_event_open.2, prctl.2, ptrace.2, query_module.2, read.2, reboot.2, recv.2, s390_runtime_instr.2, sched_setscheduler.2, select_tut.2, send.2, set_mempolicy.2, setfsgid.2, setfsuid.2, sigaction.2, spu_create.2, spu_run.2, stime.2, swapon.2, syslog.2, timer_create.2, timer_getoverrun.2, times.2, tkill.2, umount.2, unimplemented.2, ustat.2, vm86.2, wait.2, abs.3, aio_read.3, aio_write.3, bsd_signal.3, catgets.3, clearenv.3, cmsg.3, dbopen.3, dirfd.3, dlopen.3, exec.3, fenv.3, ferror.3, fmemopen.3, fnmatch.3, fopen.3, futimes.3, getaddrinfo.3, getifaddrs.3, getipnodebyname.3, hsearch.3, if_nameindex.3, inet_pton.3, mblen.3, mbrlen.3, mbsrtowcs.3, mbtowc.3, mcheck.3, memfrob.3, mq_notify.3, netlink.3, posix_memalign.3, printf.3, pthread_attr_setscope.3, pthread_cleanup_push.3, pthread_kill_other_threads_np.3, pthread_self.3, pthread_setcancelstate.3, pthread_setconcurrency.3, raise.3, resolver.3, rpc.3, rtime.3, rtnetlink.3, scanf.3, setbuf.3, setnetgrent.3, shm_open.3, sigpause.3, sigset.3, sigwait.3, sockatmark.3, strcasecmp.3, strcmp.3, strdup.3, strftime.3, strptime.3, strsignal.3, strverscmp.3, sysv_signal.3, termios.3, wcrtomb.3, wcsnlen.3, wcsnrtombs.3, wcsrtombs.3, wctomb.3, wprintf.3, console_codes.4, cpuid.4, msr.4, rtc.4, sk98lin.4, st.4, tty.4, charmap.5, core.5, elf.5, hosts.equiv.5, proc.5, resolv.conf.5, services.5, slabinfo.5, arp.7, bootparam.7, capabilities.7, charsets.7, cpuset.7, ddp.7, epoll.7, feature_test_macros.7, futex.7, hier.7, icmp.7, inotify.7, ip.7, ipv6.7, man-pages.7, mdoc.7, mdoc.samples.7, netdevice.7, netlink.7, numa.7, packet.7, path_resolution.7, posixoptions.7, pthreads.7, raw.7, rtld-audit.7, rtnetlink.7, sem_overview.7, sigevent.7, socket.7, spufs.7, tcp.7, udp.7, unicode.7, uri.7, utf-8.7, intro.8, ldconfig.8, sync.8: Global fix: fix placement of word "only"
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-03-31 08:53:00 +00:00
|
|
|
Warning: since UDP-based RPC messages can hold only up to 8 Kbytes
|
2004-11-03 13:51:07 +00:00
|
|
|
of encoded data, this transport cannot be used for procedures
|
|
|
|
that take large arguments or return huge results.
|
2007-12-30 15:55:22 +00:00
|
|
|
.LP
|
|
|
|
.nf
|
|
|
|
.BI "CLIENT *clntudp_bufcreate(struct sockaddr_in *" addr ,
|
|
|
|
.BI " unsigned long " prognum ", unsigned long " versnum ,
|
|
|
|
.BI " struct timeval " wait ", int *" sockp ,
|
|
|
|
.BI " unsigned int " sendsize ", unsigned int "recosize );
|
|
|
|
.fi
|
|
|
|
.IP
|
|
|
|
This routine creates an RPC client for the remote program
|
2004-11-03 13:51:07 +00:00
|
|
|
.IR prognum ,
|
|
|
|
on
|
|
|
|
.IR versnum ;
|
2007-12-30 15:55:22 +00:00
|
|
|
the client uses use UDP/IP as a transport.
|
|
|
|
The remote program is located at Internet address
|
2004-11-03 13:51:07 +00:00
|
|
|
.IR addr .
|
|
|
|
If
|
time.1, _syscall.2, acct.2, getsockname.2, nanosleep.2, pciconfig_read.2, sched_get_priority_max.2, umask.2, uname.2, ustat.2, INFINITY.3, argz_add.3, atexit.3, bsearch.3, byteorder.3, carg.3, closedir.3, dlopen.3, drand48.3, envz_add.3, errno.3, ether_aton.3, exp10.3, finite.3, flockfile.3, fseeko.3, getcontext.3, getmntent.3, getnetent.3, getprotoent.3, getrpcent.3, getservent.3, iconv_close.3, iconv_open.3, initgroups.3, login.3, longjmp.3, mbsinit.3, memccpy.3, memmem.3, mempcpy.3, offsetof.3, on_exit.3, pow10.3, pthread_cancel.3, pthread_cleanup_push.3, rpc.3, rpmatch.3, setenv.3, setjmp.3, setlogmask.3, sockatmark.3, strfmon.3, strptime.3, strverscmp.3, swab.3, tcgetpgrp.3, tmpfile.3, toascii.3, y0.3, null.4, tty.4, tty_ioctl.4, hosts.equiv.5, environ.7, path_resolution.7, tzselect.8: Convert inline formatting (\fX...\fP) to dot-directive formatting
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-06-07 15:25:32 +00:00
|
|
|
.I addr\->sin_port
|
2004-11-03 13:51:07 +00:00
|
|
|
is zero, then it is set to actual port that the remote
|
|
|
|
program is listening on (the remote
|
|
|
|
.B portmap
|
2007-04-12 22:42:49 +00:00
|
|
|
service is consulted for this information).
|
|
|
|
The parameter
|
2004-11-03 13:51:07 +00:00
|
|
|
.I sockp
|
|
|
|
is a socket; if it is
|
2007-12-16 15:39:37 +00:00
|
|
|
.BR RPC_ANYSOCK ,
|
2004-11-03 13:51:07 +00:00
|
|
|
then this routine opens a new one and sets
|
2008-09-18 12:30:39 +00:00
|
|
|
.IR sockp .
|
2007-12-30 15:55:22 +00:00
|
|
|
The UDP transport resends the call message in intervals of
|
2007-12-13 20:46:52 +00:00
|
|
|
.I wait
|
2007-12-30 15:55:22 +00:00
|
|
|
time until a response is received or until the call times out.
|
2004-11-03 13:51:07 +00:00
|
|
|
The total time for the call to time out is specified by
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR clnt_call ().
|
2004-11-03 13:51:07 +00:00
|
|
|
.IP
|
2007-12-30 15:55:22 +00:00
|
|
|
This allows the user to specify the maximum packet
|
|
|
|
size for sending and receiving UDP-based RPC messages.
|
2004-11-03 13:51:07 +00:00
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "void get_myaddress(struct sockaddr_in *" addr );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
2007-12-30 15:55:22 +00:00
|
|
|
Stuff the machine's IP address into
|
2004-11-03 13:51:07 +00:00
|
|
|
.IR *addr ,
|
|
|
|
without consulting the library routines that deal with
|
2005-11-02 13:55:25 +00:00
|
|
|
.IR /etc/hosts .
|
2004-11-03 13:51:07 +00:00
|
|
|
The port number is always set to
|
2007-12-16 15:39:37 +00:00
|
|
|
.BR htons(PMAPPORT) .
|
2004-11-03 13:51:07 +00:00
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "struct pmaplist *pmap_getmaps(struct sockaddr_in *" addr );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
|
|
|
A user interface to the
|
|
|
|
.B portmap
|
2007-12-30 15:55:22 +00:00
|
|
|
service, which returns a list of the current RPC
|
|
|
|
program-to-port mappings on the host located at IP address
|
2004-11-03 13:51:07 +00:00
|
|
|
.IR *addr .
|
2007-12-30 15:55:22 +00:00
|
|
|
This routine can return NULL.
|
2004-11-03 13:51:07 +00:00
|
|
|
The command
|
2007-12-18 07:47:22 +00:00
|
|
|
.IR "rpcinfo\ \-p"
|
2004-11-03 13:51:07 +00:00
|
|
|
uses this routine.
|
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "unsigned short pmap_getport(struct sockaddr_in *" addr ,
|
|
|
|
.BI " unsigned long " prognum ", unsigned long " versnum ,
|
|
|
|
.BI " unsigned int " protocol );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
|
|
|
A user interface to the
|
|
|
|
.B portmap
|
|
|
|
service, which returns the port number
|
|
|
|
on which waits a service that supports program number
|
|
|
|
.IR prognum ,
|
|
|
|
version
|
|
|
|
.IR versnum ,
|
|
|
|
and speaks the transport protocol associated with
|
|
|
|
.IR protocol .
|
|
|
|
The value of
|
|
|
|
.I protocol
|
|
|
|
is most likely
|
2007-12-30 15:55:22 +00:00
|
|
|
.B IPPROTO_UDP
|
2007-04-12 22:42:49 +00:00
|
|
|
or
|
2007-12-16 15:39:37 +00:00
|
|
|
.BR IPPROTO_TCP .
|
2004-11-03 13:51:07 +00:00
|
|
|
A return value of zero means that the mapping does not exist
|
2007-12-30 15:55:22 +00:00
|
|
|
or that the RPC system failed to contact the remote
|
2004-11-03 13:51:07 +00:00
|
|
|
.B portmap
|
2007-04-12 22:42:49 +00:00
|
|
|
service.
|
|
|
|
In the latter case, the global variable
|
2007-12-30 15:55:22 +00:00
|
|
|
.I rpc_createerr
|
|
|
|
contains the RPC status.
|
2004-11-03 13:51:07 +00:00
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "enum clnt_stat pmap_rmtcall(struct sockaddr_in *" addr ,
|
|
|
|
.BI " unsigned long " prognum ", unsigned long " versnum ,
|
2008-07-17 13:33:33 +00:00
|
|
|
.BI " unsigned long " procnum ,
|
|
|
|
.BI " xdrproc_t " inproc ", char *" in ,
|
|
|
|
.BI " xdrproc_t " outproc ", char *" out ,
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI " struct timeval " tout ", unsigned long *" portp );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
|
|
|
A user interface to the
|
|
|
|
.B portmap
|
|
|
|
service, which instructs
|
|
|
|
.B portmap
|
2007-12-30 15:55:22 +00:00
|
|
|
on the host at IP address
|
2004-11-03 13:51:07 +00:00
|
|
|
.I *addr
|
2007-12-30 15:55:22 +00:00
|
|
|
to make an RPC call on your behalf to a procedure on that host.
|
2004-11-03 13:51:07 +00:00
|
|
|
The parameter
|
|
|
|
.I *portp
|
2007-12-30 15:55:22 +00:00
|
|
|
will be modified to the program's port number if the procedure succeeds.
|
2007-04-12 22:42:49 +00:00
|
|
|
The definitions of other parameters are discussed
|
2004-11-03 13:51:07 +00:00
|
|
|
in
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR callrpc ()
|
2004-11-03 13:51:07 +00:00
|
|
|
and
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR clnt_call ().
|
2007-12-30 15:55:22 +00:00
|
|
|
This procedure should be used for a \(lqping\(rq and nothing else.
|
2004-11-03 13:51:07 +00:00
|
|
|
See also
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR clnt_broadcast ().
|
2004-11-03 13:51:07 +00:00
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "bool_t pmap_set(unsigned long " prognum ", unsigned long " versnum ,
|
|
|
|
.BI " unsigned int " protocol ", unsigned short " port );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
|
|
|
A user interface to the
|
|
|
|
.B portmap
|
|
|
|
service, which establishes a mapping between the triple
|
time.1, _syscall.2, acct.2, getsockname.2, nanosleep.2, pciconfig_read.2, sched_get_priority_max.2, umask.2, uname.2, ustat.2, INFINITY.3, argz_add.3, atexit.3, bsearch.3, byteorder.3, carg.3, closedir.3, dlopen.3, drand48.3, envz_add.3, errno.3, ether_aton.3, exp10.3, finite.3, flockfile.3, fseeko.3, getcontext.3, getmntent.3, getnetent.3, getprotoent.3, getrpcent.3, getservent.3, iconv_close.3, iconv_open.3, initgroups.3, login.3, longjmp.3, mbsinit.3, memccpy.3, memmem.3, mempcpy.3, offsetof.3, on_exit.3, pow10.3, pthread_cancel.3, pthread_cleanup_push.3, rpc.3, rpmatch.3, setenv.3, setjmp.3, setlogmask.3, sockatmark.3, strfmon.3, strptime.3, strverscmp.3, swab.3, tcgetpgrp.3, tmpfile.3, toascii.3, y0.3, null.4, tty.4, tty_ioctl.4, hosts.equiv.5, environ.7, path_resolution.7, tzselect.8: Convert inline formatting (\fX...\fP) to dot-directive formatting
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-06-07 15:25:32 +00:00
|
|
|
.RI [ prognum , versnum , protocol ]
|
2004-11-03 13:51:07 +00:00
|
|
|
and
|
|
|
|
.I port
|
|
|
|
on the machine's
|
|
|
|
.B portmap
|
2007-04-12 22:42:49 +00:00
|
|
|
service.
|
|
|
|
The value of
|
2004-11-03 13:51:07 +00:00
|
|
|
.I protocol
|
|
|
|
is most likely
|
2007-12-30 15:55:22 +00:00
|
|
|
.B IPPROTO_UDP
|
2007-04-12 22:42:49 +00:00
|
|
|
or
|
2007-12-16 15:39:37 +00:00
|
|
|
.BR IPPROTO_TCP .
|
2004-11-03 13:51:07 +00:00
|
|
|
This routine returns one if it succeeds, zero otherwise.
|
|
|
|
Automatically done by
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR svc_register ().
|
2004-11-03 13:51:07 +00:00
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "bool_t pmap_unset(unsigned long " prognum ", unsigned long " versnum );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
|
|
|
A user interface to the
|
|
|
|
.B portmap
|
|
|
|
service, which destroys all mapping between the triple
|
time.1, _syscall.2, acct.2, getsockname.2, nanosleep.2, pciconfig_read.2, sched_get_priority_max.2, umask.2, uname.2, ustat.2, INFINITY.3, argz_add.3, atexit.3, bsearch.3, byteorder.3, carg.3, closedir.3, dlopen.3, drand48.3, envz_add.3, errno.3, ether_aton.3, exp10.3, finite.3, flockfile.3, fseeko.3, getcontext.3, getmntent.3, getnetent.3, getprotoent.3, getrpcent.3, getservent.3, iconv_close.3, iconv_open.3, initgroups.3, login.3, longjmp.3, mbsinit.3, memccpy.3, memmem.3, mempcpy.3, offsetof.3, on_exit.3, pow10.3, pthread_cancel.3, pthread_cleanup_push.3, rpc.3, rpmatch.3, setenv.3, setjmp.3, setlogmask.3, sockatmark.3, strfmon.3, strptime.3, strverscmp.3, swab.3, tcgetpgrp.3, tmpfile.3, toascii.3, y0.3, null.4, tty.4, tty_ioctl.4, hosts.equiv.5, environ.7, path_resolution.7, tzselect.8: Convert inline formatting (\fX...\fP) to dot-directive formatting
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-06-07 15:25:32 +00:00
|
|
|
.RI [ prognum , versnum , * ]
|
2004-11-03 13:51:07 +00:00
|
|
|
and
|
|
|
|
.B ports
|
|
|
|
on the machine's
|
|
|
|
.B portmap
|
2007-04-12 22:42:49 +00:00
|
|
|
service.
|
2007-12-30 15:55:22 +00:00
|
|
|
This routine returns one if it succeeds, zero otherwise.
|
2004-11-03 13:51:07 +00:00
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "int registerrpc(unsigned long " prognum ", unsigned long " versnum ,
|
2008-01-12 08:57:58 +00:00
|
|
|
.BI " unsigned long " procnum ", char *(*" procname ")(char *),"
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI " xdrproc_t " inproc ", xdrproc_t " outproc );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
|
|
|
Register procedure
|
|
|
|
.I procname
|
2007-12-30 15:55:22 +00:00
|
|
|
with the RPC service package.
|
2007-04-12 22:42:49 +00:00
|
|
|
If a request arrives for program
|
2004-11-03 13:51:07 +00:00
|
|
|
.IR prognum ,
|
|
|
|
version
|
|
|
|
.IR versnum ,
|
|
|
|
and procedure
|
|
|
|
.IR procnum ,
|
|
|
|
.I procname
|
|
|
|
is called with a pointer to its parameter(s);
|
|
|
|
.I progname
|
|
|
|
should return a pointer to its static result(s);
|
|
|
|
.I inproc
|
|
|
|
is used to decode the parameters while
|
|
|
|
.I outproc
|
|
|
|
is used to encode the results.
|
2007-12-30 15:55:22 +00:00
|
|
|
This routine returns zero if the registration succeeded, \-1 otherwise.
|
2004-11-03 13:51:07 +00:00
|
|
|
.IP
|
|
|
|
Warning: remote procedures registered in this form
|
2007-12-30 15:55:22 +00:00
|
|
|
are accessed using the UDP/IP transport; see
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR svcudp_create ()
|
2004-11-03 13:51:07 +00:00
|
|
|
for restrictions.
|
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "struct rpc_createerr " rpc_createerr ;
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
2007-12-30 15:55:22 +00:00
|
|
|
A global variable whose value is set by any RPC client creation routine
|
2007-04-12 22:42:49 +00:00
|
|
|
that does not succeed.
|
|
|
|
Use the routine
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR clnt_pcreateerror ()
|
2004-11-03 13:51:07 +00:00
|
|
|
to print the reason why.
|
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "void svc_destroy(SVCXPRT *" xprt );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
2007-12-30 15:55:22 +00:00
|
|
|
A macro that destroys the RPC service transport handle,
|
2004-11-03 13:51:07 +00:00
|
|
|
.IR xprt .
|
|
|
|
Destruction usually involves deallocation
|
|
|
|
of private data structures, including
|
|
|
|
.I xprt
|
2007-04-12 22:42:49 +00:00
|
|
|
itself.
|
|
|
|
Use of
|
2004-11-03 13:51:07 +00:00
|
|
|
.I xprt
|
|
|
|
is undefined after calling this routine.
|
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "fd_set " svc_fdset ;
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
2007-12-30 15:55:22 +00:00
|
|
|
A global variable reflecting the RPC service side's
|
|
|
|
read file descriptor bit mask; it is suitable as a parameter to the
|
2007-06-14 06:25:37 +00:00
|
|
|
.BR select (2)
|
2007-04-12 22:42:49 +00:00
|
|
|
system call.
|
2013-09-26 13:06:36 +00:00
|
|
|
This is of interest only if a service implementor does their own
|
|
|
|
asynchronous event processing, instead of calling
|
|
|
|
.BR svc_run ().
|
2004-11-03 13:51:07 +00:00
|
|
|
This variable is read-only (do not pass its address to
|
2007-06-14 06:25:37 +00:00
|
|
|
.BR select (2)!),
|
2004-11-03 13:51:07 +00:00
|
|
|
yet it may change after calls to
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR svc_getreqset ()
|
2004-11-03 13:51:07 +00:00
|
|
|
or any creation routines.
|
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "int " svc_fds ;
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
|
|
|
Similar to
|
|
|
|
.BR svc_fdset ,
|
2007-04-12 22:42:49 +00:00
|
|
|
but limited to 32 descriptors.
|
|
|
|
This interface is obsoleted by
|
2004-11-03 13:51:07 +00:00
|
|
|
.BR svc_fdset .
|
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "svc_freeargs(SVCXPRT *" xprt ", xdrproc_t " inproc ", char *" in );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
2007-12-30 15:55:22 +00:00
|
|
|
A macro that frees any data allocated by the RPC/XDR
|
|
|
|
system when it decoded the arguments to a service procedure using
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR svc_getargs ().
|
2007-12-30 15:55:22 +00:00
|
|
|
This routine returns 1 if the results were successfully freed,
|
2004-11-03 13:51:07 +00:00
|
|
|
and zero otherwise.
|
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "svc_getargs(SVCXPRT *" xprt ", xdrproc_t " inproc ", char *" in );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
2007-12-30 15:55:22 +00:00
|
|
|
A macro that decodes the arguments of an RPC request
|
|
|
|
associated with the RPC service transport handle,
|
2004-11-03 13:51:07 +00:00
|
|
|
.IR xprt .
|
|
|
|
The parameter
|
|
|
|
.I in
|
|
|
|
is the address where the arguments will be placed;
|
|
|
|
.I inproc
|
2007-12-30 15:55:22 +00:00
|
|
|
is the XDR routine used to decode the arguments.
|
|
|
|
This routine returns one if decoding succeeds, and zero otherwise.
|
2004-11-03 13:51:07 +00:00
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "struct sockaddr_in *svc_getcaller(SVCXPRT *" xprt );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
|
|
|
The approved way of getting the network address of the caller
|
2007-12-30 15:55:22 +00:00
|
|
|
of a procedure associated with the RPC service transport handle,
|
2004-11-03 13:51:07 +00:00
|
|
|
.IR xprt .
|
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "void svc_getreqset(fd_set *" rdfds );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
intro.1, _syscall.2, access.2, arch_prctl.2, cacheflush.2, chown.2, clock_getres.2, clone.2, create_module.2, fcntl.2, flock.2, get_kernel_syms.2, get_robust_list.2, get_thread_area.2, getcpu.2, getpriority.2, getrlimit.2, getrusage.2, ioprio_set.2, kexec_load.2, madvise.2, mbind.2, migrate_pages.2, mknod.2, mmap.2, mount.2, move_pages.2, mprotect.2, open.2, pause.2, pciconfig_read.2, perf_event_open.2, prctl.2, ptrace.2, query_module.2, read.2, reboot.2, recv.2, s390_runtime_instr.2, sched_setscheduler.2, select_tut.2, send.2, set_mempolicy.2, setfsgid.2, setfsuid.2, sigaction.2, spu_create.2, spu_run.2, stime.2, swapon.2, syslog.2, timer_create.2, timer_getoverrun.2, times.2, tkill.2, umount.2, unimplemented.2, ustat.2, vm86.2, wait.2, abs.3, aio_read.3, aio_write.3, bsd_signal.3, catgets.3, clearenv.3, cmsg.3, dbopen.3, dirfd.3, dlopen.3, exec.3, fenv.3, ferror.3, fmemopen.3, fnmatch.3, fopen.3, futimes.3, getaddrinfo.3, getifaddrs.3, getipnodebyname.3, hsearch.3, if_nameindex.3, inet_pton.3, mblen.3, mbrlen.3, mbsrtowcs.3, mbtowc.3, mcheck.3, memfrob.3, mq_notify.3, netlink.3, posix_memalign.3, printf.3, pthread_attr_setscope.3, pthread_cleanup_push.3, pthread_kill_other_threads_np.3, pthread_self.3, pthread_setcancelstate.3, pthread_setconcurrency.3, raise.3, resolver.3, rpc.3, rtime.3, rtnetlink.3, scanf.3, setbuf.3, setnetgrent.3, shm_open.3, sigpause.3, sigset.3, sigwait.3, sockatmark.3, strcasecmp.3, strcmp.3, strdup.3, strftime.3, strptime.3, strsignal.3, strverscmp.3, sysv_signal.3, termios.3, wcrtomb.3, wcsnlen.3, wcsnrtombs.3, wcsrtombs.3, wctomb.3, wprintf.3, console_codes.4, cpuid.4, msr.4, rtc.4, sk98lin.4, st.4, tty.4, charmap.5, core.5, elf.5, hosts.equiv.5, proc.5, resolv.conf.5, services.5, slabinfo.5, arp.7, bootparam.7, capabilities.7, charsets.7, cpuset.7, ddp.7, epoll.7, feature_test_macros.7, futex.7, hier.7, icmp.7, inotify.7, ip.7, ipv6.7, man-pages.7, mdoc.7, mdoc.samples.7, netdevice.7, netlink.7, numa.7, packet.7, path_resolution.7, posixoptions.7, pthreads.7, raw.7, rtld-audit.7, rtnetlink.7, sem_overview.7, sigevent.7, socket.7, spufs.7, tcp.7, udp.7, unicode.7, uri.7, utf-8.7, intro.8, ldconfig.8, sync.8: Global fix: fix placement of word "only"
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-03-31 08:53:00 +00:00
|
|
|
This routine is of interest only if a service implementor does not call
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR svc_run (),
|
2004-11-03 13:51:07 +00:00
|
|
|
but instead implements custom asynchronous event processing.
|
|
|
|
It is called when the
|
2007-06-14 06:25:37 +00:00
|
|
|
.BR select (2)
|
2007-12-30 15:55:22 +00:00
|
|
|
system call has determined that an RPC request has arrived on some
|
|
|
|
RPC socket(s);
|
2004-11-03 13:51:07 +00:00
|
|
|
.I rdfds
|
|
|
|
is the resultant read file descriptor bit mask.
|
2007-12-30 15:55:22 +00:00
|
|
|
The routine returns when all sockets associated with the value of
|
2004-11-03 13:51:07 +00:00
|
|
|
.I rdfds
|
|
|
|
have been serviced.
|
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "void svc_getreq(int " rdfds );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
|
|
|
Similar to
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR svc_getreqset (),
|
2007-04-12 22:42:49 +00:00
|
|
|
but limited to 32 descriptors.
|
|
|
|
This interface is obsoleted by
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR svc_getreqset ().
|
2004-11-03 13:51:07 +00:00
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "bool_t svc_register(SVCXPRT *" xprt ", unsigned long " prognum ,
|
|
|
|
.BI " unsigned long " versnum ,
|
|
|
|
.BI " void (*" dispatch ")(svc_req *, SVCXPRT *),"
|
|
|
|
.BI " unsigned long " protocol );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
|
|
|
Associates
|
|
|
|
.I prognum
|
|
|
|
and
|
|
|
|
.I versnum
|
|
|
|
with the service dispatch procedure,
|
|
|
|
.IR dispatch .
|
|
|
|
If
|
|
|
|
.I protocol
|
|
|
|
is zero, the service is not registered with the
|
|
|
|
.B portmap
|
2007-04-12 22:42:49 +00:00
|
|
|
service.
|
|
|
|
If
|
2004-11-03 13:51:07 +00:00
|
|
|
.I protocol
|
intro.1, time.1, adjtimex.2, capget.2, eventfd.2, fcntl.2, getrlimit.2, getsockopt.2, gettimeofday.2, intro.2, ioctl_list.2, ioperm.2, mlock.2, pivot_root.2, poll.2, prctl.2, ptrace.2, sched_setscheduler.2, select_tut.2, semget.2, sigaltstack.2, signalfd.2, sysctl.2, timer_settime.2, timerfd_create.2, wait.2, CPU_SET.3, argz_add.3, assert_perror.3, atexit.3, backtrace.3, bcmp.3, clearenv.3, ctime.3, dl_iterate_phdr.3, dlopen.3, ecvt.3, errno.3, error.3, ether_aton.3, exit.3, fenv.3, ferror.3, finite.3, flockfile.3, fnmatch.3, fpathconf.3, fpclassify.3, ftime.3, ftok.3, ftw.3, fwide.3, getaddrinfo.3, gethostbyname.3, getlogin.3, getnameinfo.3, getnetent.3, getopt.3, getprotoent.3, getrpcent.3, getservent.3, glob.3, hsearch.3, inet.3, isalpha.3, iswalnum.3, iswalpha.3, iswblank.3, iswcntrl.3, iswctype.3, iswdigit.3, iswgraph.3, iswlower.3, iswprint.3, iswpunct.3, iswspace.3, iswupper.3, iswxdigit.3, longjmp.3, lsearch.3, malloc.3, matherr.3, mblen.3, mbsinit.3, mbtowc.3, on_exit.3, printf.3, pthread_attr_init.3, pthread_attr_setaffinity_np.3, pthread_attr_setdetachstate.3, pthread_attr_setguardsize.3, pthread_attr_setinheritsched.3, pthread_attr_setschedparam.3, pthread_attr_setschedpolicy.3, pthread_attr_setscope.3, pthread_attr_setstack.3, pthread_attr_setstackaddr.3, pthread_attr_setstacksize.3, pthread_cancel.3, pthread_cleanup_push.3, pthread_equal.3, pthread_getattr_np.3, pthread_getcpuclockid.3, pthread_setaffinity_np.3, pthread_setcancelstate.3, pthread_setconcurrency.3, pthread_setschedparam.3, pthread_setschedprio.3, ptsname.3, putenv.3, putgrent.3, raise.3, rcmd.3, regex.3, rexec.3, rpc.3, rpmatch.3, rtnetlink.3, scandir.3, sem_init.3, setaliasent.3, setbuf.3, setenv.3, setjmp.3, signbit.3, stdio_ext.3, strtod.3, strtol.3, strtoul.3, system.3, termios.3, timeradd.3, tzset.3, ualarm.3, wctomb.3, xdr.3, st.4, tty_ioctl.4, core.5, elf.5, proc.5, bootparam.7, capabilities.7, icmp.7, ip.7, ipv6.7, math_error.7, mdoc.samples.7, mq_overview.7, pthreads.7, raw.7, regex.7, socket.7, tcp.7, tzselect.8: Global fix: s/non-zero/nonzero/
The tendency in English, as prescribed in style guides like
Chicago MoS, is towards removing hyphens after prefixes
like "non-" etc.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-01-16 16:40:55 +00:00
|
|
|
is nonzero, then a mapping of the triple
|
time.1, _syscall.2, acct.2, getsockname.2, nanosleep.2, pciconfig_read.2, sched_get_priority_max.2, umask.2, uname.2, ustat.2, INFINITY.3, argz_add.3, atexit.3, bsearch.3, byteorder.3, carg.3, closedir.3, dlopen.3, drand48.3, envz_add.3, errno.3, ether_aton.3, exp10.3, finite.3, flockfile.3, fseeko.3, getcontext.3, getmntent.3, getnetent.3, getprotoent.3, getrpcent.3, getservent.3, iconv_close.3, iconv_open.3, initgroups.3, login.3, longjmp.3, mbsinit.3, memccpy.3, memmem.3, mempcpy.3, offsetof.3, on_exit.3, pow10.3, pthread_cancel.3, pthread_cleanup_push.3, rpc.3, rpmatch.3, setenv.3, setjmp.3, setlogmask.3, sockatmark.3, strfmon.3, strptime.3, strverscmp.3, swab.3, tcgetpgrp.3, tmpfile.3, toascii.3, y0.3, null.4, tty.4, tty_ioctl.4, hosts.equiv.5, environ.7, path_resolution.7, tzselect.8: Convert inline formatting (\fX...\fP) to dot-directive formatting
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-06-07 15:25:32 +00:00
|
|
|
.RI [ prognum , versnum , protocol ]
|
2004-11-03 13:51:07 +00:00
|
|
|
to
|
time.1, _syscall.2, acct.2, getsockname.2, nanosleep.2, pciconfig_read.2, sched_get_priority_max.2, umask.2, uname.2, ustat.2, INFINITY.3, argz_add.3, atexit.3, bsearch.3, byteorder.3, carg.3, closedir.3, dlopen.3, drand48.3, envz_add.3, errno.3, ether_aton.3, exp10.3, finite.3, flockfile.3, fseeko.3, getcontext.3, getmntent.3, getnetent.3, getprotoent.3, getrpcent.3, getservent.3, iconv_close.3, iconv_open.3, initgroups.3, login.3, longjmp.3, mbsinit.3, memccpy.3, memmem.3, mempcpy.3, offsetof.3, on_exit.3, pow10.3, pthread_cancel.3, pthread_cleanup_push.3, rpc.3, rpmatch.3, setenv.3, setjmp.3, setlogmask.3, sockatmark.3, strfmon.3, strptime.3, strverscmp.3, swab.3, tcgetpgrp.3, tmpfile.3, toascii.3, y0.3, null.4, tty.4, tty_ioctl.4, hosts.equiv.5, environ.7, path_resolution.7, tzselect.8: Convert inline formatting (\fX...\fP) to dot-directive formatting
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-06-07 15:25:32 +00:00
|
|
|
.I xprt\->xp_port
|
2004-11-03 13:51:07 +00:00
|
|
|
is established with the local
|
|
|
|
.B portmap
|
|
|
|
service (generally
|
|
|
|
.I protocol
|
|
|
|
is zero,
|
2007-12-30 15:55:22 +00:00
|
|
|
.B IPPROTO_UDP
|
2007-04-12 22:42:49 +00:00
|
|
|
or
|
2007-12-30 15:55:22 +00:00
|
|
|
.BR IPPROTO_TCP ).
|
2004-11-03 13:51:07 +00:00
|
|
|
The procedure
|
|
|
|
.I dispatch
|
|
|
|
has the following form:
|
2008-01-04 04:22:28 +00:00
|
|
|
.in +4n
|
2004-11-03 13:51:07 +00:00
|
|
|
.nf
|
2008-01-04 04:22:28 +00:00
|
|
|
|
|
|
|
dispatch(struct svc_req *request, SVCXPRT *xprt);
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
2008-01-04 04:22:28 +00:00
|
|
|
.in
|
2004-11-03 13:51:07 +00:00
|
|
|
.IP
|
|
|
|
The
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR svc_register ()
|
2004-11-03 13:51:07 +00:00
|
|
|
routine returns one if it succeeds, and zero otherwise.
|
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.B "void svc_run(void);"
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
2007-04-12 22:42:49 +00:00
|
|
|
This routine never returns.
|
2007-12-30 15:55:22 +00:00
|
|
|
It waits for RPC requests to arrive, and calls the appropriate service
|
2004-11-03 13:51:07 +00:00
|
|
|
procedure using
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR svc_getreq ()
|
2007-04-12 22:42:49 +00:00
|
|
|
when one arrives.
|
|
|
|
This procedure is usually waiting for a
|
2007-06-14 06:25:37 +00:00
|
|
|
.BR select (2)
|
2004-11-03 13:51:07 +00:00
|
|
|
system call to return.
|
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "bool_t svc_sendreply(SVCXPRT *" xprt ", xdrproc_t " outproc \
|
|
|
|
", char *" out );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
2007-12-30 15:55:22 +00:00
|
|
|
Called by an RPC service's dispatch routine to send the results of a
|
2007-04-12 22:42:49 +00:00
|
|
|
remote procedure call.
|
|
|
|
The parameter
|
2004-11-03 13:51:07 +00:00
|
|
|
.I xprt
|
|
|
|
is the request's associated transport handle;
|
|
|
|
.I outproc
|
2007-12-30 15:55:22 +00:00
|
|
|
is the XDR routine which is used to encode the results; and
|
2004-11-03 13:51:07 +00:00
|
|
|
.I out
|
|
|
|
is the address of the results.
|
|
|
|
This routine returns one if it succeeds, zero otherwise.
|
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "void svc_unregister(unsigned long " prognum ", unsigned long " versnum );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
|
|
|
Remove all mapping of the double
|
|
|
|
.RI [ prognum , versnum ]
|
|
|
|
to dispatch routines, and of the triple
|
time.1, _syscall.2, acct.2, getsockname.2, nanosleep.2, pciconfig_read.2, sched_get_priority_max.2, umask.2, uname.2, ustat.2, INFINITY.3, argz_add.3, atexit.3, bsearch.3, byteorder.3, carg.3, closedir.3, dlopen.3, drand48.3, envz_add.3, errno.3, ether_aton.3, exp10.3, finite.3, flockfile.3, fseeko.3, getcontext.3, getmntent.3, getnetent.3, getprotoent.3, getrpcent.3, getservent.3, iconv_close.3, iconv_open.3, initgroups.3, login.3, longjmp.3, mbsinit.3, memccpy.3, memmem.3, mempcpy.3, offsetof.3, on_exit.3, pow10.3, pthread_cancel.3, pthread_cleanup_push.3, rpc.3, rpmatch.3, setenv.3, setjmp.3, setlogmask.3, sockatmark.3, strfmon.3, strptime.3, strverscmp.3, swab.3, tcgetpgrp.3, tmpfile.3, toascii.3, y0.3, null.4, tty.4, tty_ioctl.4, hosts.equiv.5, environ.7, path_resolution.7, tzselect.8: Convert inline formatting (\fX...\fP) to dot-directive formatting
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-06-07 15:25:32 +00:00
|
|
|
.RI [ prognum , versnum , * ]
|
2004-11-03 13:51:07 +00:00
|
|
|
to port number.
|
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "void svcerr_auth(SVCXPRT *" xprt ", enum auth_stat " why );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
|
|
|
Called by a service dispatch routine that refuses to perform
|
|
|
|
a remote procedure call due to an authentication error.
|
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "void svcerr_decode(SVCXPRT *" xprt );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
|
|
|
Called by a service dispatch routine that cannot successfully
|
2007-04-12 22:42:49 +00:00
|
|
|
decode its parameters.
|
|
|
|
See also
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR svc_getargs ().
|
2004-11-03 13:51:07 +00:00
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "void svcerr_noproc(SVCXPRT *" xprt );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
|
|
|
Called by a service dispatch routine that does not implement
|
|
|
|
the procedure number that the caller requests.
|
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "void svcerr_noprog(SVCXPRT *" xprt );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
2007-12-30 15:55:22 +00:00
|
|
|
Called when the desired program is not registered with the RPC package.
|
2007-04-12 22:42:49 +00:00
|
|
|
Service implementors usually do not need this routine.
|
2004-11-03 13:51:07 +00:00
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "void svcerr_progvers(SVCXPRT *" xprt );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
|
|
|
Called when the desired version of a program is not registered
|
2007-12-30 15:55:22 +00:00
|
|
|
with the RPC package.
|
2007-04-12 22:42:49 +00:00
|
|
|
Service implementors usually do not need this routine.
|
2004-11-03 13:51:07 +00:00
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "void svcerr_systemerr(SVCXPRT *" xprt );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
|
|
|
Called by a service dispatch routine when it detects a system
|
2007-12-30 15:55:22 +00:00
|
|
|
error not covered by any particular protocol.
|
2004-11-03 13:51:07 +00:00
|
|
|
For example, if a service can no longer allocate storage,
|
|
|
|
it may call this routine.
|
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "void svcerr_weakauth(SVCXPRT *" xprt );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
|
|
|
Called by a service dispatch routine that refuses to perform
|
2007-12-30 15:55:22 +00:00
|
|
|
a remote procedure call due to insufficient authentication parameters.
|
2007-04-12 22:42:49 +00:00
|
|
|
The routine calls
|
2007-12-16 15:39:37 +00:00
|
|
|
.BR "svcerr_auth(xprt, AUTH_TOOWEAK)" .
|
2004-11-03 13:51:07 +00:00
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "SVCXPRT *svcfd_create(int " fd ", unsigned int " sendsize ,
|
|
|
|
.BI " unsigned int " recvsize );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
2007-04-12 22:42:49 +00:00
|
|
|
Create a service on top of any open descriptor.
|
|
|
|
Typically, this descriptor is a connected socket for a stream protocol such
|
2007-12-30 15:55:22 +00:00
|
|
|
as TCP.
|
2004-11-03 13:51:07 +00:00
|
|
|
.I sendsize
|
|
|
|
and
|
|
|
|
.I recvsize
|
2007-04-12 22:42:49 +00:00
|
|
|
indicate sizes for the send and receive buffers.
|
2007-12-30 15:55:22 +00:00
|
|
|
If they are zero, a reasonable default is chosen.
|
2004-11-03 13:51:07 +00:00
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "SVCXPRT *svcraw_create(void);"
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
2007-12-30 15:55:22 +00:00
|
|
|
This routine creates a toy RPC
|
2007-04-12 22:42:49 +00:00
|
|
|
service transport, to which it returns a pointer.
|
|
|
|
The transport is really a buffer within the process's address space,
|
2007-12-30 15:55:22 +00:00
|
|
|
so the corresponding RPC client should live in the same address space; see
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR clntraw_create ().
|
2007-12-30 15:55:22 +00:00
|
|
|
This routine allows simulation of RPC and acquisition of RPC
|
|
|
|
overheads (such as round trip times), without any kernel interference.
|
|
|
|
This routine returns NULL if it fails.
|
2004-11-03 13:51:07 +00:00
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "SVCXPRT *svctcp_create(int " sock ", unsigned int " send_buf_size ,
|
|
|
|
.BI " unsigned int " recv_buf_size );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
2007-12-30 15:55:22 +00:00
|
|
|
This routine creates a TCP/IP-based RPC
|
2004-11-03 13:51:07 +00:00
|
|
|
service transport, to which it returns a pointer.
|
|
|
|
The transport is associated with the socket
|
|
|
|
.IR sock ,
|
|
|
|
which may be
|
2007-12-16 15:39:37 +00:00
|
|
|
.BR RPC_ANYSOCK ,
|
2004-11-03 13:51:07 +00:00
|
|
|
in which case a new socket is created.
|
2007-12-30 15:55:22 +00:00
|
|
|
If the socket is not bound to a local TCP
|
2007-04-12 22:42:49 +00:00
|
|
|
port, then this routine binds it to an arbitrary port.
|
|
|
|
Upon completion,
|
time.1, _syscall.2, acct.2, getsockname.2, nanosleep.2, pciconfig_read.2, sched_get_priority_max.2, umask.2, uname.2, ustat.2, INFINITY.3, argz_add.3, atexit.3, bsearch.3, byteorder.3, carg.3, closedir.3, dlopen.3, drand48.3, envz_add.3, errno.3, ether_aton.3, exp10.3, finite.3, flockfile.3, fseeko.3, getcontext.3, getmntent.3, getnetent.3, getprotoent.3, getrpcent.3, getservent.3, iconv_close.3, iconv_open.3, initgroups.3, login.3, longjmp.3, mbsinit.3, memccpy.3, memmem.3, mempcpy.3, offsetof.3, on_exit.3, pow10.3, pthread_cancel.3, pthread_cleanup_push.3, rpc.3, rpmatch.3, setenv.3, setjmp.3, setlogmask.3, sockatmark.3, strfmon.3, strptime.3, strverscmp.3, swab.3, tcgetpgrp.3, tmpfile.3, toascii.3, y0.3, null.4, tty.4, tty_ioctl.4, hosts.equiv.5, environ.7, path_resolution.7, tzselect.8: Convert inline formatting (\fX...\fP) to dot-directive formatting
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-06-07 15:25:32 +00:00
|
|
|
.I xprt\->xp_sock
|
2004-11-03 13:51:07 +00:00
|
|
|
is the transport's socket descriptor, and
|
time.1, _syscall.2, acct.2, getsockname.2, nanosleep.2, pciconfig_read.2, sched_get_priority_max.2, umask.2, uname.2, ustat.2, INFINITY.3, argz_add.3, atexit.3, bsearch.3, byteorder.3, carg.3, closedir.3, dlopen.3, drand48.3, envz_add.3, errno.3, ether_aton.3, exp10.3, finite.3, flockfile.3, fseeko.3, getcontext.3, getmntent.3, getnetent.3, getprotoent.3, getrpcent.3, getservent.3, iconv_close.3, iconv_open.3, initgroups.3, login.3, longjmp.3, mbsinit.3, memccpy.3, memmem.3, mempcpy.3, offsetof.3, on_exit.3, pow10.3, pthread_cancel.3, pthread_cleanup_push.3, rpc.3, rpmatch.3, setenv.3, setjmp.3, setlogmask.3, sockatmark.3, strfmon.3, strptime.3, strverscmp.3, swab.3, tcgetpgrp.3, tmpfile.3, toascii.3, y0.3, null.4, tty.4, tty_ioctl.4, hosts.equiv.5, environ.7, path_resolution.7, tzselect.8: Convert inline formatting (\fX...\fP) to dot-directive formatting
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-06-07 15:25:32 +00:00
|
|
|
.I xprt\->xp_port
|
2004-11-03 13:51:07 +00:00
|
|
|
is the transport's port number.
|
2007-12-30 15:55:22 +00:00
|
|
|
This routine returns NULL if it fails.
|
|
|
|
Since TCP-based RPC uses buffered I/O,
|
2004-11-03 13:51:07 +00:00
|
|
|
users may specify the size of buffers; values of zero
|
|
|
|
choose suitable defaults.
|
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "SVCXPRT *svcudp_bufcreate(int " sock ", unsigned int " sendsize ,
|
|
|
|
.BI " unsigned int " recosize );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
2007-12-30 15:55:22 +00:00
|
|
|
This routine creates a UDP/IP-based RPC
|
2004-11-03 13:51:07 +00:00
|
|
|
service transport, to which it returns a pointer.
|
|
|
|
The transport is associated with the socket
|
|
|
|
.IR sock ,
|
|
|
|
which may be
|
2007-12-16 15:39:37 +00:00
|
|
|
.BR RPC_ANYSOCK ,
|
2004-11-03 13:51:07 +00:00
|
|
|
in which case a new socket is created.
|
2007-12-30 15:55:22 +00:00
|
|
|
If the socket is not bound to a local UDP
|
2007-04-12 22:42:49 +00:00
|
|
|
port, then this routine binds it to an arbitrary port.
|
|
|
|
Upon completion,
|
time.1, _syscall.2, acct.2, getsockname.2, nanosleep.2, pciconfig_read.2, sched_get_priority_max.2, umask.2, uname.2, ustat.2, INFINITY.3, argz_add.3, atexit.3, bsearch.3, byteorder.3, carg.3, closedir.3, dlopen.3, drand48.3, envz_add.3, errno.3, ether_aton.3, exp10.3, finite.3, flockfile.3, fseeko.3, getcontext.3, getmntent.3, getnetent.3, getprotoent.3, getrpcent.3, getservent.3, iconv_close.3, iconv_open.3, initgroups.3, login.3, longjmp.3, mbsinit.3, memccpy.3, memmem.3, mempcpy.3, offsetof.3, on_exit.3, pow10.3, pthread_cancel.3, pthread_cleanup_push.3, rpc.3, rpmatch.3, setenv.3, setjmp.3, setlogmask.3, sockatmark.3, strfmon.3, strptime.3, strverscmp.3, swab.3, tcgetpgrp.3, tmpfile.3, toascii.3, y0.3, null.4, tty.4, tty_ioctl.4, hosts.equiv.5, environ.7, path_resolution.7, tzselect.8: Convert inline formatting (\fX...\fP) to dot-directive formatting
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-06-07 15:25:32 +00:00
|
|
|
.I xprt\->xp_sock
|
2004-11-03 13:51:07 +00:00
|
|
|
is the transport's socket descriptor, and
|
time.1, _syscall.2, acct.2, getsockname.2, nanosleep.2, pciconfig_read.2, sched_get_priority_max.2, umask.2, uname.2, ustat.2, INFINITY.3, argz_add.3, atexit.3, bsearch.3, byteorder.3, carg.3, closedir.3, dlopen.3, drand48.3, envz_add.3, errno.3, ether_aton.3, exp10.3, finite.3, flockfile.3, fseeko.3, getcontext.3, getmntent.3, getnetent.3, getprotoent.3, getrpcent.3, getservent.3, iconv_close.3, iconv_open.3, initgroups.3, login.3, longjmp.3, mbsinit.3, memccpy.3, memmem.3, mempcpy.3, offsetof.3, on_exit.3, pow10.3, pthread_cancel.3, pthread_cleanup_push.3, rpc.3, rpmatch.3, setenv.3, setjmp.3, setlogmask.3, sockatmark.3, strfmon.3, strptime.3, strverscmp.3, swab.3, tcgetpgrp.3, tmpfile.3, toascii.3, y0.3, null.4, tty.4, tty_ioctl.4, hosts.equiv.5, environ.7, path_resolution.7, tzselect.8: Convert inline formatting (\fX...\fP) to dot-directive formatting
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-06-07 15:25:32 +00:00
|
|
|
.I xprt\->xp_port
|
2004-11-03 13:51:07 +00:00
|
|
|
is the transport's port number.
|
2007-12-30 15:55:22 +00:00
|
|
|
This routine returns NULL if it fails.
|
2004-11-03 13:51:07 +00:00
|
|
|
.IP
|
2007-04-12 22:42:49 +00:00
|
|
|
This allows the user to specify the maximum packet size for sending and
|
2007-12-30 15:55:22 +00:00
|
|
|
receiving UDP-based RPC messages.
|
2004-11-03 13:51:07 +00:00
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "SVCXPRT *svcudp_create(int " sock );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
|
|
|
This call is equivalent to
|
time.1, _syscall.2, acct.2, getsockname.2, nanosleep.2, pciconfig_read.2, sched_get_priority_max.2, umask.2, uname.2, ustat.2, INFINITY.3, argz_add.3, atexit.3, bsearch.3, byteorder.3, carg.3, closedir.3, dlopen.3, drand48.3, envz_add.3, errno.3, ether_aton.3, exp10.3, finite.3, flockfile.3, fseeko.3, getcontext.3, getmntent.3, getnetent.3, getprotoent.3, getrpcent.3, getservent.3, iconv_close.3, iconv_open.3, initgroups.3, login.3, longjmp.3, mbsinit.3, memccpy.3, memmem.3, mempcpy.3, offsetof.3, on_exit.3, pow10.3, pthread_cancel.3, pthread_cleanup_push.3, rpc.3, rpmatch.3, setenv.3, setjmp.3, setlogmask.3, sockatmark.3, strfmon.3, strptime.3, strverscmp.3, swab.3, tcgetpgrp.3, tmpfile.3, toascii.3, y0.3, null.4, tty.4, tty_ioctl.4, hosts.equiv.5, environ.7, path_resolution.7, tzselect.8: Convert inline formatting (\fX...\fP) to dot-directive formatting
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-06-07 15:25:32 +00:00
|
|
|
.I svcudp_bufcreate(sock,SZ,SZ)
|
|
|
|
for some default size
|
|
|
|
.IR SZ .
|
2004-11-03 13:51:07 +00:00
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "bool_t xdr_accepted_reply(XDR *" xdrs ", struct accepted_reply *" ar );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
2007-12-30 15:55:22 +00:00
|
|
|
Used for encoding RPC reply messages.
|
2007-04-12 22:42:49 +00:00
|
|
|
This routine is useful for users who wish to generate
|
2007-12-30 15:55:22 +00:00
|
|
|
RPC-style messages without using the RPC package.
|
2004-11-03 13:51:07 +00:00
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "bool_t xdr_authunix_parms(XDR *" xdrs ", struct authunix_parms *" aupp );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
intro.1, time.1, accept.2, bind.2, connect.2, execve.2, flock.2, getdents.2, getpriority.2, getuid.2, intro.2, ioctl.2, mincore.2, mknod.2, personality.2, ptrace.2, read.2, recv.2, select_tut.2, send.2, sendfile.2, shmctl.2, sigaction.2, signal.2, stat.2, times.2, truncate.2, umask.2, wait.2, MB_CUR_MAX.3, MB_LEN_MAX.3, argz_add.3, btowc.3, clearenv.3, clock.3, cmsg.3, end.3, endian.3, errno.3, exit.3, fgetwc.3, fgetws.3, fopen.3, fputwc.3, fputws.3, fseek.3, fwide.3, getfsent.3, getgrnam.3, gethostid.3, getipnodebyname.3, getmntent.3, getpwnam.3, getwchar.3, grantpt.3, iconv.3, iconv_close.3, iconv_open.3, insque.3, intro.3, iswalnum.3, iswalpha.3, iswblank.3, iswcntrl.3, iswctype.3, iswdigit.3, iswgraph.3, iswlower.3, iswprint.3, iswpunct.3, iswspace.3, iswupper.3, iswxdigit.3, malloc.3, mblen.3, mbrlen.3, mbrtowc.3, mbsinit.3, mbsnrtowcs.3, mbsrtowcs.3, mbstowcs.3, mbtowc.3, mkstemp.3, mktemp.3, nl_langinfo.3, openpty.3, posix_openpt.3, printf.3, ptsname.3, putwchar.3, qecvt.3, rcmd.3, readdir.3, rexec.3, rpc.3, setnetgrent.3, shm_open.3, sigpause.3, stdin.3, stpcpy.3, strftime.3, strptime.3, syslog.3, towctrans.3, towlower.3, towupper.3, ttyslot.3, ungetwc.3, unlocked_stdio.3, wcpcpy.3, wcpncpy.3, wcrtomb.3, wcscasecmp.3, wcscat.3, wcschr.3, wcscmp.3, wcscpy.3, wcscspn.3, wcsdup.3, wcslen.3, wcsncasecmp.3, wcsncat.3, wcsncmp.3, wcsncpy.3, wcsnlen.3, wcsnrtombs.3, wcspbrk.3, wcsrchr.3, wcsrtombs.3, wcsspn.3, wcsstr.3, wcstok.3, wcstombs.3, wcswidth.3, wctob.3, wctomb.3, wctrans.3, wctype.3, wcwidth.3, wmemchr.3, wmemcmp.3, wmemcpy.3, wmemmove.3, wmemset.3, wprintf.3, console_ioctl.4, pts.4, elf.5, filesystems.5, hosts.5, proc.5, ttytype.5, boot.7, capabilities.7, credentials.7, epoll.7, glob.7, koi8-r.7, path_resolution.7, pty.7, signal.7, suffixes.7, time.7, unicode.7, unix.7, uri.7, utf-8.7: global fix: s/Unix/UNIX/
The man pages were rather inconsistent in the use of "Unix"
versus "UNIX". Let's go with the trademark usage.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-10-12 04:45:38 +00:00
|
|
|
Used for describing UNIX credentials.
|
2007-04-12 22:42:49 +00:00
|
|
|
This routine is useful for users
|
2007-12-30 15:55:22 +00:00
|
|
|
who wish to generate these credentials without using the RPC
|
2004-11-03 13:51:07 +00:00
|
|
|
authentication package.
|
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "void xdr_callhdr(XDR *" xdrs ", struct rpc_msg *" chdr );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
2007-12-30 15:55:22 +00:00
|
|
|
Used for describing RPC call header messages.
|
2004-11-03 13:51:07 +00:00
|
|
|
This routine is useful for users who wish to generate
|
2007-12-30 15:55:22 +00:00
|
|
|
RPC-style messages without using the RPC package.
|
2004-11-03 13:51:07 +00:00
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "bool_t xdr_callmsg(XDR *" xdrs ", struct rpc_msg *" cmsg );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
2007-12-30 15:55:22 +00:00
|
|
|
Used for describing RPC call messages.
|
|
|
|
This routine is useful for users who wish to generate RPC-style
|
|
|
|
messages without using the RPC package.
|
2004-11-03 13:51:07 +00:00
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "bool_t xdr_opaque_auth(XDR *" xdrs ", struct opaque_auth *" ap );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
2007-12-30 15:55:22 +00:00
|
|
|
Used for describing RPC authentication information messages.
|
2004-11-03 13:51:07 +00:00
|
|
|
This routine is useful for users who wish to generate
|
2007-12-30 15:55:22 +00:00
|
|
|
RPC-style messages without using the RPC package.
|
2004-11-03 13:51:07 +00:00
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "bool_t xdr_pmap(XDR *" xdrs ", struct pmap *" regs );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
|
|
|
Used for describing parameters to various
|
|
|
|
.B portmap
|
|
|
|
procedures, externally.
|
|
|
|
This routine is useful for users who wish to generate
|
|
|
|
these parameters without using the
|
|
|
|
.B pmap
|
|
|
|
interface.
|
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "bool_t xdr_pmaplist(XDR *" xdrs ", struct pmaplist **" rp );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
|
|
|
Used for describing a list of port mappings, externally.
|
|
|
|
This routine is useful for users who wish to generate
|
|
|
|
these parameters without using the
|
|
|
|
.B pmap
|
|
|
|
interface.
|
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "bool_t xdr_rejected_reply(XDR *" xdrs ", struct rejected_reply *" rr );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
2007-12-30 15:55:22 +00:00
|
|
|
Used for describing RPC reply messages.
|
2004-11-03 13:51:07 +00:00
|
|
|
This routine is useful for users who wish to generate
|
2007-12-30 15:55:22 +00:00
|
|
|
RPC-style messages without using the RPC package.
|
2004-11-03 13:51:07 +00:00
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "bool_t xdr_replymsg(XDR *" xdrs ", struct rpc_msg *" rmsg );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
2007-12-30 15:55:22 +00:00
|
|
|
Used for describing RPC reply messages.
|
2004-11-03 13:51:07 +00:00
|
|
|
This routine is useful for users who wish to generate
|
2007-12-30 15:55:22 +00:00
|
|
|
RPC style messages without using the RPC package.
|
2004-11-03 13:51:07 +00:00
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "void xprt_register(SVCXPRT *" xprt );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
2007-12-30 15:55:22 +00:00
|
|
|
After RPC service transport handles are created,
|
|
|
|
they should register themselves with the RPC service package.
|
2004-11-03 13:51:07 +00:00
|
|
|
This routine modifies the global variable
|
2008-09-18 12:30:42 +00:00
|
|
|
.IR svc_fds .
|
2004-11-03 13:51:07 +00:00
|
|
|
Service implementors usually do not need this routine.
|
|
|
|
.LP
|
|
|
|
.nf
|
2007-12-30 15:55:22 +00:00
|
|
|
.BI "void xprt_unregister(SVCXPRT *" xprt );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
|
|
|
.IP
|
2007-12-30 15:55:22 +00:00
|
|
|
Before an RPC service transport handle is destroyed,
|
|
|
|
it should unregister itself with the RPC service package.
|
2004-11-03 13:51:07 +00:00
|
|
|
This routine modifies the global variable
|
2007-12-30 15:55:22 +00:00
|
|
|
.IR svc_fds .
|
2004-11-03 13:51:07 +00:00
|
|
|
Service implementors usually do not need this routine.
|
getent.1, intro.1, time.1, _exit.2, _syscall.2, accept.2, access.2, acct.2, adjtimex.2, alarm.2, alloc_hugepages.2, arch_prctl.2, bdflush.2, bind.2, brk.2, cacheflush.2, capget.2, chdir.2, chmod.2, chown.2, chroot.2, clock_getres.2, clock_nanosleep.2, clone.2, close.2, connect.2, create_module.2, delete_module.2, dup.2, epoll_create.2, epoll_ctl.2, epoll_wait.2, eventfd.2, execve.2, exit_group.2, faccessat.2, fchmodat.2, fchownat.2, fcntl.2, flock.2, fork.2, fstatat.2, fsync.2, futex.2, futimesat.2, get_kernel_syms.2, get_robust_list.2, get_thread_area.2, getcpu.2, getdents.2, getdomainname.2, getgid.2, getgroups.2, gethostname.2, getitimer.2, getpagesize.2, getpeername.2, getpid.2, getpriority.2, getresuid.2, getrlimit.2, getrusage.2, getsid.2, getsockname.2, getsockopt.2, gettid.2, gettimeofday.2, getuid.2, getunwind.2, getxattr.2, idle.2, init_module.2, inotify_add_watch.2, inotify_init.2, inotify_rm_watch.2, intro.2, io_cancel.2, io_destroy.2, io_getevents.2, io_setup.2, io_submit.2, ioctl.2, ioctl_list.2, ioperm.2, iopl.2, ioprio_set.2, ipc.2, kcmp.2, kill.2, killpg.2, link.2, linkat.2, listen.2, listxattr.2, llseek.2, lookup_dcookie.2, lseek.2, madvise.2, migrate_pages.2, mincore.2, mkdir.2, mkdirat.2, mknod.2, mknodat.2, mlock.2, mmap.2, mmap2.2, modify_ldt.2, mount.2, move_pages.2, mprotect.2, mq_getsetattr.2, mremap.2, msgctl.2, msgget.2, msgop.2, msync.2, nanosleep.2, nfsservctl.2, nice.2, open.2, openat.2, outb.2, pause.2, pciconfig_read.2, perf_event_open.2, perfmonctl.2, personality.2, pipe.2, pivot_root.2, poll.2, posix_fadvise.2, prctl.2, pread.2, process_vm_readv.2, ptrace.2, query_module.2, quotactl.2, read.2, readahead.2, readdir.2, readlink.2, readlinkat.2, readv.2, reboot.2, recv.2, remap_file_pages.2, removexattr.2, rename.2, renameat.2, rmdir.2, rt_sigqueueinfo.2, sched_get_priority_max.2, sched_rr_get_interval.2, sched_setaffinity.2, sched_setparam.2, sched_setscheduler.2, sched_yield.2, select.2, semctl.2, semget.2, semop.2, send.2, sendfile.2, set_thread_area.2, set_tid_address.2, seteuid.2, setfsgid.2, setfsuid.2, setgid.2, setpgid.2, setresuid.2, setreuid.2, setsid.2, setuid.2, setup.2, setxattr.2, shmctl.2, shmget.2, shmop.2, shutdown.2, sigaction.2, sigaltstack.2, signal.2, signalfd.2, sigpending.2, sigprocmask.2, sigreturn.2, sigsuspend.2, sigwaitinfo.2, socket.2, socketcall.2, socketpair.2, splice.2, stat.2, statfs.2, stime.2, swapon.2, symlink.2, symlinkat.2, sync.2, sync_file_range.2, sysctl.2, sysfs.2, sysinfo.2, syslog.2, tee.2, time.2, timerfd_create.2, times.2, tkill.2, truncate.2, umask.2, umount.2, uname.2, unimplemented.2, unlink.2, unlinkat.2, uselib.2, ustat.2, utime.2, utimensat.2, vfork.2, vhangup.2, vm86.2, vmsplice.2, wait.2, wait4.2, write.2, CPU_SET.3, INFINITY.3, MB_CUR_MAX.3, MB_LEN_MAX.3, __setfpucw.3, a64l.3, abort.3, abs.3, acos.3, acosh.3, addseverity.3, adjtime.3, aio_cancel.3, aio_error.3, aio_fsync.3, aio_read.3, aio_return.3, aio_suspend.3, aio_write.3, alloca.3, argz_add.3, asin.3, asinh.3, asprintf.3, assert.3, assert_perror.3, atan.3, atan2.3, atanh.3, atexit.3, atof.3, atoi.3, backtrace.3, basename.3, bcmp.3, bcopy.3, bindresvport.3, bsd_signal.3, bsearch.3, bstring.3, btowc.3, btree.3, byteorder.3, bzero.3, cabs.3, cacos.3, cacosh.3, canonicalize_file_name.3, carg.3, casin.3, casinh.3, catan.3, catanh.3, catgets.3, catopen.3, cbrt.3, ccos.3, ccosh.3, ceil.3, cerf.3, cexp.3, cexp2.3, cfree.3, cimag.3, clearenv.3, clock.3, clock_getcpuclockid.3, clog.3, clog10.3, clog2.3, closedir.3, cmsg.3, confstr.3, conj.3, copysign.3, cos.3, cosh.3, cpow.3, cproj.3, creal.3, crypt.3, csin.3, csinh.3, csqrt.3, ctan.3, ctanh.3, ctermid.3, ctime.3, daemon.3, dbopen.3, des_crypt.3, difftime.3, dirfd.3, div.3, dl_iterate_phdr.3, dlopen.3, dprintf.3, drand48.3, drand48_r.3, dysize.3, ecvt.3, ecvt_r.3, encrypt.3, end.3, endian.3, envz_add.3, erf.3, erfc.3, err.3, errno.3, error.3, ether_aton.3, euidaccess.3, exec.3, exit.3, exp.3, exp10.3, exp2.3, expm1.3, fabs.3, fclose.3, fcloseall.3, fdim.3, fenv.3, ferror.3, fexecve.3, fflush.3, ffs.3, fgetgrent.3, fgetpwent.3, fgetwc.3, fgetws.3, finite.3, flockfile.3, floor.3, fma.3, fmax.3, fmemopen.3, fmin.3, fmod.3, fmtmsg.3, fnmatch.3, fopen.3, fpathconf.3, fpclassify.3, fpurge.3, fputwc.3, fputws.3, fread.3, frexp.3, fseek.3, fseeko.3, ftime.3, ftok.3, fts.3, ftw.3, futimes.3, fwide.3, gamma.3, gcvt.3, getaddrinfo.3, getaddrinfo_a.3, getauxval.3, getcontext.3, getcwd.3, getdate.3, getdirentries.3, getdtablesize.3, getenv.3, getfsent.3, getgrent.3, getgrent_r.3, getgrnam.3, getgrouplist.3, gethostbyname.3, gethostid.3, getipnodebyname.3, getline.3, getloadavg.3, getlogin.3, getmntent.3, getnameinfo.3, getnetent.3, getnetent_r.3, getopt.3, getpass.3, getprotoent.3, getprotoent_r.3, getpt.3, getpw.3, getpwent.3, getpwent_r.3, getpwnam.3, getrpcent.3, getrpcent_r.3, getrpcport.3, gets.3, getservent.3, getservent_r.3, getspnam.3, getttyent.3, getumask.3, getusershell.3, getutent.3, getw.3, getwchar.3, glob.3, grantpt.3, gsignal.3, hash.3, hsearch.3, hypot.3, iconv.3, iconv_close.3, iconv_open.3, ilogb.3, index.3, inet.3, inet_ntop.3, inet_pton.3, infnan.3, initgroups.3, insque.3, intro.3, isalpha.3, isatty.3, isgreater.3, iswalnum.3, iswalpha.3, iswblank.3, iswcntrl.3, iswctype.3, iswdigit.3, iswgraph.3, iswlower.3, iswprint.3, iswpunct.3, iswspace.3, iswupper.3, iswxdigit.3, j0.3, key_setsecret.3, ldexp.3, lgamma.3, lio_listio.3, localeconv.3, lockf.3, log.3, log10.3, log1p.3, log2.3, logb.3, login.3, longjmp.3, lrint.3, lround.3, lsearch.3, lseek64.3, makecontext.3, makedev.3, malloc.3, malloc_hook.3, mblen.3, mbrlen.3, mbrtowc.3, mbsinit.3, mbsnrtowcs.3, mbsrtowcs.3, mbstowcs.3, mbtowc.3, memccpy.3, memchr.3, memcmp.3, memcpy.3, memfrob.3, memmem.3, memmove.3, mempcpy.3, memset.3, mkdtemp.3, mkfifo.3, mkfifoat.3, mkstemp.3, mktemp.3, modf.3, mpool.3, mq_close.3, mq_getattr.3, mq_notify.3, mq_open.3, mq_receive.3, mq_send.3, mq_unlink.3, mtrace.3, nan.3, netlink.3, nextafter.3, nl_langinfo.3, offsetof.3, on_exit.3, opendir.3, openpty.3, perror.3, popen.3, posix_fallocate.3, posix_memalign.3, posix_openpt.3, pow.3, pow10.3, printf.3, profil.3, program_invocation_name.3, psignal.3, pthread_kill_other_threads_np.3, ptsname.3, putenv.3, putgrent.3, putpwent.3, puts.3, putwchar.3, qecvt.3, qsort.3, queue.3, raise.3, rand.3, random.3, random_r.3, rcmd.3, re_comp.3, readdir.3, realpath.3, recno.3, regex.3, remainder.3, remove.3, remquo.3, resolver.3, rewinddir.3, rexec.3, rint.3, round.3, rpc.3, rpmatch.3, rtime.3, rtnetlink.3, scalb.3, scalbln.3, scandir.3, scandirat.3, scanf.3, seekdir.3, sem_close.3, sem_destroy.3, sem_getvalue.3, sem_init.3, sem_open.3, sem_post.3, sem_unlink.3, sem_wait.3, setaliasent.3, setbuf.3, setenv.3, setjmp.3, setlocale.3, setlogmask.3, setnetgrent.3, shm_open.3, siginterrupt.3, signbit.3, significand.3, sigpause.3, sigqueue.3, sigset.3, sigsetops.3, sigvec.3, sin.3, sincos.3, sinh.3, sleep.3, sockatmark.3, sqrt.3, statvfs.3, stdarg.3, stdin.3, stdio.3, stdio_ext.3, stpcpy.3, stpncpy.3, strcasecmp.3, strcat.3, strchr.3, strcmp.3, strcoll.3, strcpy.3, strdup.3, strerror.3, strfmon.3, strfry.3, strftime.3, string.3, strlen.3, strnlen.3, strpbrk.3, strptime.3, strsep.3, strsignal.3, strspn.3, strstr.3, strtod.3, strtoimax.3, strtok.3, strtol.3, strtoul.3, strverscmp.3, strxfrm.3, swab.3, sysconf.3, syslog.3, system.3, sysv_signal.3, tan.3, tanh.3, tcgetpgrp.3, tcgetsid.3, telldir.3, tempnam.3, termios.3, tgamma.3, timegm.3, timeradd.3, tmpfile.3, tmpnam.3, toascii.3, toupper.3, towctrans.3, towlower.3, towupper.3, trunc.3, tsearch.3, ttyname.3, ttyslot.3, tzset.3, ualarm.3, ulimit.3, ungetwc.3, unlocked_stdio.3, unlockpt.3, updwtmp.3, usleep.3, wcpcpy.3, wcpncpy.3, wcrtomb.3, wcscasecmp.3, wcscat.3, wcschr.3, wcscmp.3, wcscpy.3, wcscspn.3, wcsdup.3, wcslen.3, wcsncasecmp.3, wcsncat.3, wcsncmp.3, wcsncpy.3, wcsnlen.3, wcsnrtombs.3, wcspbrk.3, wcsrchr.3, wcsrtombs.3, wcsspn.3, wcsstr.3, wcstoimax.3, wcstok.3, wcstombs.3, wcswidth.3, wctob.3, wctomb.3, wctrans.3, wctype.3, wcwidth.3, wmemchr.3, wmemcmp.3, wmemcpy.3, wmemmove.3, wmemset.3, wordexp.3, wprintf.3, xcrypt.3, xdr.3, y0.3, cciss.4, console.4, console_codes.4, console_ioctl.4, dsp56k.4, fd.4, full.4, hd.4, hpsa.4, initrd.4, intro.4, lp.4, mem.4, mouse.4, null.4, pts.4, ram.4, random.4, rtc.4, sk98lin.4, st.4, tty.4, ttyS.4, tty_ioctl.4, vcs.4, wavelan.4, acct.5, charmap.5, dir_colors.5, filesystems.5, ftpusers.5, group.5, host.conf.5, hosts.5, hosts.equiv.5, intro.5, issue.5, locale.5, motd.5, networks.5, nologin.5, nscd.conf.5, passwd.5, proc.5, protocols.5, resolv.conf.5, rpc.5, securetty.5, services.5, shells.5, termcap.5, ttytype.5, utmp.5, armscii-8.7, arp.7, ascii.7, bootparam.7, capabilities.7, charsets.7, complex.7, cp1251.7, credentials.7, ddp.7, environ.7, epoll.7, fifo.7, futex.7, glob.7, hier.7, icmp.7, inotify.7, intro.7, ip.7, ipv6.7, iso_8859-1.7, iso_8859-10.7, iso_8859-11.7, iso_8859-13.7, iso_8859-14.7, iso_8859-15.7, iso_8859-16.7, iso_8859-2.7, iso_8859-3.7, iso_8859-4.7, iso_8859-5.7, iso_8859-6.7, iso_8859-7.7, iso_8859-8.7, iso_8859-9.7, koi8-r.7, koi8-u.7, locale.7, mailaddr.7, man.7, mq_overview.7, netdevice.7, netlink.7, numa.7, packet.7, path_resolution.7, pipe.7, posixoptions.7, pthreads.7, pty.7, raw.7, regex.7, rtld-audit.7, rtnetlink.7, sem_overview.7, shm_overview.7, sigevent.7, signal.7, socket.7, standards.7, suffixes.7, svipc.7, tcp.7, termio.7, time.7, udp.7, udplite.7, unicode.7, unix.7, uri.7, utf-8.7, x25.7, nscd.8, sync.8, tzselect.8, zdump.8, zic.8: Global fix: remove unneeded double quotes in .SH headings
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2013-02-24 18:01:36 +00:00
|
|
|
.SH SEE ALSO
|
2005-09-19 11:39:32 +00:00
|
|
|
.\" We don't have an rpc_secure.3 page in the set at the moment -- MTK, 19 Sep 05
|
|
|
|
.\" .BR rpc_secure (3),
|
2004-11-03 13:51:07 +00:00
|
|
|
.BR xdr (3)
|
arch_prctl.2, fcntl.2, flock.2, get_robust_list.2, getpriority.2, ioprio_set.2, migrate_pages.2, mmap.2, mremap.2, msync.2, sched_get_priority_max.2, sched_rr_get_interval.2, sched_setparam.2, sched_setscheduler.2, sched_yield.2, select.2, socket.2, subpage_prot.2, unshare.2, btree.3, dbopen.3, dl_iterate_phdr.3, dlopen.3, getnameinfo.3, hash.3, lockf.3, netlink.3, recno.3, rpc.3, xdr.3, cciss.4, console_ioctl.4, hpsa.4, initrd.4, msr.4, rtc.4, st.4, hosts.5, services.5, tzfile.5, aio.7, arp.7, capabilities.7, cpuset.7, feature_test_macros.7, futex.7, inotify.7, ip.7, ipv6.7, iso_8859-16.7, iso_8859-2.7, koi8-r.7, math_error.7, netlink.7, packet.7, pthreads.7, raw.7, spufs.7, udplite.7, uri.7, x25.7: Global fix: Various consistency fixes for SEE ALSO
Coauthored-by: Michael Kerrisk <mtk.manpages@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2012-09-24 07:53:22 +00:00
|
|
|
|
2004-11-03 13:51:07 +00:00
|
|
|
The following manuals:
|
|
|
|
.RS
|
|
|
|
Remote Procedure Calls: Protocol Specification
|
|
|
|
.br
|
|
|
|
Remote Procedure Call Programming Guide
|
|
|
|
.br
|
|
|
|
rpcgen Programming Guide
|
|
|
|
.br
|
|
|
|
.RE
|
arch_prctl.2, fcntl.2, flock.2, get_robust_list.2, getpriority.2, ioprio_set.2, migrate_pages.2, mmap.2, mremap.2, msync.2, sched_get_priority_max.2, sched_rr_get_interval.2, sched_setparam.2, sched_setscheduler.2, sched_yield.2, select.2, socket.2, subpage_prot.2, unshare.2, btree.3, dbopen.3, dl_iterate_phdr.3, dlopen.3, getnameinfo.3, hash.3, lockf.3, netlink.3, recno.3, rpc.3, xdr.3, cciss.4, console_ioctl.4, hpsa.4, initrd.4, msr.4, rtc.4, st.4, hosts.5, services.5, tzfile.5, aio.7, arp.7, capabilities.7, cpuset.7, feature_test_macros.7, futex.7, inotify.7, ip.7, ipv6.7, iso_8859-16.7, iso_8859-2.7, koi8-r.7, math_error.7, netlink.7, packet.7, pthreads.7, raw.7, spufs.7, udplite.7, uri.7, x25.7: Global fix: Various consistency fixes for SEE ALSO
Coauthored-by: Michael Kerrisk <mtk.manpages@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2012-09-24 07:53:22 +00:00
|
|
|
|
2007-12-16 15:39:37 +00:00
|
|
|
.IR "RPC: Remote Procedure Call Protocol Specification" ,
|
2007-12-24 16:10:29 +00:00
|
|
|
RFC\ 1050, Sun Microsystems, Inc.,
|
|
|
|
USC-ISI.
|