xref: /openbsd/lib/libc/rpc/getrpcport.3 (revision 09467b48)
1.\"	$OpenBSD: getrpcport.3,v 1.10 2013/06/05 03:39:23 tedu Exp $
2.\"
3.\" Copyright (c) 2010, Oracle America, Inc.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions are
7.\" met:
8.\"
9.\"     * Redistributions of source code must retain the above copyright
10.\"       notice, this list of conditions and the following disclaimer.
11.\"     * Redistributions in binary form must reproduce the above
12.\"       copyright notice, this list of conditions and the following
13.\"       disclaimer in the documentation and/or other materials
14.\"       provided with the distribution.
15.\"     * Neither the name of the "Oracle America, Inc." nor the names of its
16.\"       contributors may be used to endorse or promote products derived
17.\"       from this software without specific prior written permission.
18.\"
19.\"   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20.\"   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21.\"   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
22.\"   FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
23.\"   COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
24.\"   INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\"   DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
26.\"   GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27.\"   INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28.\"   WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29.\"   NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30.\"   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31.\"
32.Dd $Mdocdate: June 5 2013 $
33.Dt GETRPCPORT 3
34.Os
35.Sh NAME
36.Nm getrpcport
37.Nd get RPC port number
38.Sh SYNOPSIS
39.In rpc/rpc.h
40.Ft int
41.Fn getrpcport "char *host" "int prognum" "int versnum" "int proto"
42.Sh DESCRIPTION
43.Fn getrpcport
44returns the port number for version
45.Fa versnum
46of the RPC program
47.Fa prognum
48running on
49.Fa host
50and using protocol
51.Fa proto .
52It returns 0 if it cannot contact the portmapper, or if
53.Fa prognum
54is not registered.
55If
56.Fa prognum
57is registered but not with version
58.Fa versnum ,
59it will still return a port number (for some version of the program)
60indicating that the program is indeed registered.
61The version mismatch will be detected upon the first call to the service.
62