159 lines
8.8 KiB
HTML
159 lines
8.8 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>Clustered Hash Table</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. -->
|
||
|
|
<!-- Change History: -->
|
||
|
|
<!-- YYMMDD USERID Change description -->
|
||
|
|
<!-- 031106 JETAYLOR replaced API and/or Exit listings with -->
|
||
|
|
<!-- pagegenerator output from javascript array -->
|
||
|
|
<!-- End Header Records -->
|
||
|
|
<!-- -->
|
||
|
|
<!-- -->
|
||
|
|
<!-- -->
|
||
|
|
<!-- Begin Developer Note ========================================== -->
|
||
|
|
<!-- NOTE: If you are adding, changing, or removing ANY requirements -->
|
||
|
|
<!-- for this API chance are good that the GUI code need to change -->
|
||
|
|
<!-- also. The Cluster GUI code is built on top of this API and it -->
|
||
|
|
<!-- does a certain amount of explicit and implicit validation -->
|
||
|
|
<!-- checking of user data prior to the API call being made. Please -->
|
||
|
|
<!-- have the Cluster GUI developer check the -->
|
||
|
|
<!--/as400/v5r4m0.guix/cur/cmvc/java.pgm/ugcl.guix/com/ibm/as400/opnav/ugcl/ClGuiActionsManager.java/ClGuiActionsManager.java -->
|
||
|
|
<!-- part to determine if any Cluster GUI code changes are needed. -->
|
||
|
|
<!-- End Developer Note -->
|
||
|
|
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<!-- Java sync-link-->
|
||
|
|
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<a name="Top_Of_Page"></a>
|
||
|
|
|
||
|
|
<h2>Clustered Hash Table
|
||
|
|
APIs</h2>
|
||
|
|
|
||
|
|
<p>The information provided here includes:</p>
|
||
|
|
|
||
|
|
<ul>
|
||
|
|
<li><a href="#header_1">Clustered Hash Table APIs--Introduction</a></li>
|
||
|
|
|
||
|
|
<li><a href="#clust">Clustered Hash Table API List</a></li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
<h2><a name="header_1">Clustered Hash Table APIs--Introduction</a></h2>
|
||
|
|
|
||
|
|
<p>The clustered hash table APIs enable sharing and replicating of data between
|
||
|
|
cluster nodes. The data is stored in nonpersistent storage. This means the data
|
||
|
|
is retained only until the cluster node is no longer part of the clustered hash
|
||
|
|
table. These APIs can only be used from a cluster node that is defined in the
|
||
|
|
clustered hash table domain. The cluster node must be active in the
|
||
|
|
cluster.</p>
|
||
|
|
|
||
|
|
<p>The clustered hash table server is started using the <a href=
|
||
|
|
"../cl/strchtsvr.htm">STRCHTSVR</a> command. A cluster must be active on the
|
||
|
|
node performing the start function. Using this command, the user defines the
|
||
|
|
domain of the clustered hash table. A cluster resource group (CRG) (same name
|
||
|
|
as clustered hash table server) is created to manage the domain of the
|
||
|
|
clustered hash table.</p>
|
||
|
|
|
||
|
|
<p>There are two levels of security supported by a clustered hash table. One
|
||
|
|
security level is associated with a clustered hash table server. This security
|
||
|
|
is provided through the authorization list parameter on the <a href=
|
||
|
|
"../cl/strchtsvr.htm">STRCHTSVR</a> command. This provides the ability to
|
||
|
|
specify users that are allowed to start, end and connect to a clustered hash
|
||
|
|
table server. For more details on the authorization list see the AUTL parameter
|
||
|
|
on the <a href="../cl/strchtsvr.htm">STRCHTSVR</a> command.</p>
|
||
|
|
|
||
|
|
<p>The second security level is provided on an entry stored in a clustered hash
|
||
|
|
table. The authority access level is specified when an entry is stored in a
|
||
|
|
clustered hash table. This provides the ability to restrict access to
|
||
|
|
retrieving and updating an entry. For more details on the authority access
|
||
|
|
level for an entry see the <a href="clchtstoreentry.htm">Store Clustered Hash
|
||
|
|
Table Entry (QcstStoreCHTEntry)</a> API.</p>
|
||
|
|
|
||
|
|
<p>First a client must connect to the clustered hash table server using <a
|
||
|
|
href="clchtconnect.htm">Connect Clustered Hash Table (QcstConnectCHT)</a> API.
|
||
|
|
This establishes the communication infrastructure so clients can send requests
|
||
|
|
to the clustered hash table server. A connection handle is returned to the
|
||
|
|
client. This connection handle is required to be used on subsequent requests to
|
||
|
|
the clustered hash table server. The client needs to connect from each job that
|
||
|
|
is intending on communicating to the clustered hash table server.</p>
|
||
|
|
|
||
|
|
<p>Clients can disconnect from the clustered hash table server using the <a
|
||
|
|
href="clchtdisconnect.htm">Disconnect Clustered Hash Table
|
||
|
|
(QcstDisconnectCHT)</a> API. The disconnect is necessary to cleanup the
|
||
|
|
infrastructure established by the connection request. The disconnect is a local
|
||
|
|
only request. It is recommended to use disconnect when done with the
|
||
|
|
connection.</p>
|
||
|
|
|
||
|
|
<p>An entry is associated with a key and stored in a clustered hash table using
|
||
|
|
the <a href="clchtstoreentry.htm">Store Clustered Hash Table Entry
|
||
|
|
(QcstStoreCHTEntry)</a> API. The key can be generated using the <a href=
|
||
|
|
"clchtgenkey.htm">Generate Clustered Hash Table Key (QcstGenerateCHTKey)</a>
|
||
|
|
API or the user can generate their own.</p>
|
||
|
|
|
||
|
|
<p>The storage for the clustered hash table is not persistent. Not persistent
|
||
|
|
means the storage for the clustered hash table is only known to the server on
|
||
|
|
the local node and only available until the clustered hash table server is
|
||
|
|
ended. All requests to store entries are replicated to other nodes in the
|
||
|
|
clustered hash table domain. When an entry is stored, a time to live value is
|
||
|
|
specified. The entry can become expired, when the time to live value has
|
||
|
|
expired. Expired entries will be removed when processing various functions. For
|
||
|
|
example, when adding another cluster node to the domain of an existing
|
||
|
|
clustered hash table server. The existing clustered hash table entries, if any,
|
||
|
|
are replicated to the cluster hash table domain node being added. Expired
|
||
|
|
entries are removed from the clustered hash table during this process.</p>
|
||
|
|
|
||
|
|
<p>An entry is retrieved from the hash table by key using the <a href=
|
||
|
|
"clchtretrieveentry.htm">Retrieve Clustered Hash Table Entry
|
||
|
|
(QcstRetrieveCHTEntry)</a> API. The retrieve request is only processed on the
|
||
|
|
clustered hash table domain node requesting the function.</p>
|
||
|
|
|
||
|
|
<p>A list of all keys stored in a clustered hash table server can be obtained
|
||
|
|
by using the <a href="clchtlstkey.htm">List Clustered Hash Table Keys
|
||
|
|
(QcstListCHTKeys)</a> API. The list request is only processed on the clustered
|
||
|
|
hash table domain node requesting the function.</p>
|
||
|
|
|
||
|
|
<p>The clustered hash table server is ended using the <a href=
|
||
|
|
"../cl/endchtsvr.htm">ENDCHTSVR</a> CL command. The clustered hash table server
|
||
|
|
will be ended on the cluster nodes specified.</p>
|
||
|
|
|
||
|
|
<p>The clustered hash table APIs have associated java classes. See <a href=
|
||
|
|
"../rzahh/clusteredhshtbl.htm">ClusteredHashTable class</a> for details.</p>
|
||
|
|
|
||
|
|
<h2><a name="clust">Clustered Hash Table API List</a></h2>
|
||
|
|
|
||
|
|
<p>The clustered hash table APIs are:</p>
|
||
|
|
<!-- ***** NOTE ***** Do not manually update text or links in this section. -->
|
||
|
|
<!-- Updates made in this section *will* be overlaid by automated tools -->
|
||
|
|
<!-- Notify User Technologies of needed updates to be made in XML for API finder.-->
|
||
|
|
<!--***************API BEGIN PASTE***************-->
|
||
|
|
<ul>
|
||
|
|
<li><A HREF="clchtconnect.htm">Connect Clustered Hash Table</A> (QcstConnectCHT) establishes a connection to the clustered hash table server specified.</li>
|
||
|
|
<li><A HREF="clchtdisconnect.htm">Disconnect Clustered Hash Table</A> (QcstDisconnectCHT) disconnects the using job from the clustered hash table server.</li>
|
||
|
|
<li><A HREF="clchtgenkey.htm">Generate Clustered Hash Table Key</A> (QcstGenerateCHTKey) returns a universally unique key that can be used to store an entry into the clustered hash table.</li>
|
||
|
|
<li><A HREF="clchtlstkey.htm">List Clustered Hash Table Keys</A> (QcstListCHTKeys) generates a list of keys and descriptive information about the entries stored in the clustered hash table specified by the connection handle parameter.</li>
|
||
|
|
<li><A HREF="clchtretrieveentry.htm">Retrieve Clustered Hash Table Entry</A> (QcstRetrieveCHTEntry) retrieves an entry from the clustered hash table specified by the connection handle parameter. The entry to be retrieved is identified by the key parameter.</li>
|
||
|
|
<li><A HREF="clchtstoreentry.htm">Store Clustered Hash Table Entry</A> (QcstStoreCHTEntry) stores an entry in the clustered hash table identified by the connection handle.</li>
|
||
|
|
</ul>
|
||
|
|
<!--***************API END PASTE***************-->
|
||
|
|
<hr>
|
||
|
|
<center>
|
||
|
|
<table cellpadding="2" cellspacing="2">
|
||
|
|
<tr align="center">
|
||
|
|
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
|
||
|
|
"clust1.htm">Cluster APIs</a> | <a href="aplist.htm">APIs by category</a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</center>
|
||
|
|
</body>
|
||
|
|
</html>
|
||
|
|
|