friedkiwi/ibm-information-center
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
14ed2849c6
ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/rpcb_set.htm

291 lines
7.3 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
<title>rpcb_set()--Register the Server Address with the RPCBind</title>
<!-- Begin Header Records ========================================== -->
<!-- All rights reserved. Licensed Materials Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<!-- RPCMST SCRIPT A converted by B2H R4.1 (346) (CMS) by PMHALL at -->
<!-- RCHVMW2 on 7 Oct 1998 at 23:43:14 -->
<!-- Edited by Kersten Feb 02 -->
<!--End Header Records -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<!-- Java sync-link -->
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript">
</script>
<a name="Top_Of_Page"></a>
<h2>rpcb_set()--Register the Server Address with the RPCBind</h2>
<div class="box" style="width: 60%;">
<br>
&nbsp;&nbsp;Syntax<br>
<!-- iddvc RMBR -->
<br>
<pre>
#include &lt;rpc/rpc.h&gt;
#include &lt;netconfig.h&gt;
bool_t rpcb_set(const u_long <em>prognum</em>,
const u_long <em>versnum</em>,
const struct netconfig *<em>netconf</em>,
const struct netbuf *<em>svcaddr</em>);
</pre>
<br>
&nbsp;&nbsp;Service Program Name: QZNFTRPC<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The <strong>rpcb_set()</strong> function is an interface to the RPC service
package (RPCBind) daemon. The function establishes a mapping between the triple
(<em>prognum, versnum, netconf-&gt;nc_netid</em>) and <em>svcaddr</em> on the
machine's <em>RPCBind</em> service. The value of <em>netconf-&gt;nc_netid</em>
must correspond to a network identifier that is defined by the netconfig
database.</p>
<br>
<h3>Parameters</h3>
<dl>
<dt><strong>prognum</strong> &nbsp;(Input)&nbsp;</dt>
<dd>The program number of the remote program.<br>
<br>
</dd>
<dt><strong>vernum</strong> &nbsp;(Input)&nbsp;</dt>
<dd>The version number of the remote program.<br>
<br>
</dd>
<dt><strong>netconf</strong> &nbsp;(Input)&nbsp;</dt>
<dd>The transport protocol.<br>
<br>
</dd>
<dt><strong>svcaddr</strong> &nbsp;(Input)&nbsp;</dt>
<dd>A pointer to the local address of the service.</dd>
</dl>
<br>
<h3>Authorities</h3>
<p>No authorization is required.</p>
<br>
<h3>Return Value</h3>
<table cellpadding="5">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>TRUE (1)</em></td>
<td align="left" valign="top"><strong>rpcb_set</strong> was successful.</td>
</tr>
<tr>
<td align="left" valign="top"><em>FALSE (0)</em></td>
<td align="left" valign="top"><strong>rpcb_set</strong> was unsuccessful.</td>
</tr>
</table>
<br>
<br>
<h3>Error Conditions</h3>
<p>Upon failure, <strong>rpcb_set()</strong> sets the global structure
<em>rpc_createerr</em>. The <em>rpc_createerr.cf_stat</em> variable contains a
status value, which indicates the error reason. The
<em>rpc_createerr.cf_error.re_errno</em> variable is meaningful when some
status values are set.</p>
<p>The <em>rpc_createerr.cf_stat</em> variable can be set to one of the
following values:</p>
<table cellpadding="5">
<!-- cols="25 75" -->
<tr>
<td align="left" valign="top"><em>[RPC_INTR]</em></td>
<td align="left" valign="top">Interrupted RPC call. An exception has occurred
in the RPC API. The <em>rpc_createerr.cf_error.re_errno</em> is set to
EUNKNOWN.</td>
</tr>
<tr>
<td align="left" valign="top"><em>[RPC_N2AXLATEFAILURE]</em></td>
<td align="left" valign="top">Name to address translation failed.</td>
</tr>
<tr>
<td align="left" valign="top"><em>[RPC_RPCBFAILURE]</em></td>
<td align="left" valign="top">Unable to contact the RPCBind daemon.</td>
</tr>
<tr>
<td align="left" valign="top"><em>[RPC_UNKNOWNADDR]</em></td>
<td align="left" valign="top">Unknown address. The <em>svcaddr</em> is
invalid.</td>
</tr>
<tr>
<td align="left" valign="top"><em>[RPC_UNKNOWNADDR]</em></td>
<td align="left" valign="top">Unknown remote address. The
<em>rpc_createerr.cf_error.re_errno</em> variable is not applicable.</td>
</tr>
<tr>
<td align="left" valign="top"><em>[RPC_UNKNOWNPROTO]</em></td>
<td align="left" valign="top">Unknown client/server protocol. The
<em>rpc_createerr.cf_error.re_errno</em> variable is not applicable.</td>
</tr>
</table>
<p>This API calls <strong>clnt_tli_create()</strong> and
<strong>clnt_call()</strong> APIs in order to perform its task. It inherits
RPC_SYSTEMERROR from <strong>clnt_tli_create()</strong> API and it inherits all
error conditions from <strong>clnt_call()</strong> API except RPC_TIMEDOUT and
RPC_FAILED.</p>
<br>
<h3>Error Messages</h3>
<table width="100%" cellpadding="5">
<!-- cols="15 85" -->
<tr>
<th align="left" valign="top">Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td width="15%" valign="top">CPIA1B1 I</td>
<td width="85%" valign="top">A problem was encountered in the RPC client.</td>
</tr>
<tr>
<td align="left" valign="top">CPIA1B2 I</td>
<td align="left" valign="top">TI-RPC encountered a problem in the transport
protocol.</td>
</tr>
<tr>
<td align="left" valign="top">CPIA1B8 I</td>
<td align="left" valign="top">A problem occurred while trying to contact the
RPCBind daemon.</td>
</tr>
<tr>
<td align="left" valign="top">CPE3418 E</td>
<td align="left" valign="top">Possible APAR condition or hardware failure.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3CF2 E</td>
<td align="left" valign="top">Error(s) occurred during running of &amp;1
API.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9872 E</td>
<td align="left" valign="top">Program or service program &amp;1 in library
&amp;2 ended. Reason code &amp;3.</td>
</tr>
</table>
<br>
<br>
<h3>Related Information</h3>
<ul>
<li><a href="rpcb_unset.htm">rpcb_unset()--Unregister Their Addresses</a></li>
</ul>
<br>
<h3>Example</h3>
<p>See <a href="../apiref/aboutapis.htm#codedisclaimer">Code disclaimer information</a>
for information pertaining to code examples.</p>
<p>The following example shows how <strong>rpcb_set()</strong> is used:</p>
<pre>
/* Define remote program number and version */
#define RMTPROGNUM (u_long)0x3fffffffL
#define RMTPROGVER (u_long)0x1
#include &lt;stdio.h&gt;
#include &lt;rpc/rpc.h&gt;
#include &lt;netconfig.h&gt;
main()
{
struct netconfig *nconf;
struct netbuf *svcaddr;
...
/* Returns a pointer to nconf corresponding to NETCONF */
if ((nconf = getnetconfigent(&quot;UDP&quot;)) ==
(struct netconfig *)NULL) {
fprintf(stderr, &quot;Cannot get netconfig entry for UDP\n&quot;);
exit(1);
}
...
/* Register to the RPCBind */
if (!<strong>rpcb_set</strong>(RMTPROGNUM, RMTPROGVER, nconf, svcaddr)){
fprintf(stderr, &quot;<strong>rpcb_set</strong> failed!!\n&quot;);
exit(1);
}
...
}
</pre>
<br>
<hr>
API introduced: V4R2
<hr>
<table cellpadding="2" cellspacing="2" align="center">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"rpc1.htm">Remote Procedure Call (RPC) APIs</a> | <a href="aplist.htm">APIs by
category</a></td>
</tr>
</table>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink