ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/svc_create.htm

263 lines
6.4 KiB
HTML

<!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>svc_create()--Create a Server Handle</title>
<!-- 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. -->
<!-- Begin Header Records ========================================== -->
<!-- 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>
<a name="Top_Of_Page"></a>
<!-- Java sync-link -->
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript">
</script>
<h2>svc_create()--Create a Server Handle</h2>
<div class="box" style="width: 60%;">
<br>
&nbsp;&nbsp;Syntax<br>
<!-- iddvc RMBR -->
<br>
<pre>
#include &lt;rpc/rpc.h&gt;
int svc_create(const void
(*dispatch)(const svc_req *,
const SVCXPRT *),
const u_long <em>prognum</em>,
const u_long <em>versnum</em>,
const char *<em>nettype</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>svc_create()</strong> function creates server handles for all
the transports belonging to the class <em>nettype</em>.</p>
<p><strong>svc_create()</strong> tries all the transports of the
<em>nettype</em> class that are available from the /etc/netconfig file in
top-to-bottom order. <strong>svc_create()</strong> registers itself with the
RPCBind service.</p>
<br>
<h3>Parameters</h3>
<dl>
<dt><strong>dispatch</strong> &nbsp;(Input)&nbsp;</dt>
<dd>The server dispatch function. <em>dispatch</em> is called when there is a
remote procedure call for the given <em>prognum</em> and <em>versnum</em>.<br>
<br>
</dd>
<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>nettype</strong> &nbsp;(Input)&nbsp;</dt>
<dd>The following classes of transport protocol are valid: NETPATH, VISIBLE,
CIRCUIT_V, DATAGRAM_V, CIRCUIT_N, DATAGRAM_N, TCP, and UDP.</dd>
</dl>
<br>
<h3>Authorities</h3>
<p>The caller of the <strong>svc_create()</strong> API must have execute (*X)
authority to the /etc directory and must have read (*R) authority to the
netconfig file.</p>
<br>
<h3>Return Value</h3>
<table cellpadding="5">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>num</em></td>
<td align="left" valign="top">Upon successful completion,
<strong>svc_create()</strong> returns the number of server handles it
creates.</td>
</tr>
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top"><strong>svc_create()</strong> was not successful.
The <em>errno</em> variable is set to indicate the reason.</td>
</tr>
</table>
<br>
<br>
<h3>Error Conditions</h3>
<p>This API calls <strong>setnetconfig()</strong> and
<strong>getnetconfig()</strong> APIs in order to perform its task. The API
inherits all error conditions from those APIs. It also inherits all error
conditions from <strong>svc_tp_create()</strong> API except EINVAL.</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">CPIA1B3 I</td>
<td align="left" valign="top">TI-RPC encountered a problem in the server.</td>
</tr>
<tr>
<td align="left" valign="top">CPIA1B5 I</td>
<td align="left" valign="top">An incorrect nettype was given.</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="svc_tp_create.htm">svc_tp_create()--Create a Server
Handle</a></li>
<li><a href="svc_tli_create.htm">svc_tli_create()--Create a Server
Handle</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>svc_create()</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;
static void exm_proc();
main()
{
int transpnum;
...
transpnum = <strong>svc_create</strong>(exm_proc, RMTPROGNUM, RMTPROGVER,
&quot;VISIBLE&quot;);
if (transpnum == 0){
fprintf(stderr, &quot;Cannot create a service.\n&quot;);
exit(1);
}
svc_run(); /* No return */
}
/* The server dispatch function */
static void exm_proc(struct svc_req *rqstp, SVCXPRT *transp)
{
...
}
</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>