243 lines
6.4 KiB
HTML
243 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>rapi_sender()--Identify a RAPI sender</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_sender()--Identify a RAPI sender</h2>
|
||
|
|
|
||
|
|
<div class="box" style="width: 60%;">
|
||
|
|
<br>
|
||
|
|
Syntax<br>
|
||
|
|
<pre>
|
||
|
|
#include <rapi.h><br>
|
||
|
|
int rapi_sender (
|
||
|
|
rapi_sid_t SessID,
|
||
|
|
int flags,
|
||
|
|
rapi_addr_t *LocalAddr,
|
||
|
|
rapi_filter_t *Filter,
|
||
|
|
rapi_tspec_t *SndTspec,
|
||
|
|
rapi_adspec_t *SndAdspec,
|
||
|
|
rapi_policy_t *SndPol,
|
||
|
|
int Ttl )
|
||
|
|
|
||
|
|
</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_sender()</strong> API identifies an RSVP sender to
|
||
|
|
potential receivers of the data. This API causes an RSVP path message to be
|
||
|
|
sent to the receiver defined by the SessID value obtained by a
|
||
|
|
<strong>rapi_session</strong> call.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
<h3>Parameters</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><strong><em>SessID</em></strong></dt>
|
||
|
|
|
||
|
|
<dd>(Input) Required<br>
|
||
|
|
The session ID returned by a successful <strong>rapi_session()</strong> call. A
|
||
|
|
session ID that is not valid will cause the API to fail.<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong><em>flags</em></strong></dt>
|
||
|
|
|
||
|
|
<dd>(Input) Required<br>
|
||
|
|
Either a zero or the following flags may be used.<br>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<table cellpadding="5">
|
||
|
|
<!-- cols="5 20 75" -->
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">2</td>
|
||
|
|
<td align="left" valign="top">TC_QOS_POLICE</td>
|
||
|
|
<td align="left" valign="top">Turn traffic policing on.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">4</td>
|
||
|
|
<td align="left" valign="top">TC_QOS_NOPOLICE</td>
|
||
|
|
<td align="left" valign="top">Turn traffic policing off.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">8</td>
|
||
|
|
<td align="left" valign="top">TC_QOS_SHAPE</td>
|
||
|
|
<td align="left" valign="top">Turn traffic shaping on.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
<td align="left" valign="top">16</td>
|
||
|
|
<td align="left" valign="top">TC_QOS_NOSHAPE</td>
|
||
|
|
<td align="left" valign="top">Turn traffic shaping off.</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong><em>LocalAddr</em></strong></dt>
|
||
|
|
|
||
|
|
<dd>(Input) Optional<br>
|
||
|
|
A pointer to a rapi_addr_t structure defining the IP source address and, if
|
||
|
|
needed, the source port or flow label from which data will be sent. It is set
|
||
|
|
to NULL if not used. The format of a rapi_addr_t is
|
||
|
|
implementation-dependent.<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong><em>Filter</em></strong></dt>
|
||
|
|
|
||
|
|
<dd>(Input) Optional<br>
|
||
|
|
A pointer to a RAPI filter spec structure defining the format of the data
|
||
|
|
packets to be sent. It is set to NULL if not used. If this parameter is NULL, a
|
||
|
|
sender template is created internally from the <em>Dest</em> and
|
||
|
|
<em>LocalAddr</em> parameters. The <em>Dest</em> parameter was provided as part
|
||
|
|
of the <strong>rapi_session()</strong> call. If the <em>Filter</em> parameter
|
||
|
|
is present, the <em>LocalAddr</em> parameter is ignored.<br>
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<p>If the session is using IPSEC, this parameter is required.</p>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong><em>SndTspec</em></strong></dt>
|
||
|
|
|
||
|
|
<dd>(Input) Required<br>
|
||
|
|
A pointer to a Tspec that defines the traffic this sender will create.<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong><em>SndAdspec</em></strong></dt>
|
||
|
|
|
||
|
|
<dd>(Input) Optional<br>
|
||
|
|
A pointer to a RAPI Adspec structure. It is set to NULL if not used.<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong><em>SndPol</em></strong></dt>
|
||
|
|
|
||
|
|
<dd>(Input) Optional<br>
|
||
|
|
A pointer to a sender policy data structure. It is set to NULL if not used.<br>
|
||
|
|
<br>
|
||
|
|
</dd>
|
||
|
|
|
||
|
|
<dt><strong><em>Ttl</em></strong></dt>
|
||
|
|
|
||
|
|
<dd>(Input) Required<br>
|
||
|
|
The IP TTL (Time-to-Live) value for sending multicast data. It allows RSVP to
|
||
|
|
send its control messages with the same TTL scope as the data packets. It is
|
||
|
|
set to 0 if not used.</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Authorities</h3>
|
||
|
|
|
||
|
|
<p>None.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Return Value</h3>
|
||
|
|
|
||
|
|
<p>Returns 0 if successful.</p>
|
||
|
|
|
||
|
|
<p>A RAPI error code is returned if it fails.</p>
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Error Conditions</h3>
|
||
|
|
|
||
|
|
<dl>
|
||
|
|
<dt><em>[RAPI_ERR_INVAL]</em></dt>
|
||
|
|
<dd><p>A parameter that is not valid was passed to the
|
||
|
|
API.</p></dd>
|
||
|
|
<dt><em>[RAPI_ERR_BADSID]</em></dt>
|
||
|
|
<dd><p>The session ID passed to the API was valid.</p></dd>
|
||
|
|
<dt><em>[RAPI_ERR_NOTSPEC]</em></dt>
|
||
|
|
<dd><p>No sender Tspec was defined for the API call.</p></dd>
|
||
|
|
<dt><em>[RAPI_ERR_NORSVP]</em></dt>
|
||
|
|
<dd><p>The RSVP server did not respond to the API
|
||
|
|
request. Make sure the RSVP server is running.</p></dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
<br>
|
||
|
|
|
||
|
|
|
||
|
|
<h3>Usage Notes</h3>
|
||
|
|
|
||
|
|
<ol>
|
||
|
|
<li>The <strong>rapi_session()</strong> API must be called to establish a
|
||
|
|
session ID to be used with the other RAPI API's.<br><br></li>
|
||
|
|
|
||
|
|
<li>The RSVP server must be running before any of the RAPI APIs are
|
||
|
|
called.<br><br></li>
|
||
|
|
|
||
|
|
<li>The formats of the parameter structures are defined in the
|
||
|
|
<<strong>rapi.h</strong>> header file.</li>
|
||
|
|
</ol>
|
||
|
|
|
||
|
|
<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>
|
||
|
|
|