| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>GatewayQueueEvent (Apache Geode 1.15.0)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="GatewayQueueEvent (Apache Geode 1.15.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/geode/cache/wan/GatewayEventSubstitutionFilter.html" title="interface in org.apache.geode.cache.wan"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/geode/cache/wan/GatewayReceiver.html" title="interface in org.apache.geode.cache.wan"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/geode/cache/wan/GatewayQueueEvent.html" target="_top">Frames</a></li> |
| <li><a href="GatewayQueueEvent.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.geode.cache.wan</div> |
| <h2 title="Interface GatewayQueueEvent" class="title">Interface GatewayQueueEvent<K,V></h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../../../../org/apache/geode/cache/asyncqueue/AsyncEvent.html" title="interface in org.apache.geode.cache.asyncqueue">AsyncEvent</a><K,V></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">GatewayQueueEvent<K,V></span></pre> |
| <div class="block">Represents <code>Cache</code> events going through <code>GatewaySender</code>s.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 7.0</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewayQueueEvent.html#getCallbackArgument--">getCallbackArgument</a></span>()</code> |
| <div class="block">Returns the callbackArgument associated with this event.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/wan/GatewayQueueEvent.html" title="type parameter in GatewayQueueEvent">V</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewayQueueEvent.html#getDeserializedValue--">getDeserializedValue</a></span>()</code> |
| <div class="block">Returns the deserialized value associated with this event.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/wan/GatewayQueueEvent.html" title="type parameter in GatewayQueueEvent">K</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewayQueueEvent.html#getKey--">getKey</a></span>()</code> |
| <div class="block">Returns the key associated with this event.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/Operation.html" title="class in org.apache.geode.cache">Operation</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewayQueueEvent.html#getOperation--">getOperation</a></span>()</code> |
| <div class="block">Returns the <code>Operation</code> that triggered this event.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache">Region</a><<a href="../../../../../org/apache/geode/cache/wan/GatewayQueueEvent.html" title="type parameter in GatewayQueueEvent">K</a>,<a href="../../../../../org/apache/geode/cache/wan/GatewayQueueEvent.html" title="type parameter in GatewayQueueEvent">V</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewayQueueEvent.html#getRegion--">getRegion</a></span>()</code> |
| <div class="block">Returns the <code>Region</code> associated with this AsyncEvent</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/wan/GatewayQueueEvent.html#getSerializedValue--">getSerializedValue</a></span>()</code> |
| <div class="block">Returns the serialized form of the value associated with this event.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getRegion--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRegion</h4> |
| <pre><a href="../../../../../org/apache/geode/cache/Region.html" title="interface in org.apache.geode.cache">Region</a><<a href="../../../../../org/apache/geode/cache/wan/GatewayQueueEvent.html" title="type parameter in GatewayQueueEvent">K</a>,<a href="../../../../../org/apache/geode/cache/wan/GatewayQueueEvent.html" title="type parameter in GatewayQueueEvent">V</a>> getRegion()</pre> |
| <div class="block">Returns the <code>Region</code> associated with this AsyncEvent</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>Region</code> associated with this AsyncEvent OR null if <code>Region</code> |
| not found (e.g. this can happen if it is destroyed).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getOperation--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOperation</h4> |
| <pre><a href="../../../../../org/apache/geode/cache/Operation.html" title="class in org.apache.geode.cache">Operation</a> getOperation()</pre> |
| <div class="block">Returns the <code>Operation</code> that triggered this event.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the <code>Operation</code> that triggered this event</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCallbackArgument--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCallbackArgument</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getCallbackArgument()</pre> |
| <div class="block">Returns the callbackArgument associated with this event.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the callbackArgument associated with this event</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getKey--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getKey</h4> |
| <pre><a href="../../../../../org/apache/geode/cache/wan/GatewayQueueEvent.html" title="type parameter in GatewayQueueEvent">K</a> getKey()</pre> |
| <div class="block">Returns the key associated with this event.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the key associated with this event</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDeserializedValue--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDeserializedValue</h4> |
| <pre><a href="../../../../../org/apache/geode/cache/wan/GatewayQueueEvent.html" title="type parameter in GatewayQueueEvent">V</a> getDeserializedValue()</pre> |
| <div class="block">Returns the deserialized value associated with this event.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the deserialized value associated with this event</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - may be thrown if the event's value was stored off-heap and |
| <a href="../../../../../org/apache/geode/cache/asyncqueue/AsyncEventListener.html#processEvents-java.util.List-"><code>AsyncEventListener.processEvents(java.util.List)</code></a> has already returned.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSerializedValue--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getSerializedValue</h4> |
| <pre>byte[] getSerializedValue()</pre> |
| <div class="block">Returns the serialized form of the value associated with this event.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the serialized form of the value associated with this event</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - may be thrown if the event's value was stored off-heap and |
| <a href="../../../../../org/apache/geode/cache/asyncqueue/AsyncEventListener.html#processEvents-java.util.List-"><code>AsyncEventListener.processEvents(java.util.List)</code></a> has already returned.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/geode/cache/wan/GatewayEventSubstitutionFilter.html" title="interface in org.apache.geode.cache.wan"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/geode/cache/wan/GatewayReceiver.html" title="interface in org.apache.geode.cache.wan"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/geode/cache/wan/GatewayQueueEvent.html" target="_top">Frames</a></li> |
| <li><a href="GatewayQueueEvent.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |