130 lines
3.3 KiB
HTML
130 lines
3.3 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_getfd()--Get descriptor to wait on</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 -->
|
|
<!-- 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_getfd()--Get descriptor to wait on</h2>
|
|
|
|
<div class="box" style="width: 60%;">
|
|
<br>
|
|
Syntax<br>
|
|
<pre>
|
|
#include <rapi.h>
|
|
int rapi_getfd( rapi_sid_t SessID)
|
|
|
|
</pre>
|
|
|
|
<br>
|
|
Service program name: QSYS/QTOQRAPI<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Default public authority: *EXCLUDE<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: Yes<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
<p>The <strong>rapi_getfd()</strong> API returns the file descriptor associated
|
|
with a successful <strong>rapi_session()</strong> call. This descriptor is
|
|
valid until <strong>rapi_release()</strong> has been called. When a read event
|
|
is signaled on this file descriptor, the application should
|
|
use<strong>rapi_dispatch()</strong> to call the RAPI message-handling routine
|
|
to handle the event.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Parameters</h3>
|
|
|
|
<dl>
|
|
<dt><strong><em>SessID</em></strong></dt>
|
|
|
|
<dd>(Input) Required<br>
|
|
The session ID returned by a successful rapi_session() call.</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Authorities</h3>
|
|
|
|
<p>None.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Return Value</h3>
|
|
|
|
<p>Returns a valid file descriptor if the SessID is valid.</p>
|
|
|
|
<p>Returns -1 if the SessID is not valid.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Error Conditions</h3>
|
|
|
|
<p>None.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Usage Notes</h3>
|
|
|
|
<p>The returned file descriptor can be used to wait on a select() or poll()
|
|
call; it also can be used to wait on a select() call for a response from an API
|
|
request. When the response is received, the <strong>rapi_dispatch()</strong>
|
|
API can be used to call the RAPI message-handling routine defined in the
|
|
<strong>rapi_session()</strong> 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>
|
|
|