| <!DOCTYPE HTML> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>SharedOffHeapWithinNode (Storm 2.6.2 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.storm.topology, class: SharedOffHeapWithinNode"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var pathtoroot = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/SharedOffHeapWithinNode.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li>Method</li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.storm.topology</a></div> |
| <h1 title="Class SharedOffHeapWithinNode" class="title">Class SharedOffHeapWithinNode</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance"><a href="../generated/SharedMemory.html" title="class in org.apache.storm.generated">org.apache.storm.generated.SharedMemory</a> |
| <div class="inheritance">org.apache.storm.topology.SharedOffHeapWithinNode</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Cloneable.html" title="class or interface in java.lang" class="external-link">Cloneable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="../generated/SharedMemory.html" title="class in org.apache.storm.generated">SharedMemory</a>></code>, <code>org.apache.storm.thrift.TBase<<a href="../generated/SharedMemory.html" title="class in org.apache.storm.generated">SharedMemory</a>,<wbr><a href="../generated/SharedMemory._Fields.html" title="enum in org.apache.storm.generated">SharedMemory._Fields</a>></code>, <code>org.apache.storm.thrift.TSerializable</code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">SharedOffHeapWithinNode</span> |
| <span class="extends-implements">extends <a href="../generated/SharedMemory.html" title="class in org.apache.storm.generated">SharedMemory</a></span></div> |
| <div class="block">A request for a shared memory region off heap between workers on a node.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../serialized-form.html#org.apache.storm.topology.SharedOffHeapWithinNode">Serialized Form</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.apache.storm.generated.SharedMemory">Nested classes/interfaces inherited from class org.apache.storm.generated.<a href="../generated/SharedMemory.html" title="class in org.apache.storm.generated">SharedMemory</a></h2> |
| <code><a href="../generated/SharedMemory._Fields.html" title="enum in org.apache.storm.generated">SharedMemory._Fields</a></code></div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.storm.generated.SharedMemory">Fields inherited from class org.apache.storm.generated.<a href="../generated/SharedMemory.html" title="class in org.apache.storm.generated">SharedMemory</a></h3> |
| <code><a href="../generated/SharedMemory.html#metaDataMap">metaDataMap</a></code></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(double,java.lang.String)" class="member-name-link">SharedOffHeapWithinNode</a><wbr>(double amount, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Create a new request for a shared memory region off heap between workers on a node.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.storm.generated.SharedMemory">Methods inherited from class org.apache.storm.generated.<a href="../generated/SharedMemory.html" title="class in org.apache.storm.generated">SharedMemory</a></h3> |
| <code><a href="../generated/SharedMemory.html#clear()">clear</a>, <a href="../generated/SharedMemory.html#compareTo(org.apache.storm.generated.SharedMemory)">compareTo</a>, <a href="../generated/SharedMemory.html#deepCopy()">deepCopy</a>, <a href="../generated/SharedMemory.html#equals(java.lang.Object)">equals</a>, <a href="../generated/SharedMemory.html#equals(org.apache.storm.generated.SharedMemory)">equals</a>, <a href="../generated/SharedMemory.html#fieldForId(int)">fieldForId</a>, <a href="../generated/SharedMemory.html#get_name()">get_name</a>, <a href="../generated/SharedMemory.html#get_off_heap_node()">get_off_heap_node</a>, <a href="../generated/SharedMemory.html#get_off_heap_worker()">get_off_heap_worker</a>, <a href="../generated/SharedMemory.html#get_on_heap()">get_on_heap</a>, <a href="../generated/SharedMemory.html#getFieldValue(org.apache.storm.generated.SharedMemory._Fields)">getFieldValue</a>, <a href="../generated/SharedMemory.html#hashCode()">hashCode</a>, <a href="../generated/SharedMemory.html#is_set_name()">is_set_name</a>, <a href="../generated/SharedMemory.html#is_set_off_heap_node()">is_set_off_heap_node</a>, <a href="../generated/SharedMemory.html#is_set_off_heap_worker()">is_set_off_heap_worker</a>, <a href="../generated/SharedMemory.html#is_set_on_heap()">is_set_on_heap</a>, <a href="../generated/SharedMemory.html#isSet(org.apache.storm.generated.SharedMemory._Fields)">isSet</a>, <a href="../generated/SharedMemory.html#read(org.apache.storm.thrift.protocol.TProtocol)">read</a>, <a href="../generated/SharedMemory.html#set_name(java.lang.String)">set_name</a>, <a href="../generated/SharedMemory.html#set_name_isSet(boolean)">set_name_isSet</a>, <a href="../generated/SharedMemory.html#set_off_heap_node(double)">set_off_heap_node</a>, <a href="../generated/SharedMemory.html#set_off_heap_node_isSet(boolean)">set_off_heap_node_isSet</a>, <a href="../generated/SharedMemory.html#set_off_heap_worker(double)">set_off_heap_worker</a>, <a href="../generated/SharedMemory.html#set_off_heap_worker_isSet(boolean)">set_off_heap_worker_isSet</a>, <a href="../generated/SharedMemory.html#set_on_heap(double)">set_on_heap</a>, <a href="../generated/SharedMemory.html#set_on_heap_isSet(boolean)">set_on_heap_isSet</a>, <a href="../generated/SharedMemory.html#setFieldValue(org.apache.storm.generated.SharedMemory._Fields,java.lang.Object)">setFieldValue</a>, <a href="../generated/SharedMemory.html#toString()">toString</a>, <a href="../generated/SharedMemory.html#unset_name()">unset_name</a>, <a href="../generated/SharedMemory.html#unset_off_heap_node()">unset_off_heap_node</a>, <a href="../generated/SharedMemory.html#unset_off_heap_worker()">unset_off_heap_worker</a>, <a href="../generated/SharedMemory.html#unset_on_heap()">unset_on_heap</a>, <a href="../generated/SharedMemory.html#validate()">validate</a>, <a href="../generated/SharedMemory.html#write(org.apache.storm.thrift.protocol.TProtocol)">write</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(double,java.lang.String)"> |
| <h3>SharedOffHeapWithinNode</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">SharedOffHeapWithinNode</span><wbr><span class="parameters">(double amount, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name)</span></div> |
| <div class="block">Create a new request for a shared memory region off heap between workers on a node.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>amount</code> - the number of MB to share</dd> |
| <dd><code>name</code> - the name of the shared region (for tracking purposes)</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
