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

133 lines
3.6 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>rapi_dispatch()--Dispatch the RAPI message-handling routine</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. -->
<!-- Created by John Hall for V5R1-->
<!-- Change history: -->
<!-- 030522 LESMITH: D3255.1 public authority should be *EXCLUDE-->
<!-- 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 type="text/javascript" language="Javascript" src="../rzahg/synch.js">
</script>
<h2>rapi_dispatch()--Dispatch the RAPI message-handling routine</h2>
<div class="box" style="width: 60%;">
<br>
&nbsp;&nbsp;Syntax<br>
<pre>
#include &lt;rapi.h&gt;
int rapi_dispatch(void)
</pre>
<br>
&nbsp;&nbsp;Service program name: QSYS/QTOQRAPI&nbsp;&nbsp;<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Default public authority: *EXCLUDE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: Yes<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The <strong>rapi-dispatch()</strong> API dispatches the RAPI
message-handling routine defined in the rapi_session() call. The application
should call this routine whenever a read event is signaled on a file descriptor
returned by the <strong>rapi_getfd()</strong> API call. This routine may be
called at any time, but generally it has no effect unless there is a pending
event.</p>
<p>Calling this routine may result in one or more RAPI message-handling
routines to the application from any of the Open API sessions known to this
instance of the library.</p>
<br>
<h3>Parameters</h3>
<p>None.</p>
<br>
<h3>Authorities</h3>
<p>None.</p>
<br>
<h3>Return Value</h3>
<p>Returns 0 if successful.</p>
<p>RAPI error code if it fails.</p>
<br>
<h3>Error Conditions</h3>
<dl>
<dt><em>[RAPI_ERR_NORSVP]</em></dt>
<dd><p>RSVP server was not detected. Make sure the RSVP
server is running.</p></dd>
<dt><em>[RAPI_ERR_MEMFULL]</em></dt>
<dd><p>Unable to allocate memory. Check the system
memory status.</p></dd>
<dt><em>[RAPI_ERR_INVAL]</em></dt>
<dd><p>Error detected in the RSVP specifications being
handled by the RAPI message-handling routine.</p></dd>
</dl>
<br>
<br>
<h3>Usage Notes</h3>
<p>The <strong>rapi_session()</strong> API must be called to create a valid
session before this API is called. This API typically is called to respond to
an event received on the file descriptor returned by the
<strong>rapi_getfd()</strong> API call.</p>
<br>
<h3>Related Information</h3>
<p>For a description of the RSVP protocol, see RFC 2205 on the RFC Pages for <a
href="http://www.ietf.org/rfc.html">The Internet Engineering Task
Force</a>.<img src="www.gif" alt="Link outside Information Center"></p>
<p>Complete documentation of the RAPI APIs can be found at <a href=
"http://www.opengroup.org/publications/catalog/c809.htm">The Open
Group</a>.<img src="www.gif" alt="Link outside Information Center"></p>
<br>
<hr>
API introduced: V5R1
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"unix.htm">UNIX-Type APIs</a> | <a href="aplist.htm">APIs by category</a> </td>
</tr>
</table></center>
</body>
</html>