blob: ecde7fae5fc455a9301ae949f0f29493ba4d0772 [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-61232409-1"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'UA-61232409-1');
</script>
<!-- Yandex.Metrika counter -->
<script type="text/javascript" >
(function(m,e,t,r,i,k,a){m[i]=m[i]||function(){(m[i].a=m[i].a||[]).push(arguments)};
m[i].l=1*new Date();k=e.createElement(t),a=e.getElementsByTagName(t)[0],k.async=1,k.src=r,a.parentNode.insertBefore(k,a)})
(window, document, "script", "https://mc.yandex.ru/metrika/tag.js", "ym");
ym(72949126, "init", {
clickmap:true,
trackLinks:true,
accurateTrackBounce:true,
webvisor:true
});
</script>
<noscript><div><img src="https://mc.yandex.ru/watch/72949126" style="position:absolute; left:-9999px;" alt="" /></div></noscript>
<!-- /Yandex.Metrika counter -->
<!-- LuckyOrange code -->
<script type='text/javascript'>
window.__lo_site_id = 284467;
(function() {
var wa = document.createElement('script'); wa.type = 'text/javascript'; wa.async = true;
wa.src = 'https://d10lpsik1i8c69.cloudfront.net/w.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(wa, s);
})();
</script>
<!-- /LuckyOrange code -->
<!-- Bugyard widget embed -->
<script type="text/javascript">!function(){if("function"!=typeof window.bugyard){var a=function(){a.c(arguments)};a.q=[],a.c=function(b){a.q.push(b)},window.bugyard=a;var b=document.createElement("script");b.setAttribute("data-bugyard","610961912c35ff001493163a"),b.setAttribute("async","async"),b.setAttribute("defer","defer"),b.setAttribute("src","https://widget.bugyard.io/bugyard.min.js"),document.getElementsByTagName("head")[0].appendChild(b)}}(); window.bugyard("hideButton"); </script>
<link rel="preload" href='/assets/js/code-tabs.js?1' as="script" crossorigin>
<link rel="preload" href='/assets/js/page-nav.js' as="script" crossorigin>
<link rel="preload" href='/assets/js/docs-menu.js?20201005' as="script" crossorigin>
<style>:root{--gg-red:#ec1c24;--gg-orange:#ec1c24;--gg-orange-dark:#bc440b;--gg-orange-filter:invert(47%) sepia(61%) saturate(1950%) hue-rotate(345deg) brightness(100%) contrast(95%);--gg-dark-gray:#333333;--orange-line-thickness:3px;--block-code-background:rgba(241, 241, 241, 20%);--inline-code-background:rgba(241, 241, 241, 90%);--padding-top:25px;--link-color:#ec1c24;--body-background:#fcfcfc}header{min-height:var(--header-height);background:#fff;box-shadow:0 4px 10px 0 #eee,0 0 4px 0 #d5d5d5;z-index:1}header>.container{display:grid;grid-template-columns:auto auto 1fr auto auto auto;grid-template-areas:'left-toggle home nav ver api search lang';grid-template-rows:40px;flex-direction:row;align-items:center;justify-content:flex-start;padding:12px 20px;max-width:1400px;margin:0 auto}header nav>ul{padding:0;margin:0;list-style:none;display:inherit}header .dropdown{display:none;position:fixed;top:calc(var(--header-height) - 12px);width:auto;background:#fff;box-shadow:0 4px 4px 0 rgba(0,0,0,.24),0 0 4px 0 rgba(0,0,0,.12);border-radius:4px;padding-top:10px;padding-bottom:12px;z-index:2}header .dropdown li{display:flex}header .dropdown a{color:grey!important;font-size:16px;padding-top:5px;padding-bottom:4px}header .menu{border:none;background:0 0;width:40px;height:40px;margin-right:12px;grid-area:left-toggle}header .menu img{width:18px;height:12px}header .search-close,header .top-nav-toggle{background:0 0;border:none;padding:0;width:36px;height:36px;display:inline-flex;align-items:center;justify-content:center;color:var(--gg-dark-gray);font-size:26px}header .search-toggle{grid-area:search}header .top-nav-toggle{grid-area:top-toggle}header .home{grid-area:home;margin-right:auto}header .home img{height:36px}header #api-docs{grid-area:api;margin:0;display:flex}header #api-docs .dropdown{padding:.5em 0}header #api-docs a{padding:9px 14px;color:var(--gg-dark-gray)!important;text-decoration:none;white-space:nowrap}header #api-docs .dropdown-item a{font-weight:400;display:block;width:100%;min-width:150px}header #lang-selector li{list-style:none;display:flex;padding:9px 14px}header #lang-selector li a{display:flex;color:#000;align-items:center}header #lang-selector li a span{font-size:10px;margin-left:5px}header #lang-selector li a img{width:25px}header #lang-selector li .dropdown{margin-left:-70px}header #lang-selector li .dropdown .dropdown-item{padding:0 1em;margin-bottom:8px}header #lang-selector li .dropdown .dropdown-item a span{font-size:14px}header .search{margin-left:auto;margin-right:20px;grid-area:search}header .search input[type=search]{color:var(--gg-dark-gray);background:rgba(255,255,255,.8);border:1px solid #ccc;padding:10px 15px;font-family:inherit;max-width:148px;height:37px;font-size:14px;-webkit-appearance:unset;appearance:unset}header #version-selector{list-style:none;grid-area:ver;line-height:28px;border-radius:0;margin-right:10px;border:none;color:var(--gg-dark-gray);padding:5px 16px 5px 10px;white-space:nowrap;font-size:14px;width:auto;text-align:right;box-sizing:border-box;text-align-last:right;-moz-appearance:none;-webkit-appearance:none;appearance:none;direction:rtl}header #version-selector option{direction:ltr}header>nav{grid-area:nav;font-size:18px;display:flex;flex-direction:row;margin:0 20px}header #lang-selector{grid-area:lang}header .search-close{margin-right:10px}@media (max-width:600px){header .search{margin-right:5px}header .search input[type=search]{max-width:110px}}header:not(.narrow-header) .search-close,header:not(.narrow-header) .top-nav-toggle{display:none}@media (max-width:670px){header>.container{grid-template-columns:auto 1fr auto;grid-template-areas:'left-toggle home search' 'ver api lang'}header #lang-selector li{justify-content:flex-end}}pre,pre.rouge{padding:8px 15px;background:var(--block-code-background)!important;border-radius:5px;border:1px solid #e5e5e5;overflow-x:auto;min-height:36px;line-height:18px;color:#545454}code{color:#545454}pre.rouge code{background:0 0!important}:not(pre)>code{background:var(--inline-code-background);padding:.1em .5em;background-clip:padding-box;border-radius:3px;color:#545454;font-size:90%}.listingblock .content{position:relative}.highlight{color:#586e75}.highlight .c1{color:#657b83}.highlight .nt{color:#b58900}.highlight .o{color:#93a1a1}.highlight .k{color:#6c71c4}.highlight .kt{color:#cb4b16}.highlight .s,.highlight .s1{color:#859900}.highlight .nc{color:#b58900}.highlight .na{color:#268bd2}body{font-family:'Open Sans',sans-serif}h1,h2{color:#000;font-weight:400;font-family:'Open Sans'}h1{font-size:36px;line-height:40px}a{text-decoration:none;color:var(--link-color)}section{color:#545454}.admonitionblock .icon .title{display:none}body{--header-height:64px;--promotion-bar-height:35px;--footer-height:104px;--footer-gap:60px;padding:0;margin:0;display:flex;flex-direction:column;min-height:100vh;background-color:var(--body-background);font-family:'Open Sans',sans-serif}body>section{flex:1}header{position:-webkit-sticky;position:sticky;top:0;z-index:2}*{box-sizing:border-box}@media (max-width:670px){body{--header-height:97px}}.left-nav{padding:10px 20px;width:289px;overflow-y:auto;top:calc(var(--header-height) + var(--promotion-bar-height));height:calc(100vh - var(--header-height) - var(--promotion-bar-height));font-family:'Open Sans';padding-top:var(--padding-top);background-color:var(--body-background)}.left-nav li{list-style:none}.left-nav a,.left-nav button{text-decoration:none;color:#757575;font-size:16px;display:inline-flex;width:100%;margin:2px 0;padding:.25em .375em;background:0 0;border:none;font:inherit;text-align:left}.left-nav a.active{color:var(--link-color)}.left-nav .nav-group{margin-left:6px;font-size:14px}.left-nav nav{border-left:2px solid #ddd;margin-bottom:5px}.left-nav nav.collapsed{display:none}.left-nav nav>li>a,.left-nav nav>li>button{padding-left:20px;text-align:left}.left-nav nav>li>a.active{border-left:var(--orange-line-thickness) solid var(--active-color);padding-left:calc(20px - var(--orange-line-thickness))}.left-nav nav.sub_pages{border:none}.left-nav nav.sub_pages a{padding-left:32px}.left-nav .state-indicator{margin-left:auto;margin-top:5px;width:6.2px;height:10px;flex:0 0 auto;filter:invert(49%) sepia(4%) saturate(5%) hue-rotate(23deg) brightness(92%) contrast(90%)}.left-nav button.expanded .state-indicator{transform:rotate(90deg)}.right-nav{width:289px;padding:12px 26px;overflow-y:auto;height:calc(100vh - var(--header-height));top:0;position:-webkit-sticky;position:sticky;display:flex;flex-direction:column;font-family:'Open sans';padding-top:var(--padding-top);background-color:#fff}.right-nav ul{list-style:none;padding:0;margin:0}.right-nav li{padding:0}.right-nav a{--border-width:0px;font-size:14px;color:#757575;padding-left:calc(15px * var(--nesting-level) + 8px - var(--border-width));margin:.3em 0;display:inline-block}.right-nav .sectlevel1{border-left:2px solid #ddd}.right-nav .sectlevel1{--nesting-level:0}.right-nav .sectlevel2{--nesting-level:1}.right-nav .sectlevel3{--nesting-level:2}@media (max-width:1200px){.right-nav{width:230px}}.right-nav footer{font-size:12px;padding:calc(var(--footer-gap) * .3) 0 5px;text-align:left;margin:auto 0 0}section.page-docs{display:grid;grid-template-columns:auto 1fr auto;grid-template-rows:100%;grid-template-areas:'left-nav content right-nav';line-height:20px;max-width:1440px;margin:auto;width:100%}section.page-docs>article{border-left:1px solid #eee;background-color:#fff;padding:0 50px 30px;grid-area:content;overflow:hidden;font-family:sans-serif;font-size:16px;color:#545454;line-height:1.6em}section.page-docs>article h1,section.page-docs>article h2{font-family:'Open Sans'}@media (max-width:800px){section.page-docs>article{padding-left:15px;padding-right:15px}}section.page-docs .edit-link{position:relative;top:10px;right:10px;float:right;padding-top:calc(var(--header-height) + var(--padding-top));margin-top:calc((-1 * var(--header-height)))}section.page-docs h1,section.page-docs h2{margin-bottom:0}section.page-docs h2[id]{margin-top:var(--margin-top);margin-bottom:calc(var(--margin-top) * .5);z-index:-1}section.page-docs .title{font-style:italic}section.page-docs h2[id]{--margin-top:1.2em}.left-nav{bottom:0;position:-webkit-sticky;position:sticky}.left-nav{grid-area:left-nav}.right-nav{grid-area:right-nav}.left-nav__overlay{display:none;background:rgba(0,0,0,.5);z-index:1;position:fixed;top:var(--header-height);bottom:0;left:0;right:0}@media (max-width:990px){body:not(.hide-left-nav) .left-nav__overlay{display:block}nav.left-nav{background:#fafafa;grid-area:left-nav;box-shadow:0 4px 4px 0 rgba(0,0,0,.24),0 0 4px 0 rgba(0,0,0,.12);min-height:calc(100vh - var(--header-height));max-height:calc(100vh - var(--header-height));position:fixed;bottom:0;top:var(--header-height);z-index:2}section.page-docs>article{grid-column-start:left-nav;grid-column-end:content;grid-row:content}}@media (max-width:800px){nav.right-nav{display:none}}:target:before{content:"";display:block;margin-top:calc(var(--header-height) * -1);height:var(--header-height);width:1px}@media (min-width:600px) and (max-width:900px){:target:before{content:"";display:block;width:1px;margin-top:-150px;height:150px}}
#header #promotion-bar { background-color: #333333; padding: 8px; }
#header #promotion-bar p { font-size: 14px; line-height: 1.4em; font-weight: 600; padding: 0; margin: 0; color: #f0f0f0; text-align: center;}
#header #promotion-bar p a { color: #FCB903; } </style>
<meta name="ignite-version" content="2.11.0" />
<title>Key-Value Queries | Ignite Documentation</title>
<link rel="canonical" href="/docs/latest/binary-client-protocol/key-value-queries" />
<link rel="shortcut icon" href="/favicon.ico">
<meta name='viewport' content='width=device-width, height=device-height, initial-scale=1.0, minimum-scale=1.0'>
<link rel="preload" as="style" href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@300;400;600;700&display=swap" />
<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@300;400;600;700&display=swap" media="print" onload="this.media='all'">
<noscript>
<link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@300;400;600;700&display=swap" rel="stylesheet">
</noscript>
<script>
// AnchorJS - v4.2.0 - 2019-01-01
// https://github.com/bryanbraun/anchorjs
// Copyright (c) 2019 Bryan Braun; Licensed MIT
!function(A,e){"use strict";"function"==typeof define&&define.amd?define([],e):"object"==typeof module&&module.exports?module.exports=e():(A.AnchorJS=e(),A.anchors=new A.AnchorJS)}(this,function(){"use strict";return function(A){function f(A){A.icon=A.hasOwnProperty("icon")?A.icon:"",A.visible=A.hasOwnProperty("visible")?A.visible:"hover",A.placement=A.hasOwnProperty("placement")?A.placement:"right",A.ariaLabel=A.hasOwnProperty("ariaLabel")?A.ariaLabel:"Anchor",A.class=A.hasOwnProperty("class")?A.class:"",A.base=A.hasOwnProperty("base")?A.base:"",A.truncate=A.hasOwnProperty("truncate")?Math.floor(A.truncate):64,A.titleText=A.hasOwnProperty("titleText")?A.titleText:""}function p(A){var e;if("string"==typeof A||A instanceof String)e=[].slice.call(document.querySelectorAll(A));else{if(!(Array.isArray(A)||A instanceof NodeList))throw new Error("The selector provided to AnchorJS was invalid.");e=[].slice.call(A)}return e}this.options=A||{},this.elements=[],f(this.options),this.isTouchDevice=function(){return!!("ontouchstart"in window||window.DocumentTouch&&document instanceof DocumentTouch)},this.add=function(A){var e,t,i,n,o,s,a,r,c,h,l,u,d=[];if(f(this.options),"touch"===(l=this.options.visible)&&(l=this.isTouchDevice()?"always":"hover"),A||(A="h2, h3, h4, h5, h6"),0===(e=p(A)).length)return this;for(function(){if(null===document.head.querySelector("style.anchorjs")){var A,e=document.createElement("style");e.className="anchorjs",e.appendChild(document.createTextNode("")),void 0===(A=document.head.querySelector('[rel="stylesheet"], style'))?document.head.appendChild(e):document.head.insertBefore(e,A),e.sheet.insertRule(" .anchorjs-link { opacity: 0; text-decoration: none; -webkit-font-smoothing: antialiased; -moz-osx-font-smoothing: grayscale; }",e.sheet.cssRules.length),e.sheet.insertRule(" *:hover > .anchorjs-link, .anchorjs-link:focus { opacity: 1; }",e.sheet.cssRules.length),e.sheet.insertRule(" [data-anchorjs-icon]::after { content: attr(data-anchorjs-icon); }",e.sheet.cssRules.length),e.sheet.insertRule(' @font-face { font-family: "anchorjs-icons"; src: url(data:n/a;base64,AAEAAAALAIAAAwAwT1MvMg8yG2cAAAE4AAAAYGNtYXDp3gC3AAABpAAAAExnYXNwAAAAEAAAA9wAAAAIZ2x5ZlQCcfwAAAH4AAABCGhlYWQHFvHyAAAAvAAAADZoaGVhBnACFwAAAPQAAAAkaG10eASAADEAAAGYAAAADGxvY2EACACEAAAB8AAAAAhtYXhwAAYAVwAAARgAAAAgbmFtZQGOH9cAAAMAAAAAunBvc3QAAwAAAAADvAAAACAAAQAAAAEAAHzE2p9fDzz1AAkEAAAAAADRecUWAAAAANQA6R8AAAAAAoACwAAAAAgAAgAAAAAAAAABAAADwP/AAAACgAAA/9MCrQABAAAAAAAAAAAAAAAAAAAAAwABAAAAAwBVAAIAAAAAAAIAAAAAAAAAAAAAAAAAAAAAAAMCQAGQAAUAAAKZAswAAACPApkCzAAAAesAMwEJAAAAAAAAAAAAAAAAAAAAARAAAAAAAAAAAAAAAAAAAAAAQAAg//0DwP/AAEADwABAAAAAAQAAAAAAAAAAAAAAIAAAAAAAAAIAAAACgAAxAAAAAwAAAAMAAAAcAAEAAwAAABwAAwABAAAAHAAEADAAAAAIAAgAAgAAACDpy//9//8AAAAg6cv//f///+EWNwADAAEAAAAAAAAAAAAAAAAACACEAAEAAAAAAAAAAAAAAAAxAAACAAQARAKAAsAAKwBUAAABIiYnJjQ3NzY2MzIWFxYUBwcGIicmNDc3NjQnJiYjIgYHBwYUFxYUBwYGIwciJicmNDc3NjIXFhQHBwYUFxYWMzI2Nzc2NCcmNDc2MhcWFAcHBgYjARQGDAUtLXoWOR8fORYtLTgKGwoKCjgaGg0gEhIgDXoaGgkJBQwHdR85Fi0tOAobCgoKOBoaDSASEiANehoaCQkKGwotLXoWOR8BMwUFLYEuehYXFxYugC44CQkKGwo4GkoaDQ0NDXoaShoKGwoFBe8XFi6ALjgJCQobCjgaShoNDQ0NehpKGgobCgoKLYEuehYXAAAADACWAAEAAAAAAAEACAAAAAEAAAAAAAIAAwAIAAEAAAAAAAMACAAAAAEAAAAAAAQACAAAAAEAAAAAAAUAAQALAAEAAAAAAAYACAAAAAMAAQQJAAEAEAAMAAMAAQQJAAIABgAcAAMAAQQJAAMAEAAMAAMAAQQJAAQAEAAMAAMAAQQJAAUAAgAiAAMAAQQJAAYAEAAMYW5jaG9yanM0MDBAAGEAbgBjAGgAbwByAGoAcwA0ADAAMABAAAAAAwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABAAH//wAP) format("truetype"); }',e.sheet.cssRules.length)}}(),t=document.querySelectorAll("[id]"),i=[].map.call(t,function(A){return A.id}),o=0;o<e.length;o++)if(this.hasAnchorJSLink(e[o]))d.push(o);else{if(e[o].hasAttribute("id"))n=e[o].getAttribute("id");else if(e[o].hasAttribute("data-anchor-id"))n=e[o].getAttribute("data-anchor-id");else{for(c=r=this.urlify(e[o].textContent),a=0;void 0!==s&&(c=r+"-"+a),a+=1,-1!==(s=i.indexOf(c)););s=void 0,i.push(c),e[o].setAttribute("id",c),n=c}n.replace(/-/g," "),(h=document.createElement("a")).className="anchorjs-link "+this.options.class,h.setAttribute("aria-label",this.options.ariaLabel),h.setAttribute("data-anchorjs-icon",this.options.icon),this.options.titleText&&(h.title=this.options.titleText),u=document.querySelector("base")?window.location.pathname+window.location.search:"",u=this.options.base||u,h.href=u+"#"+n,"always"===l&&(h.style.opacity="1"),""===this.options.icon&&(h.style.font="1em/1 anchorjs-icons","left"===this.options.placement&&(h.style.lineHeight="inherit")),"left"===this.options.placement?(h.style.position="absolute",h.style.marginLeft="-1em",h.style.paddingRight="0.5em",e[o].insertBefore(h,e[o].firstChild)):(h.style.paddingLeft="0.375em",e[o].appendChild(h))}for(o=0;o<d.length;o++)e.splice(d[o]-o,1);return this.elements=this.elements.concat(e),this},this.remove=function(A){for(var e,t,i=p(A),n=0;n<i.length;n++)(t=i[n].querySelector(".anchorjs-link"))&&(-1!==(e=this.elements.indexOf(i[n]))&&this.elements.splice(e,1),i[n].removeChild(t));return this},this.removeAll=function(){this.remove(this.elements)},this.urlify=function(A){return this.options.truncate||f(this.options),A.trim().replace(/\'/gi,"").replace(/[& +$,:;=?@"#{}|^~[`%!'<>\]\.\/\(\)\*\\\n\t\b\v]/g,"-").replace(/-{2,}/g,"-").substring(0,this.options.truncate).replace(/^-+|-+$/gm,"").toLowerCase()},this.hasAnchorJSLink=function(A){var e=A.firstChild&&-1<(" "+A.firstChild.className+" ").indexOf(" anchorjs-link "),t=A.lastChild&&-1<(" "+A.lastChild.className+" ").indexOf(" anchorjs-link ");return e||t||!1}}});
</script>
</head>
<body>
<header>
<!--#include virtual="/includes/promotion_banner.html" -->
<div class="container">
<button type='button' class='menu' title='Docs menu'>
<img src="/assets/images/menu-icon.svg" width="18" height="12" alt="menu icon" />
</button>
<div class='home'>
<a href="/" class='home' title='Apache Ignite home'>
<img src="/assets/images/apache_ignite_logo.svg" alt="Apache Ignite logo" width="103" height="36" >
</a>
</div>
<select id="version-selector">
<option value="2.11.0">2.11.0</option>
</select>
<nav id="api-docs"><ul>
<li><a href="#">APIs</a>
<nav class='dropdown'>
<ul>
<li class="dropdown-item"><a href="/releases/latest/javadoc/index.html">Java</a></li>
<li class="dropdown-item"><a href="/releases/latest/dotnetdoc/api/">C#/.NET</a></li>
<li class="dropdown-item"><a href="/releases/latest/cppdoc/index.html">C++</a></li>
<li class="dropdown-item"><a href="/releases/latest/scaladoc/scalar/index.html#org.apache.ignite.scalar.scalar$">Scala</a></li>
</ul>
</nav>
</li>
<li><a href="#">Examples</a>
<nav class="dropdown">
<ul>
<li class="dropdown-item"><a href="https://github.com/apache/ignite/tree/master/examples" target="_blank" rel="noopener" title="Apache Ignite Java examples">Java</a></li>
<li class="dropdown-item"><a href="https://github.com/apache/ignite/tree/master/modules/platforms/dotnet/examples" target="_blank" rel="noopener" title="Apache Ignite C#/.NET examples">C#/.NET</a></li>
<li class="dropdown-item"><a href="https://github.com/apache/ignite/tree/master/modules/platforms/cpp/examples" target="_blank" rel="noopener" title="Apache Ignite C++ examples">C++</a></li>
<li class="dropdown-item"><a href="https://github.com/apache/ignite/tree/master/modules/platforms/python/examples" target="_blank" rel="noopener" title="Apache Ignite Python examples">Python</a></li>
<li class="dropdown-item"><a href="https://github.com/apache/ignite/tree/master/modules/platforms/nodejs/examples" target="_blank" rel="noopener" title="Apache Ignite NodeJS examples">NodeJS</a></li>
<li class="dropdown-item"><a href="https://github.com/apache/ignite/tree/master/modules/platforms/php/examples" target="_blank" rel="noopener" title="Apache Ignite PHP examples">PHP</a></li>
</ul>
</nav>
</li></ul>
</nav>
<form class='search'>
<button class="search-close" type='button'><img src='/assets/images/cancel.svg' alt="close" width="10" height="10" /></button>
<input type="search" placeholder="Search…" id="search-input">
</form>
<nav id="lang-selector"><ul>
<li><a href="#"><img src="/assets/images/icon_lang_en_75x75.jpg" alt="English language icon" width="25" height="25" /><span></span></a>
<nav class="dropdown">
<li class="dropdown-item"><a href="/docs/latest/" ><img src="/assets/images/icon_lang_en_75x75.jpg" alt="English language icon" width="25" height="25" /><span>English</span></a></li>
<li class="dropdown-item"><a href="https://www.ignite-service.cn/doc/java/" target="_blank" rel="noopener"><img src="/assets/images/icon_lang_cn_75x75.jpg" width="25" height="25" alt="Chinese language icon" /><span>Chinese</span></a></li>
</nav>
</li></ul>
</nav>
<button type='button' class='top-nav-toggle'></button>
</div>
</header>
<link rel="stylesheet" href="/assets/css/docs.css">
<section class='page-docs'>
<nav class='left-nav' data-swiftype-index='false'>
<li>
<a href="/docs/latest/index" class='' >Documentation Overview</a>
</li>
<li>
<button type='button' class='group-toggle collapsed '>Quick Start Guides<img class="state-indicator" src="/assets/images/left-nav-arrow.svg" width="6" height="10"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/latest/quick-start/java"
class=''
>Java</a>
</li>
<li>
<a href="/docs/latest/quick-start/dotnet"
class=''
>.NET/C#</a>
</li>
<li>
<a href="/docs/latest/quick-start/cpp"
class=''
>C++</a>
</li>
<li>
<a href="/docs/latest/quick-start/python"
class=''
>Python</a>
</li>
<li>
<a href="/docs/latest/quick-start/nodejs"
class=''
>Node.JS</a>
</li>
<li>
<a href="/docs/latest/quick-start/sql"
class=''
>SQL</a>
</li>
<li>
<a href="/docs/latest/quick-start/php"
class=''
>PHP</a>
</li>
<li>
<a href="/docs/latest/quick-start/restapi"
class=''
>REST API</a>
</li>
</nav>
</li>
<li>
<button type='button' class='group-toggle collapsed '>Installation<img class="state-indicator" src="/assets/images/left-nav-arrow.svg" width="6" height="10"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/latest/installation/installing-using-zip"
class=''
>Installing Using ZIP Archive</a>
</li>
<li>
<a href="/docs/latest/installation/installing-using-docker"
class=''
>Installing Using Docker</a>
</li>
<li>
<a href="/docs/latest/installation/deb-rpm"
class=''
>Installing DEB or RPM package</a>
</li>
<li>
<button
type='button'
class='collapsed '>Kubernetes<img class="state-indicator" src="/assets/images/left-nav-arrow.svg" width="6" height="10"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/latest/installation/kubernetes/amazon-eks-deployment" class=''>Amazon EKS</a></li>
<li><a href="/docs/latest/installation/kubernetes/azure-deployment" class=''>Azure Kubernetes Service</a></li>
<li><a href="/docs/latest/installation/kubernetes/gke-deployment" class=''>Google Kubernetes Engine</a></li>
</nav>
</li>
<li>
<a href="/docs/latest/installation/vmware-installation"
class=''
>VMWare</a>
</li>
</nav>
</li>
<li>
<button type='button' class='group-toggle collapsed '>Setting Up<img class="state-indicator" src="/assets/images/left-nav-arrow.svg" width="6" height="10"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/latest/understanding-configuration"
class=''
>Understanding Configuration</a>
</li>
<li>
<a href="/docs/latest/setup"
class=''
>Setting Up</a>
</li>
<li>
<a href="/docs/latest/logging"
class=''
>Configuring Logging</a>
</li>
<li>
<a href="/docs/latest/resources-injection"
class=''
>Resources Injection</a>
</li>
</nav>
</li>
<li>
<a href="/docs/latest/starting-nodes" class='' >Starting and Stopping Nodes</a>
</li>
<li>
<button type='button' class='group-toggle collapsed '>Clustering<img class="state-indicator" src="/assets/images/left-nav-arrow.svg" width="6" height="10"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/latest/clustering/clustering"
class=''
>Overview</a>
</li>
<li>
<a href="/docs/latest/clustering/tcp-ip-discovery"
class=''
>TCP/IP Discovery</a>
</li>
<li>
<a href="/docs/latest/clustering/zookeeper-discovery"
class=''
>ZooKeeper Discovery</a>
</li>
<li>
<a href="/docs/latest/clustering/discovery-in-the-cloud"
class=''
>Discovery in the Cloud</a>
</li>
<li>
<a href="/docs/latest/clustering/network-configuration"
class=''
>Network Configuration</a>
</li>
<li>
<a href="/docs/latest/clustering/connect-client-nodes"
class=''
>Connecting Client Nodes</a>
</li>
<li>
<a href="/docs/latest/clustering/baseline-topology"
class=''
>Baseline Topology</a>
</li>
<li>
<a href="/docs/latest/clustering/running-client-nodes-behind-nat"
class=''
>Running Client Nodes Behind NAT</a>
</li>
</nav>
</li>
<li>
<button type='button' class='group-toggle expanded '>Thin Clients<img class="state-indicator" src="/assets/images/left-nav-arrow.svg" width="6" height="10"></button>
<nav class='nav-group expanded'>
<li>
<a href="/docs/latest/thin-clients/getting-started-with-thin-clients"
class=''
>Thin Clients Overview</a>
</li>
<li>
<a href="/docs/latest/thin-clients/java-thin-client"
class=''
>Java Thin Client</a>
</li>
<li>
<a href="/docs/latest/thin-clients/dotnet-thin-client"
class=''
>.NET Thin Client</a>
</li>
<li>
<a href="/docs/latest/thin-clients/cpp-thin-client"
class=''
>C++ Thin Client</a>
</li>
<li>
<a href="/docs/latest/thin-clients/python-thin-client"
class=''
>Python Thin Client</a>
</li>
<li>
<a href="/docs/latest/thin-clients/php-thin-client"
class=''
>PHP Thin Client</a>
</li>
<li>
<a href="/docs/latest/thin-clients/nodejs-thin-client"
class=''
>Node.js Thin Client</a>
</li>
<li>
<button
type='button'
class='expanded parent '>Binary Client Protocol<img class="state-indicator" src="/assets/images/left-nav-arrow.svg" width="6" height="10"></button>
<nav class="sub_pages expanded parent">
<li><a href="/docs/latest/binary-client-protocol/binary-client-protocol" class=''>Binary Client Protocol</a></li>
<li><a href="/docs/latest/binary-client-protocol/data-format" class=''>Data Format</a></li>
<li><a href="/docs/latest/binary-client-protocol/key-value-queries" class='active'>Key-Value Queries</a></li>
<li><a href="/docs/latest/binary-client-protocol/sql-and-scan-queries" class=''>SQL and Scan Queries</a></li>
<li><a href="/docs/latest/binary-client-protocol/binary-type-metadata" class=''>Binary Types Metadata</a></li>
<li><a href="/docs/latest/binary-client-protocol/cache-configuration" class=''>Cache Configuration</a></li>
</nav>
</li>
</nav>
</li>
<li>
<button type='button' class='group-toggle collapsed '>Data Modeling<img class="state-indicator" src="/assets/images/left-nav-arrow.svg" width="6" height="10"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/latest/data-modeling/data-modeling"
class=''
>Introduction</a>
</li>
<li>
<a href="/docs/latest/data-modeling/data-partitioning"
class=''
>Data Partitioning</a>
</li>
<li>
<a href="/docs/latest/data-modeling/affinity-collocation"
class=''
>Affinity Colocation</a>
</li>
<li>
<a href="/docs/latest/data-modeling/binary-marshaller"
class=''
>Binary Marshaller</a>
</li>
</nav>
</li>
<li>
<button type='button' class='group-toggle collapsed '>Configuring Memory<img class="state-indicator" src="/assets/images/left-nav-arrow.svg" width="6" height="10"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/latest/memory-architecture"
class=''
>Memory Architecture</a>
</li>
<li>
<a href="/docs/latest/memory-configuration/data-regions"
class=''
>Configuring Data Regions</a>
</li>
<li>
<a href="/docs/latest/memory-configuration/eviction-policies"
class=''
>Eviction Policies</a>
</li>
<li>
<a href="/docs/latest/memory-configuration/replacement-policies"
class=''
>Replacement Policies</a>
</li>
</nav>
</li>
<li>
<button type='button' class='group-toggle collapsed '>Configuring Persistence<img class="state-indicator" src="/assets/images/left-nav-arrow.svg" width="6" height="10"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/latest/persistence/native-persistence"
class=''
>Ignite Persistence</a>
</li>
<li>
<a href="/docs/latest/persistence/external-storage"
class=''
>External Storage</a>
</li>
<li>
<a href="/docs/latest/persistence/swap"
class=''
>Swapping</a>
</li>
<li>
<a href="/docs/latest/persistence/custom-cache-store"
class=''
>Implementing Custom Cache Store</a>
</li>
<li>
<a href="/docs/latest/persistence/snapshot-directory"
class=''
>Configuring Snapshot Directory</a>
</li>
<li>
<a href="/docs/latest/persistence/disk-compression"
class=''
>Disk Compression</a>
</li>
<li>
<a href="/docs/latest/persistence/persistence-tuning"
class=''
>Tuning Persistence</a>
</li>
</nav>
</li>
<li>
<a href="/docs/latest/snapshots/snapshots" class='' >Cluster Snapshots</a>
</li>
<li>
<button type='button' class='group-toggle collapsed '>Configuring Caches<img class="state-indicator" src="/assets/images/left-nav-arrow.svg" width="6" height="10"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/latest/configuring-caches/configuration-overview"
class=''
>Cache Configuration</a>
</li>
<li>
<a href="/docs/latest/configuring-caches/configuring-backups"
class=''
>Configuring Partition Backups</a>
</li>
<li>
<a href="/docs/latest/configuring-caches/partition-loss-policy"
class=''
>Partition Loss Policy</a>
</li>
<li>
<a href="/docs/latest/configuring-caches/atomicity-modes"
class=''
>Atomicity Modes</a>
</li>
<li>
<a href="/docs/latest/configuring-caches/expiry-policies"
class=''
>Expiry Policy</a>
</li>
<li>
<a href="/docs/latest/configuring-caches/on-heap-caching"
class=''
>On-Heap Caching</a>
</li>
<li>
<a href="/docs/latest/configuring-caches/cache-groups"
class=''
>Cache Groups</a>
</li>
<li>
<a href="/docs/latest/configuring-caches/near-cache"
class=''
>Near Caches</a>
</li>
</nav>
</li>
<li>
<a href="/docs/latest/data-rebalancing" class='' >Data Rebalancing</a>
</li>
<li>
<a href="/docs/latest/data-streaming" class='' >Data Streaming</a>
</li>
<li>
<button type='button' class='group-toggle collapsed '>Using Key-Value API<img class="state-indicator" src="/assets/images/left-nav-arrow.svg" width="6" height="10"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/latest/key-value-api/basic-cache-operations"
class=''
>Basic Cache Operations</a>
</li>
<li>
<a href="/docs/latest/key-value-api/binary-objects"
class=''
>Working with Binary Objects</a>
</li>
<li>
<a href="/docs/latest/key-value-api/using-scan-queries"
class=''
>Using Scan Queries</a>
</li>
<li>
<a href="/docs/latest/read-repair"
class=''
>Read Repair</a>
</li>
</nav>
</li>
<li>
<a href="/docs/latest/key-value-api/transactions" class='' >Performing Transactions</a>
</li>
<li>
<button type='button' class='group-toggle collapsed '>Working with SQL<img class="state-indicator" src="/assets/images/left-nav-arrow.svg" width="6" height="10"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/latest/SQL/sql-introduction"
class=''
>Introduction</a>
</li>
<li>
<a href="/docs/latest/SQL/schemas"
class=''
>Understanding Schemas</a>
</li>
<li>
<a href="/docs/latest/SQL/indexes"
class=''
>Defining Indexes</a>
</li>
<li>
<a href="/docs/latest/SQL/sql-api"
class=''
>Using SQL API</a>
</li>
<li>
<a href="/docs/latest/SQL/distributed-joins"
class=''
>Distributed Joins</a>
</li>
<li>
<a href="/docs/latest/SQL/sql-transactions"
class=''
>SQL Transactions</a>
</li>
<li>
<a href="/docs/latest/SQL/custom-sql-func"
class=''
>Custom SQL Functions</a>
</li>
<li>
<a href="/docs/latest/SQL/JDBC/jdbc-driver"
class=''
>JDBC Driver</a>
</li>
<li>
<a href="/docs/latest/SQL/JDBC/jdbc-client-driver"
class=''
>JDBC Client Driver</a>
</li>
<li>
<button
type='button'
class='collapsed '>ODBC Driver<img class="state-indicator" src="/assets/images/left-nav-arrow.svg" width="6" height="10"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/latest/SQL/ODBC/odbc-driver" class=''>ODBC Driver</a></li>
<li><a href="/docs/latest//SQL/ODBC/connection-string-dsn" class=''>Connection String and DSN</a></li>
<li><a href="/docs/latest/SQL/ODBC/querying-modifying-data" class=''>Querying and Modifying Data</a></li>
<li><a href="/docs/latest/SQL/ODBC/specification" class=''>Specification</a></li>
<li><a href="/docs/latest/SQL/ODBC/data-types" class=''>Data Types</a></li>
<li><a href="/docs/latest/SQL/ODBC/error-codes" class=''>Error Codes</a></li>
</nav>
</li>
<li>
<a href="/docs/latest/transactions/mvcc"
class=''
>Multiversion Concurrency Control</a>
</li>
</nav>
</li>
<li>
<button type='button' class='group-toggle collapsed '>SQL Reference<img class="state-indicator" src="/assets/images/left-nav-arrow.svg" width="6" height="10"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/latest/sql-reference/sql-conformance"
class=''
>SQL Conformance</a>
</li>
<li>
<a href="/docs/latest/sql-reference/ddl"
class=''
>Data Definition Language (DDL)</a>
</li>
<li>
<a href="/docs/latest/sql-reference/dml"
class=''
>Data Manipulation Language (DML)</a>
</li>
<li>
<a href="/docs/latest/sql-reference/transactions"
class=''
>Transactions</a>
</li>
<li>
<a href="/docs/latest/sql-reference/operational-commands"
class=''
>Operational Commands</a>
</li>
<li>
<a href="/docs/latest/sql-reference/aggregate-functions"
class=''
>Aggregate functions</a>
</li>
<li>
<a href="/docs/latest/sql-reference/numeric-functions"
class=''
>Numeric Functions</a>
</li>
<li>
<a href="/docs/latest/sql-reference/string-functions"
class=''
>String Functions</a>
</li>
<li>
<a href="/docs/latest/sql-reference/date-time-functions"
class=''
>Data and Time Functions</a>
</li>
<li>
<a href="/docs/latest/sql-reference/system-functions"
class=''
>System Functions</a>
</li>
<li>
<a href="/docs/latest/sql-reference/data-types"
class=''
>Data Types</a>
</li>
</nav>
</li>
<li>
<button type='button' class='group-toggle collapsed '>Distributed Computing<img class="state-indicator" src="/assets/images/left-nav-arrow.svg" width="6" height="10"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/latest/distributed-computing/distributed-computing"
class=''
>Distributed Computing API</a>
</li>
<li>
<a href="/docs/latest/distributed-computing/cluster-groups"
class=''
>Cluster Groups</a>
</li>
<li>
<a href="/docs/latest/distributed-computing/executor-service"
class=''
>Executor Service</a>
</li>
<li>
<a href="/docs/latest/distributed-computing/map-reduce"
class=''
>MapReduce API</a>
</li>
<li>
<a href="/docs/latest/distributed-computing/load-balancing"
class=''
>Load Balancing</a>
</li>
<li>
<a href="/docs/latest/distributed-computing/fault-tolerance"
class=''
>Fault Tolerance</a>
</li>
<li>
<a href="/docs/latest/distributed-computing/job-scheduling"
class=''
>Job Scheduling</a>
</li>
<li>
<a href="/docs/latest/distributed-computing/collocated-computations"
class=''
>Colocating Computations with Data</a>
</li>
</nav>
</li>
<li>
<button type='button' class='group-toggle collapsed '>Code Deployment<img class="state-indicator" src="/assets/images/left-nav-arrow.svg" width="6" height="10"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/latest/code-deployment/deploying-user-code"
class=''
>Deploying User Code</a>
</li>
<li>
<a href="/docs/latest/code-deployment/peer-class-loading"
class=''
>Peer Class Loading</a>
</li>
</nav>
</li>
<li>
<button type='button' class='group-toggle collapsed '>Machine Learning<img class="state-indicator" src="/assets/images/left-nav-arrow.svg" width="6" height="10"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/latest/machine-learning/machine-learning"
class=''
>Machine Learning</a>
</li>
<li>
<a href="/docs/latest/machine-learning/partition-based-dataset"
class=''
>Partition Based Dataset</a>
</li>
<li>
<a href="/docs/latest/machine-learning/updating-trained-models"
class=''
>Updating Trained Models</a>
</li>
<li>
<button
type='button'
class='collapsed '>Binary Classification<img class="state-indicator" src="/assets/images/left-nav-arrow.svg" width="6" height="10"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/latest/machine-learning/binary-classification/introduction" class=''>Introduction</a></li>
<li><a href="/docs/latest/machine-learning/binary-classification/linear-svm" class=''>Linear SVM (Support Vector Machine)</a></li>
<li><a href="/docs/latest/machine-learning/binary-classification/decision-trees" class=''>Decision Trees</a></li>
<li><a href="/docs/latest/machine-learning/binary-classification/multilayer-perceptron" class=''>Multilayer Perceptron</a></li>
<li><a href="/docs/latest/machine-learning/binary-classification/logistic-regression" class=''>Logistic Regression</a></li>
<li><a href="/docs/latest/machine-learning/binary-classification/knn-classification" class=''>k-NN Classification</a></li>
<li><a href="/docs/latest/machine-learning/binary-classification/ann" class=''>ANN (Approximate Nearest Neighbor)</a></li>
<li><a href="/docs/latest/machine-learning/binary-classification/naive-bayes" class=''>Naive Bayes</a></li>
</nav>
</li>
<li>
<button
type='button'
class='collapsed '>Regression<img class="state-indicator" src="/assets/images/left-nav-arrow.svg" width="6" height="10"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/latest/machine-learning/regression/introduction" class=''>Introduction</a></li>
<li><a href="/docs/latest/machine-learning/regression/linear-regression" class=''>Linear Regression</a></li>
<li><a href="/docs/latest/machine-learning/regression/decision-trees-regression" class=''>Decision Trees Regression</a></li>
<li><a href="/docs/latest/machine-learning/regression/knn-regression" class=''>k-NN Regression</a></li>
</nav>
</li>
<li>
<button
type='button'
class='collapsed '>Clustering<img class="state-indicator" src="/assets/images/left-nav-arrow.svg" width="6" height="10"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/latest/machine-learning/clustering/introduction" class=''>Introduction</a></li>
<li><a href="/docs/latest/machine-learning/clustering/k-means-clustering" class=''>K-Means Clustering</a></li>
<li><a href="/docs/latest/machine-learning/clustering/gaussian-mixture" class=''>Gaussian mixture (GMM)</a></li>
</nav>
</li>
<li>
<a href="/docs/latest/machine-learning/preprocessing"
class=''
>Preprocessing</a>
</li>
<li>
<button
type='button'
class='collapsed '>Model Selection<img class="state-indicator" src="/assets/images/left-nav-arrow.svg" width="6" height="10"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/latest/machine-learning/model-selection/introduction" class=''>Introduction</a></li>
<li><a href="/docs/latest/machine-learning/model-selection/evaluator" class=''>Evaluator</a></li>
<li><a href="/docs/latest/machine-learning/model-selection/split-the-dataset-on-test-and-train-datasets" class=''>Split the dataset on test and train datasets</a></li>
<li><a href="/docs/latest/machine-learning/model-selection/hyper-parameter-tuning" class=''>Hyper-parameter tuning</a></li>
<li><a href="/docs/latest/machine-learning/model-selection/pipeline-api" class=''>Pipeline API</a></li>
</nav>
</li>
<li>
<a href="/docs/latest/machine-learning/multiclass-classification"
class=''
>Multiclass Classification</a>
</li>
<li>
<button
type='button'
class='collapsed '>Ensemble Methods<img class="state-indicator" src="/assets/images/left-nav-arrow.svg" width="6" height="10"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/latest/machine-learning/ensemble-methods/introduction" class=''></a></li>
<li><a href="/docs/latest/machine-learning/ensemble-methods/stacking" class=''>Stacking</a></li>
<li><a href="/docs/latest/machine-learning/ensemble-methods/baggin" class=''>Bagging</a></li>
<li><a href="/docs/latest/machine-learning/ensemble-methods/random-forest" class=''>Random Forest</a></li>
<li><a href="/docs/latest/machine-learning/ensemble-methods/gradient-boosting" class=''>Gradient Boosting</a></li>
</nav>
</li>
<li>
<a href="/docs/latest/machine-learning/recommendation-systems"
class=''
>Recommendation Systems</a>
</li>
<li>
<button
type='button'
class='collapsed '>Importing Model<img class="state-indicator" src="/assets/images/left-nav-arrow.svg" width="6" height="10"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/latest/machine-learning/importing-model/introduction" class=''>Introduction</a></li>
<li><a href="/docs/latest/machine-learning/importing-model/model-import-from-gxboost" class=''>Import Model from XGBoost</a></li>
<li><a href="/docs/latest/machine-learning/importing-model/model-import-from-apache-spark" class=''>Import Model from Apache Spark</a></li>
</nav>
</li>
</nav>
</li>
<li>
<a href="/docs/latest/key-value-api/continuous-queries" class='' >Using Continuous Queries</a>
</li>
<li>
<a href="/docs/latest/services/services" class='' >Using Ignite Services</a>
</li>
<li>
<a href="/docs/latest/messaging" class='' >Using Ignite Messaging</a>
</li>
<li>
<button type='button' class='group-toggle collapsed '>Distributed Data Structures<img class="state-indicator" src="/assets/images/left-nav-arrow.svg" width="6" height="10"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/latest/data-structures/queue-and-set"
class=''
>Queue and Set</a>
</li>
<li>
<a href="/docs/latest/data-structures/atomic-types"
class=''
>Atomic Types</a>
</li>
<li>
<a href="/docs/latest/data-structures/countdownlatch"
class=''
>CountDownLatch</a>
</li>
<li>
<a href="/docs/latest/data-structures/atomic-sequence"
class=''
>Atomic Sequence</a>
</li>
<li>
<a href="/docs/latest/data-structures/semaphore"
class=''
>Semaphore</a>
</li>
<li>
<a href="/docs/latest/data-structures/id-generator"
class=''
>ID Generator</a>
</li>
</nav>
</li>
<li>
<a href="/docs/latest/distributed-locks" class='' >Distributed Locks</a>
</li>
<li>
<a href="/docs/latest/restapi" class='' >REST API</a>
</li>
<li>
<button type='button' class='group-toggle collapsed '>.NET Specific<img class="state-indicator" src="/assets/images/left-nav-arrow.svg" width="6" height="10"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/latest/net-specific/net-configuration-options"
class=''
>Configuration Options</a>
</li>
<li>
<a href="/docs/latest/net-specific/net-deployment-options"
class=''
>Deployment Options</a>
</li>
<li>
<a href="/docs/latest/net-specific/net-standalone-nodes"
class=''
>Standalone Nodes</a>
</li>
<li>
<a href="/docs/latest/net-specific/net-async"
class=''
>Asynchronous APIs</a>
</li>
<li>
<a href="/docs/latest/net-specific/net-logging"
class=''
>Logging</a>
</li>
<li>
<a href="/docs/latest/net-specific/net-linq"
class=''
>LINQ</a>
</li>
<li>
<a href="/docs/latest/net-specific/net-java-services-execution"
class=''
>Java Services Execution</a>
</li>
<li>
<a href="/docs/latest/net-specific/net-platform-cache"
class=''
>.NET Platform Cache</a>
</li>
<li>
<a href="/docs/latest/net-specific/net-plugins"
class=''
>Plugins</a>
</li>
<li>
<a href="/docs/latest/net-specific/net-serialization"
class=''
>Serialization</a>
</li>
<li>
<a href="/docs/latest/net-specific/net-cross-platform-support"
class=''
>Cross-Platform Support</a>
</li>
<li>
<a href="/docs/latest/net-specific/net-platform-interoperability"
class=''
>Platform Interoperability</a>
</li>
<li>
<a href="/docs/latest/net-specific/net-remote-assembly-loading"
class=''
>Remote Assembly Loading</a>
</li>
<li>
<a href="/docs/latest/net-specific/net-troubleshooting"
class=''
>Troubleshooting</a>
</li>
<li>
<button
type='button'
class='collapsed '>Integrations<img class="state-indicator" src="/assets/images/left-nav-arrow.svg" width="6" height="10"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/latest/net-specific/asp-net-output-caching" class=''>ASP.NET Output Caching</a></li>
<li><a href="/docs/latest/net-specific/asp-net-session-state-caching" class=''>ASP.NET Session State Caching</a></li>
<li><a href="/docs/latest/net-specific/net-entity-framework-cache" class=''>Entity Framework 2nd Level Cache</a></li>
</nav>
</li>
</nav>
</li>
<li>
<button type='button' class='group-toggle collapsed '>C++ Specific<img class="state-indicator" src="/assets/images/left-nav-arrow.svg" width="6" height="10"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/latest/cpp-specific/cpp-serialization"
class=''
>Serialization</a>
</li>
<li>
<a href="/docs/latest/cpp-specific/cpp-platform-interoperability"
class=''
>Platform Interoperability</a>
</li>
<li>
<a href="/docs/latest/cpp-specific/cpp-objects-lifetime"
class=''
>Objects Lifetime</a>
</li>
</nav>
</li>
<li>
<button type='button' class='group-toggle collapsed '>Monitoring<img class="state-indicator" src="/assets/images/left-nav-arrow.svg" width="6" height="10"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/latest/monitoring-metrics/intro"
class=''
>Introduction</a>
</li>
<li>
<a href="/docs/latest/monitoring-metrics/cluster-id"
class=''
>Cluster ID and Tag</a>
</li>
<li>
<a href="/docs/latest/monitoring-metrics/cluster-states"
class=''
>Cluster States</a>
</li>
<li>
<button
type='button'
class='collapsed '>Metrics<img class="state-indicator" src="/assets/images/left-nav-arrow.svg" width="6" height="10"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/latest/monitoring-metrics/configuring-metrics" class=''>Configuring Metrics</a></li>
<li><a href="/docs/latest/monitoring-metrics/metrics" class=''>JMX Metrics</a></li>
</nav>
</li>
<li>
<button
type='button'
class='collapsed '>New Metrics System<img class="state-indicator" src="/assets/images/left-nav-arrow.svg" width="6" height="10"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/latest/monitoring-metrics/new-metrics-system" class=''>Introduction</a></li>
<li><a href="/docs/latest/monitoring-metrics/new-metrics" class=''>Metrics</a></li>
</nav>
</li>
<li>
<a href="/docs/latest/monitoring-metrics/system-views"
class=''
>System Views</a>
</li>
<li>
<a href="/docs/latest/monitoring-metrics/performance-statistics"
class=''
>Performance Statistics</a>
</li>
<li>
<a href="/docs/latest/monitoring-metrics/tracing"
class=''
>Tracing</a>
</li>
</nav>
</li>
<li>
<button type='button' class='group-toggle collapsed '>Working with Events<img class="state-indicator" src="/assets/images/left-nav-arrow.svg" width="6" height="10"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/latest/events/listening-to-events"
class=''
>Enabling and Listenting to Events</a>
</li>
<li>
<a href="/docs/latest/events/events"
class=''
>Events</a>
</li>
</nav>
</li>
<li>
<button type='button' class='group-toggle collapsed '>Tools<img class="state-indicator" src="/assets/images/left-nav-arrow.svg" width="6" height="10"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/latest/tools/control-script"
class=''
>Control Script</a>
</li>
<li>
<a href="/docs/latest/tools/visor-cmd"
class=''
>Visor CMD</a>
</li>
<li>
<a href="/docs/latest/tools/gg-control-center"
class=''
>GridGain Control Center</a>
</li>
<li>
<a href="/docs/latest/tools/sqlline"
class=''
>SQLLine</a>
</li>
<li>
<a href="/docs/latest/tools/tableau"
class=''
>Tableau</a>
</li>
<li>
<a href="/docs/latest/tools/informatica"
class=''
>Informatica</a>
</li>
<li>
<a href="/docs/latest/tools/pentaho"
class=''
>Pentaho</a>
</li>
</nav>
</li>
<li>
<button type='button' class='group-toggle collapsed '>Security<img class="state-indicator" src="/assets/images/left-nav-arrow.svg" width="6" height="10"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/latest/security/authentication"
class=''
>Authentication</a>
</li>
<li>
<a href="/docs/latest/security/ssl-tls"
class=''
>SSL/TLS</a>
</li>
<li>
<button
type='button'
class='collapsed '>Transparent Data Encryption<img class="state-indicator" src="/assets/images/left-nav-arrow.svg" width="6" height="10"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/latest/security/tde" class=''>Introduction</a></li>
<li><a href="/docs/latest/security/master-key-rotation" class=''>Master key rotation</a></li>
<li><a href="/docs/latest/security/cache-encryption-key-rotation" class=''>Cache encryption key rotation</a></li>
</nav>
</li>
<li>
<a href="/docs/latest/security/sandbox"
class=''
>Sandbox</a>
</li>
</nav>
</li>
<li>
<button type='button' class='group-toggle collapsed '>Extensions and Integrations<img class="state-indicator" src="/assets/images/left-nav-arrow.svg" width="6" height="10"></button>
<nav class='nav-group collapsed'>
<li>
<button
type='button'
class='collapsed '>Spring<img class="state-indicator" src="/assets/images/left-nav-arrow.svg" width="6" height="10"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/latest/extensions-and-integrations/spring/spring-boot" class=''>Spring Boot</a></li>
<li><a href="/docs/latest/extensions-and-integrations/spring/spring-data" class=''>Spring Data</a></li>
<li><a href="/docs/latest/extensions-and-integrations/spring/spring-caching" class=''>Spring Caching</a></li>
<li><a href="/docs/latest/extensions-and-integrations/spring/spring-tx" class=''>Spring Transactions</a></li>
</nav>
</li>
<li>
<button
type='button'
class='collapsed '>Ignite for Spark<img class="state-indicator" src="/assets/images/left-nav-arrow.svg" width="6" height="10"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/latest/extensions-and-integrations/ignite-for-spark/overview" class=''>Overview</a></li>
<li><a href="/docs/latest/extensions-and-integrations/ignite-for-spark/ignitecontext-and-rdd" class=''>IgniteContext and IgniteRDD</a></li>
<li><a href="/docs/latest/extensions-and-integrations/ignite-for-spark/ignite-dataframe" class=''>Ignite DataFrame</a></li>
<li><a href="/docs/latest/extensions-and-integrations/ignite-for-spark/installation" class=''>Installation</a></li>
<li><a href="/docs/latest/extensions-and-integrations/ignite-for-spark/spark-shell" class=''>Test Ignite with Spark-shell</a></li>
<li><a href="/docs/latest/extensions-and-integrations/ignite-for-spark/troubleshooting" class=''>Troubleshooting</a></li>
</nav>
</li>
<li>
<a href="/docs/latest/extensions-and-integrations/hibernate-l2-cache"
class=''
>Hibernate L2 Cache</a>
</li>
<li>
<a href="/docs/latest/extensions-and-integrations/mybatis-l2-cache"
class=''
>MyBatis L2 Cache</a>
</li>
<li>
<button
type='button'
class='collapsed '>Streaming<img class="state-indicator" src="/assets/images/left-nav-arrow.svg" width="6" height="10"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/latest/extensions-and-integrations/streaming/kafka-streamer" class=''>Kafka Streamer</a></li>
<li><a href="/docs/latest/extensions-and-integrations/streaming/camel-streamer" class=''>Camel Streamer</a></li>
<li><a href="/docs/latest/extensions-and-integrations/streaming/flink-streamer" class=''>Flink Streamer</a></li>
<li><a href="/docs/latest/extensions-and-integrations/streaming/flume-sink" class=''>Flume Sink</a></li>
<li><a href="/docs/latest/extensions-and-integrations/streaming/jms-streamer" class=''>JMS Streamer</a></li>
<li><a href="/docs/latest/extensions-and-integrations/streaming/mqtt-streamer" class=''>MQTT Streamer</a></li>
<li><a href="/docs/latest/extensions-and-integrations/streaming/rocketmq-streamer" class=''>RocketMQ Streamer</a></li>
<li><a href="/docs/latest/extensions-and-integrations/streaming/storm-streamer" class=''>Storm Streamer</a></li>
<li><a href="/docs/latest/extensions-and-integrations/streaming/zeromq-streamer" class=''>ZeroMQ Streamer</a></li>
<li><a href="/docs/latest/extensions-and-integrations/streaming/twitter-streamer" class=''>Twitter Streamer</a></li>
</nav>
</li>
<li>
<button
type='button'
class='collapsed '>Cassandra Integration<img class="state-indicator" src="/assets/images/left-nav-arrow.svg" width="6" height="10"></button>
<nav class="sub_pages collapsed">
<li><a href="/docs/latest/extensions-and-integrations/cassandra/overview" class=''>Overview</a></li>
<li><a href="/docs/latest/extensions-and-integrations/cassandra/configuration" class=''>Configuration</a></li>
<li><a href="/docs/latest/extensions-and-integrations/cassandra/usage-examples" class=''>Usage Examples</a></li>
<li><a href="/docs/latest/extensions-and-integrations/cassandra/ddl-generator" class=''>DDL Generator</a></li>
</nav>
</li>
<li>
<a href="/docs/latest/extensions-and-integrations/php-pdo"
class=''
>PHP PDO</a>
</li>
<li>
<a href="/docs/latest/extensions-and-integrations/performance-statistics"
class=''
>Performance Statistics</a>
</li>
</nav>
</li>
<li>
<a href="/docs/latest/plugins" class='' >Plugins</a>
</li>
<li>
<button type='button' class='group-toggle collapsed '>Performance and Troubleshooting<img class="state-indicator" src="/assets/images/left-nav-arrow.svg" width="6" height="10"></button>
<nav class='nav-group collapsed'>
<li>
<a href="/docs/latest/perf-and-troubleshooting/general-perf-tips"
class=''
>General Performance Tips</a>
</li>
<li>
<a href="/docs/latest/perf-and-troubleshooting/memory-tuning"
class=''
>Memory and JVM Tuning</a>
</li>
<li>
<a href="/docs/latest/perf-and-troubleshooting/persistence-tuning"
class=''
>Persistence Tuning</a>
</li>
<li>
<a href="/docs/latest/perf-and-troubleshooting/sql-tuning"
class=''
>SQL Tuning</a>
</li>
<li>
<a href="/docs/latest/perf-and-troubleshooting/thread-pools-tuning"
class=''
>Thread Pools Tuning</a>
</li>
<li>
<a href="/docs/latest/perf-and-troubleshooting/troubleshooting"
class=''
>Troubleshooting and Debugging</a>
</li>
<li>
<a href="/docs/latest/perf-and-troubleshooting/handling-exceptions"
class=''
>Handling Exceptions</a>
</li>
<li>
<a href="/docs/latest/perf-and-troubleshooting/yardstick-benchmarking"
class=''
>Benchmarking With Yardstick</a>
</li>
</nav>
</li>
</nav>
<div class="left-nav__overlay"></div>
<article data-swiftype-index='true'>
<a class='edit-link' href="https://github.com/apache/ignite/tree/IGNITE-7595/docs/_docs/binary-client-protocol/key-value-queries.adoc" target="_blank">Edit</a>
<h1>Key-Value Queries</h1>
<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p>This page describes the key-value operations that you can perform with a cache. The key-value operations are equivalent to Ignite&#8217;s native cache operations. Each operation has a <a href="/docs/latest/binary-client-protocol/binary-client-protocol#standard-message-header">header</a> and operation-specific data.</p>
</div>
<div class="paragraph">
<p>Refer to the Data Format page for a list of available data types and data format specification.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="operation-codes">Operation Codes</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Upon successful handshake with an Ignite server node, a client can start performing various key-value operations by sending a request (see request/response structure below) with a specific operation code:</p>
</div>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 66.6666%;">
<col style="width: 33.3334%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Operation</th>
<th class="tableblock halign-left valign-top">OP_CODE</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">OP_CACHE_GET</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">1000</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">OP_CACHE_PUT</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">1001</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">OP_CACHE_PUT_IF_ABSENT</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">1002</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">OP_CACHE_GET_ALL</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">1003</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">OP_CACHE_PUT_ALL</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">1004</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">OP_CACHE_GET_AND_PUT</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">1005</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">OP_CACHE_GET_AND_REPLACE</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">1006</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">OP_CACHE_GET_AND_REMOVE</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">1007</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">OP_CACHE_GET_AND_PUT_IF_ABSENT</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">1008</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">OP_CACHE_REPLACE</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">1009</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">OP_CACHE_REPLACE_IF_EQUALS</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">1010</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">OP_CACHE_CONTAINS_KEY</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">1011</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">OP_CACHE_CONTAINS_KEYS</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">1012</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">OP_CACHE_CLEAR</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">1013</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">OP_CACHE_CLEAR_KEY</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">1014</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">OP_CACHE_CLEAR_KEYS</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">1015</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">OP_CACHE_REMOVE_KEY</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">1016</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">OP_CACHE_REMOVE_IF_EQUALS</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">1017</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">OP_CACHE_REMOVE_KEYS</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">1018</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">OP_CACHE_REMOVE_ALL</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">1019</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">OP_CACHE_GET_SIZE</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">1020</p></td>
</tr>
</tbody>
</table>
<div class="paragraph">
<p>Note that the above mentioned op_codes are part of the request header, as explained <a href="/docs/latest/binary-client-protocol/binary-client-protocol#standard-message-header">here</a>.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">
<h3 id="customs-methods-used-in-sample-code-snippets-implementation" class="discrete">Customs Methods Used in Sample Code Snippets Implementation</h3>
<div class="paragraph">
<p>Some of the code snippets below use <code>readDataObject(&#8230;&#8203;)</code> introduced in <a href="/docs/latest/binary-client-protocol/binary-client-protocol#data-objects">this section</a> and little-endian versions of methods for reading and writing multiple-byte values that are covered in <a href="/docs/latest/binary-client-protocol/binary-client-protocol#data-objects">this example</a>.</p>
</div>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="op_cache_get">OP_CACHE_GET</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Retrieves a value from a cache by key. If the cache does not contain the key, null is returned.</p>
</div>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Request Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Request header.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Cache ID: Java-style hash code of the cache name.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">byte</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Use 0. This field is deprecated and will be removed in the future.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Data Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The key of the cache entry to be returned.</p></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Response Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Response header.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Data Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The value that corresponds to the given key. null if the cache does not contain the key.</p></td>
</tr>
</tbody>
</table>
<code-tabs><code-tab data-tab='Request'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="nc">DataOutputStream</span> <span class="n">out</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataOutputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getOutputStream</span><span class="o">());</span>
<span class="c1">// Request header</span>
<span class="n">writeRequestHeader</span><span class="o">(</span><span class="mi">10</span><span class="o">,</span> <span class="no">OP_CACHE_GET</span><span class="o">,</span> <span class="mi">1</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Cache id</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">cacheName</span><span class="o">.</span><span class="na">hashCode</span><span class="o">(),</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Flags = none</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">0</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Data object</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">3</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Integer type code</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">key</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Cache key</span></code></pre>
</div>
</div></code-tab><code-tab data-tab='Response'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="c1">// Read result</span>
<span class="nc">DataInputStream</span> <span class="n">in</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataInputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getInputStream</span><span class="o">());</span>
<span class="c1">// Response header</span>
<span class="n">readResponseHeader</span><span class="o">(</span><span class="n">in</span><span class="o">);</span>
<span class="c1">// Resulting cache value (Data Object)</span>
<span class="kt">int</span> <span class="n">resTypeCode</span> <span class="o">=</span> <span class="n">readByteLittleEndian</span><span class="o">(</span><span class="n">in</span><span class="o">);</span>
<span class="kt">int</span> <span class="n">value</span> <span class="o">=</span> <span class="n">readIntLittleEndian</span><span class="o">(</span><span class="n">in</span><span class="o">);</span></code></pre>
</div>
</div></code-tab></code-tabs>
</div>
</div>
<div class="sect1">
<h2 id="op_cache_get_all">OP_CACHE_GET_ALL</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Retrieves multiple key-value pairs from a cache.</p>
</div>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Request Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Request header.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Cache ID: Java-style hash code of the cache name.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">byte</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Use 0. This field is deprecated and will be removed in the future.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Key count.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Data Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Key for the cache entry.</p>
<p class="tableblock">Repeat for as many times as the key count that is passed in the previous parameter.</p></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Response Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Response header.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Result count.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Key Data Object + Value Data Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Resulting key-value pairs. Keys that are not present in the cache are not included.</p>
<p class="tableblock">Repeat for as many times as the result count that is obtained in the previous parameter.</p></td>
</tr>
</tbody>
</table>
<code-tabs><code-tab data-tab='Request'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="nc">DataOutputStream</span> <span class="n">out</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataOutputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getOutputStream</span><span class="o">());</span>
<span class="c1">// Request header</span>
<span class="n">writeRequestHeader</span><span class="o">(</span><span class="mi">19</span><span class="o">,</span> <span class="no">OP_CACHE_GET_ALL</span><span class="o">,</span> <span class="mi">1</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Cache id</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">cacheName</span><span class="o">.</span><span class="na">hashCode</span><span class="o">(),</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Flags = none</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">0</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Key count</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="mi">2</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Data object 1</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">3</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Integer type code</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">key1</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Cache key</span>
<span class="c1">// Data object 2</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">3</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Integer type code</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">key2</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Cache key</span></code></pre>
</div>
</div></code-tab><code-tab data-tab='Response'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="c1">// Read result</span>
<span class="nc">DataInputStream</span> <span class="n">in</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataInputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getInputStream</span><span class="o">());</span>
<span class="c1">// Response header</span>
<span class="n">readResponseHeader</span><span class="o">(</span><span class="n">in</span><span class="o">);</span>
<span class="c1">// Result count</span>
<span class="kt">int</span> <span class="n">resCount</span> <span class="o">=</span> <span class="n">readIntLittleEndian</span><span class="o">(</span><span class="n">in</span><span class="o">);</span>
<span class="k">for</span> <span class="o">(</span><span class="kt">int</span> <span class="n">i</span> <span class="o">=</span> <span class="mi">0</span><span class="o">;</span> <span class="n">i</span> <span class="o">&lt;</span> <span class="n">resCount</span><span class="o">;</span> <span class="n">i</span><span class="o">++)</span> <span class="o">{</span>
<span class="c1">// Resulting data object</span>
<span class="kt">int</span> <span class="n">resKeyTypeCode</span> <span class="o">=</span> <span class="n">readByteLittleEndian</span><span class="o">(</span><span class="n">in</span><span class="o">);</span> <span class="c1">// Integer type code</span>
<span class="kt">int</span> <span class="n">resKey</span> <span class="o">=</span> <span class="n">readIntLittleEndian</span><span class="o">(</span><span class="n">in</span><span class="o">);</span> <span class="c1">// Cache key</span>
<span class="c1">// Resulting data object</span>
<span class="kt">int</span> <span class="n">resValTypeCode</span> <span class="o">=</span> <span class="n">readByteLittleEndian</span><span class="o">(</span><span class="n">in</span><span class="o">);</span> <span class="c1">// Integer type code</span>
<span class="kt">int</span> <span class="n">resValue</span> <span class="o">=</span> <span class="n">readIntLittleEndian</span><span class="o">(</span><span class="n">in</span><span class="o">);</span> <span class="c1">// Cache value</span>
<span class="o">}</span></code></pre>
</div>
</div></code-tab></code-tabs>
</div>
</div>
<div class="sect1">
<h2 id="op_cache_put">OP_CACHE_PUT</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Puts a value with a given key to a cache (overwriting existing value if any).</p>
</div>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Request Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Request Header.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Cache ID: Java-style hash code of the cache name.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">byte</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Use 0. This field is deprecated and will be removed in the future.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Data Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Key for the cache entry.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Data Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Value for the key.</p></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Response Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Response Header</p></td>
</tr>
</tbody>
</table>
<code-tabs><code-tab data-tab='Request'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="nc">DataOutputStream</span> <span class="n">out</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataOutputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getOutputStream</span><span class="o">());</span>
<span class="c1">// Request header</span>
<span class="n">writeRequestHeader</span><span class="o">(</span><span class="mi">15</span><span class="o">,</span> <span class="no">OP_CACHE_PUT</span><span class="o">,</span> <span class="mi">1</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Cache id</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">cacheName</span><span class="o">.</span><span class="na">hashCode</span><span class="o">(),</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Flags = none</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">0</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Cache key data object</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">3</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Integer type code</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">key</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Cache key</span>
<span class="c1">// Cache value data object</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">3</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Integer type code</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">value</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Cache value</span></code></pre>
</div>
</div></code-tab><code-tab data-tab='Response'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="c1">// Read result</span>
<span class="nc">DataInputStream</span> <span class="n">in</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataInputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getInputStream</span><span class="o">());</span>
<span class="c1">// Response header</span>
<span class="n">readResponseHeader</span><span class="o">(</span><span class="n">in</span><span class="o">);</span></code></pre>
</div>
</div></code-tab></code-tabs>
</div>
</div>
<div class="sect1">
<h2 id="op_cache_put_all">OP_CACHE_PUT_ALL</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Puts multiple key-value pairs to cache (overwriting existing associations if any).</p>
</div>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Request Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Request Header.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Cache ID: Java-style hash code of the cache name.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">byte</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Use 0. This field is deprecated and will be removed in the future.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Key-value pair count</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Key Data Object + Value Data</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Object Key-value pairs.</p>
<p class="tableblock">Repeat for as many times as the key-value pair count that is passed in the previous parameter.</p></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Response Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Response header.</p></td>
</tr>
</tbody>
</table>
<code-tabs><code-tab data-tab='Request'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="nc">DataOutputStream</span> <span class="n">out</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataOutputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getOutputStream</span><span class="o">());</span>
<span class="c1">// Request header</span>
<span class="n">writeRequestHeader</span><span class="o">(</span><span class="mi">29</span><span class="o">,</span> <span class="no">OP_CACHE_PUT_ALL</span><span class="o">,</span> <span class="mi">1</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Cache id</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">cacheName</span><span class="o">.</span><span class="na">hashCode</span><span class="o">(),</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Flags = none</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">0</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Entry Count</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="mi">2</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Cache key data object 1</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">3</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Integer type code</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">key1</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Cache key</span>
<span class="c1">// Cache value data object 1</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">3</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Integer type code</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">value1</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Cache value</span>
<span class="c1">// Cache key data object 2</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">3</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Integer type code</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">key2</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Cache key</span>
<span class="c1">// Cache value data object 2</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">3</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Integer type code</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">value2</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Cache value</span></code></pre>
</div>
</div></code-tab><code-tab data-tab='Response'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="c1">// Read result</span>
<span class="nc">DataInputStream</span> <span class="n">in</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataInputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getInputStream</span><span class="o">());</span>
<span class="c1">// Response header</span>
<span class="n">readResponseHeader</span><span class="o">(</span><span class="n">in</span><span class="o">);</span></code></pre>
</div>
</div></code-tab></code-tabs>
</div>
</div>
<div class="sect1">
<h2 id="op_cache_contains_key">OP_CACHE_CONTAINS_KEY</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Returns a value indicating whether given key is present in cache.</p>
</div>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Request Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Request Header.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Cache ID: Java-style hash code of the cache name.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">byte</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Use 0. This field is deprecated and will be removed in the future.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Data Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Key for the cache entry.</p></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Response Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Response header.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">bool</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">True when key is present, false otherwise.</p></td>
</tr>
</tbody>
</table>
<code-tabs><code-tab data-tab='Request'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="nc">DataOutputStream</span> <span class="n">out</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataOutputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getOutputStream</span><span class="o">());</span>
<span class="c1">// Request header</span>
<span class="n">writeRequestHeader</span><span class="o">(</span><span class="mi">10</span><span class="o">,</span> <span class="no">OP_CACHE_CONTAINS_KEY</span><span class="o">,</span> <span class="mi">1</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Cache id</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">cacheName</span><span class="o">.</span><span class="na">hashCode</span><span class="o">(),</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Flags = none</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">0</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Cache key data object</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">3</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Integer type code</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">key</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Cache key</span></code></pre>
</div>
</div></code-tab><code-tab data-tab='Response'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="c1">// Read result</span>
<span class="nc">DataInputStream</span> <span class="n">in</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataInputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getInputStream</span><span class="o">());</span>
<span class="c1">// Response header</span>
<span class="n">readResponseHeader</span><span class="o">(</span><span class="n">in</span><span class="o">);</span>
<span class="c1">// Result</span>
<span class="kt">boolean</span> <span class="n">res</span> <span class="o">=</span> <span class="n">readBooleanLittleEndian</span><span class="o">(</span><span class="n">in</span><span class="o">);</span></code></pre>
</div>
</div></code-tab></code-tabs>
</div>
</div>
<div class="sect1">
<h2 id="op_cache_contains_keys">OP_CACHE_CONTAINS_KEYS</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Returns a value indicating whether all given keys are present in cache.</p>
</div>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Request Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Request Header.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Cache ID: Java-style hash code of the cache name.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">byte</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Use 0. This field is deprecated and will be removed in the future.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Key count.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Data Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Key obtained from cache.</p>
<p class="tableblock">Repeat for as many times as the key count that is passed in the previous parameter.</p></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Response Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Response header.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">bool</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">True when keys are present, false otherwise.</p></td>
</tr>
</tbody>
</table>
<code-tabs><code-tab data-tab='Request'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="nc">DataOutputStream</span> <span class="n">out</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataOutputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getOutputStream</span><span class="o">());</span>
<span class="c1">// Request header</span>
<span class="n">writeRequestHeader</span><span class="o">(</span><span class="mi">19</span><span class="o">,</span> <span class="no">OP_CACHE_CONTAINS_KEYS</span><span class="o">,</span> <span class="mi">1</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Cache id</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">cacheName</span><span class="o">.</span><span class="na">hashCode</span><span class="o">(),</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Flags = none</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">0</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">//Count</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="mi">2</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Cache key data object 1</span>
<span class="kt">int</span> <span class="n">key1</span> <span class="o">=</span> <span class="mi">11</span><span class="o">;</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">3</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Integer type code</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">key1</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Cache key</span>
<span class="c1">// Cache key data object 2</span>
<span class="kt">int</span> <span class="n">key2</span> <span class="o">=</span> <span class="mi">22</span><span class="o">;</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">3</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Integer type code</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">key2</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Cache key</span></code></pre>
</div>
</div></code-tab><code-tab data-tab='Response'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="c1">// Read result</span>
<span class="nc">DataInputStream</span> <span class="n">in</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataInputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getInputStream</span><span class="o">());</span>
<span class="c1">// Response header</span>
<span class="n">readResponseHeader</span><span class="o">(</span><span class="n">in</span><span class="o">);</span>
<span class="c1">// Resulting boolean value</span>
<span class="kt">boolean</span> <span class="n">res</span> <span class="o">=</span> <span class="n">readBooleanLittleEndian</span><span class="o">(</span><span class="n">in</span><span class="o">);</span></code></pre>
</div>
</div></code-tab></code-tabs>
</div>
</div>
<div class="sect1">
<h2 id="op_cache_get_and_put">OP_CACHE_GET_AND_PUT</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Puts a key and an associated value into a cache and returns the previous value for that key. If the cache does not contain the key, a new entry is created and null is returned.</p>
</div>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Request Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Request Header.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Cache ID: Java-style hash code of the cache name.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">byte</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Use 0. This field is deprecated and will be removed in the future.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Data Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The key to be updated.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Data Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The new value for the specified key.</p></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Response Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Response header.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Data Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The existing value associated with the specified key, or null.</p></td>
</tr>
</tbody>
</table>
<code-tabs><code-tab data-tab='Request'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="nc">DataOutputStream</span> <span class="n">out</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataOutputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getOutputStream</span><span class="o">());</span>
<span class="c1">// Request header</span>
<span class="n">writeRequestHeader</span><span class="o">(</span><span class="mi">15</span><span class="o">,</span> <span class="no">OP_CACHE_GET_AND_PUT</span><span class="o">,</span> <span class="mi">1</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Cache id</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">cacheName</span><span class="o">.</span><span class="na">hashCode</span><span class="o">(),</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Flags = none</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">0</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Cache key data object</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">3</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Integer type code</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">key</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Cache key</span>
<span class="c1">// Cache value data object</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">3</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Integer type code</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">value</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Cache value</span></code></pre>
</div>
</div></code-tab><code-tab data-tab='Response'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="c1">// Read result</span>
<span class="nc">DataInputStream</span> <span class="n">in</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataInputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getInputStream</span><span class="o">());</span>
<span class="c1">// Response header</span>
<span class="n">readResponseHeader</span><span class="o">(</span><span class="n">in</span><span class="o">);</span>
<span class="c1">// Resulting cache value (Data Object)</span>
<span class="kt">int</span> <span class="n">resTypeCode</span> <span class="o">=</span> <span class="n">readByteLittleEndian</span><span class="o">(</span><span class="n">in</span><span class="o">);</span>
<span class="kt">int</span> <span class="n">value</span> <span class="o">=</span> <span class="n">readIntLittleEndian</span><span class="o">(</span><span class="n">in</span><span class="o">);</span></code></pre>
</div>
</div></code-tab></code-tabs>
</div>
</div>
<div class="sect1">
<h2 id="op_cache_get_and_replace">OP_CACHE_GET_AND_REPLACE</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Replaces the value associated with the given key in the specified cache and returns the previous value. If the cache does not contain the key, the operation returns null without changing the cache.</p>
</div>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Request Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Request Header.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Cache ID: Java-style hash code of the cache name.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">byte</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Use 0. This field is deprecated and will be removed in the future.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Data Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The key whose value is to be replaced.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Data Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The new value to be associated with the specified key.</p></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Response Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Response header.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Data Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The previous value associated with the given key, or null if the key does not exist.</p></td>
</tr>
</tbody>
</table>
<code-tabs><code-tab data-tab='Request'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="nc">DataOutputStream</span> <span class="n">out</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataOutputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getOutputStream</span><span class="o">());</span>
<span class="c1">// Request header</span>
<span class="n">writeRequestHeader</span><span class="o">(</span><span class="mi">15</span><span class="o">,</span> <span class="no">OP_CACHE_GET_AND_REPLACE</span><span class="o">,</span> <span class="mi">1</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Cache id</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">cacheName</span><span class="o">.</span><span class="na">hashCode</span><span class="o">(),</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Flags = none</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">0</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Cache key data object</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">3</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Integer type code</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">key</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Cache key</span>
<span class="c1">// Cache value data object</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">3</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Integer type code</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">value</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Cache value</span></code></pre>
</div>
</div></code-tab><code-tab data-tab='Response'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="c1">// Read result</span>
<span class="nc">DataInputStream</span> <span class="n">in</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataInputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getInputStream</span><span class="o">());</span>
<span class="c1">// Response header</span>
<span class="n">readResponseHeader</span><span class="o">(</span><span class="n">in</span><span class="o">);</span>
<span class="c1">// Resulting cache value (Data Object)</span>
<span class="kt">int</span> <span class="n">resTypeCode</span> <span class="o">=</span> <span class="n">readByteLittleEndian</span><span class="o">(</span><span class="n">in</span><span class="o">);</span>
<span class="kt">int</span> <span class="n">value</span> <span class="o">=</span> <span class="n">readIntLittleEndian</span><span class="o">(</span><span class="n">in</span><span class="o">);</span></code></pre>
</div>
</div></code-tab></code-tabs>
</div>
</div>
<div class="sect1">
<h2 id="op_cache_get_and_remove">OP_CACHE_GET_AND_REMOVE</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Removes a specific entry from a cache and returns the entry&#8217;s value. If the key does not exist, null is returned.</p>
</div>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Request Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Request Header.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Cache ID: Java-style hash code of the cache name.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">byte</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Use 0. This field is deprecated and will be removed in the future.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Data Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The key to be removed.</p></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Response Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Response header.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Data Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The existing value associated with the specified key or null, if the key does not exist.</p></td>
</tr>
</tbody>
</table>
<code-tabs><code-tab data-tab='Request'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="nc">DataOutputStream</span> <span class="n">out</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataOutputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getOutputStream</span><span class="o">());</span>
<span class="c1">// Request header</span>
<span class="n">writeRequestHeader</span><span class="o">(</span><span class="mi">10</span><span class="o">,</span> <span class="no">OP_CACHE_GET_AND_REMOVE</span><span class="o">,</span> <span class="mi">1</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Cache id</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">cacheName</span><span class="o">.</span><span class="na">hashCode</span><span class="o">(),</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Flags = none</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">0</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Cache key data object</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">3</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Integer type code</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">key</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Cache key</span></code></pre>
</div>
</div></code-tab><code-tab data-tab='Response'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="c1">// Read result</span>
<span class="nc">DataInputStream</span> <span class="n">in</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataInputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getInputStream</span><span class="o">());</span>
<span class="c1">// Response header</span>
<span class="n">readResponseHeader</span><span class="o">(</span><span class="n">in</span><span class="o">);</span>
<span class="c1">// Resulting cache value (Data Object)</span>
<span class="kt">int</span> <span class="n">resTypeCode</span> <span class="o">=</span> <span class="n">readByte</span><span class="o">(</span><span class="n">in</span><span class="o">);</span>
<span class="kt">int</span> <span class="n">value</span> <span class="o">=</span> <span class="n">readInt</span><span class="o">(</span><span class="n">in</span><span class="o">);</span></code></pre>
</div>
</div></code-tab></code-tabs>
</div>
</div>
<div class="sect1">
<h2 id="op_cache_put_if_absent">OP_CACHE_PUT_IF_ABSENT</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Puts an entry to a cache if that entry does not exist.</p>
</div>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Request Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Request Header.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Cache ID: Java-style hash code of the cache name.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">byte</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Use 0. This field is deprecated and will be removed in the future.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Data Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The key of the entry to be added.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Data Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The value of the key to be added.</p></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Response Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Response header.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">bool</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">true if the new entry is created, false if the entry already exists.</p></td>
</tr>
</tbody>
</table>
<code-tabs><code-tab data-tab='Request'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="nc">DataOutputStream</span> <span class="n">out</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataOutputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getOutputStream</span><span class="o">());</span>
<span class="c1">// Request header</span>
<span class="n">writeRequestHeader</span><span class="o">(</span><span class="mi">15</span><span class="o">,</span> <span class="no">OP_CACHE_PUT_IF_ABSENT</span><span class="o">,</span> <span class="mi">1</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Cache id</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">cacheName</span><span class="o">.</span><span class="na">hashCode</span><span class="o">(),</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Flags = none</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">0</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Cache key data object</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">3</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Integer type code</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">key</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Cache key</span>
<span class="c1">// Cache value data object</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">3</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Integer type code</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">value</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Cache Value</span></code></pre>
</div>
</div></code-tab><code-tab data-tab='Response'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="c1">// Read result</span>
<span class="nc">DataInputStream</span> <span class="n">in</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataInputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getInputStream</span><span class="o">());</span>
<span class="c1">// Response header</span>
<span class="n">readResponseHeader</span><span class="o">(</span><span class="n">in</span><span class="o">);</span>
<span class="c1">// Resulting boolean value</span>
<span class="kt">boolean</span> <span class="n">res</span> <span class="o">=</span> <span class="n">readBooleanLittleEndian</span><span class="o">(</span><span class="n">in</span><span class="o">);</span></code></pre>
</div>
</div></code-tab></code-tabs>
</div>
</div>
<div class="sect1">
<h2 id="op_cache_get_and_put_if_absent">OP_CACHE_GET_AND_PUT_IF_ABSENT</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Puts an entry to a cache if it does not exist; otherwise, returns the existing value.</p>
</div>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Request Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Request Header.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Cache ID: Java-style hash code of the cache name.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">byte</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Use 0. This field is deprecated and will be removed in the future.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Data Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The key of the entry to be added.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Data Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The value of the entry to be added.</p></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Response Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Response header.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Data Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">null if the cache does not contain the entry (in this case a new entry is created) or the existing value associated with the given key.</p></td>
</tr>
</tbody>
</table>
<code-tabs><code-tab data-tab='Request'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="nc">DataOutputStream</span> <span class="n">out</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataOutputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getOutputStream</span><span class="o">());</span>
<span class="c1">// Request header</span>
<span class="n">writeRequestHeader</span><span class="o">(</span><span class="mi">15</span><span class="o">,</span> <span class="no">OP_CACHE_GET_AND_PUT_IF_ABSENT</span><span class="o">,</span> <span class="mi">1</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Cache id</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">cacheName</span><span class="o">.</span><span class="na">hashCode</span><span class="o">(),</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Flags = none</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">0</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Cache key data object</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">3</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Integer type code</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">key</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Cache key</span>
<span class="c1">// Cache value data object</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">3</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Integer type code</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">value</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Cache value</span></code></pre>
</div>
</div></code-tab><code-tab data-tab='Response'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="c1">// Read result</span>
<span class="nc">DataInputStream</span> <span class="n">in</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataInputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getInputStream</span><span class="o">());</span>
<span class="c1">// Response header</span>
<span class="n">readResponseHeader</span><span class="o">(</span><span class="n">in</span><span class="o">);</span>
<span class="c1">// Resulting cache value (Data Object)</span>
<span class="kt">int</span> <span class="n">resTypeCode</span> <span class="o">=</span> <span class="n">readByteLittleEndian</span><span class="o">(</span><span class="n">in</span><span class="o">);</span>
<span class="kt">int</span> <span class="n">value</span> <span class="o">=</span> <span class="n">readIntLittleEndian</span><span class="o">(</span><span class="n">in</span><span class="o">);</span></code></pre>
</div>
</div></code-tab></code-tabs>
</div>
</div>
<div class="sect1">
<h2 id="op_cache_replace">OP_CACHE_REPLACE</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Puts a value with a given key to cache only if the key already exists.</p>
</div>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Request Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Request Header.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Cache ID: Java-style hash code of the cache name.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">byte</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Use 0. This field is deprecated and will be removed in the future.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Data Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Key for the cache entry.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Data Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Value for the key.</p></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Response Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Response header.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">bool</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Value indicating whether replace happened.</p></td>
</tr>
</tbody>
</table>
<code-tabs><code-tab data-tab='Request'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="nc">DataOutputStream</span> <span class="n">out</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataOutputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getOutputStream</span><span class="o">());</span>
<span class="c1">// Request header</span>
<span class="n">writeRequestHeader</span><span class="o">(</span><span class="mi">15</span><span class="o">,</span> <span class="no">OP_CACHE_REPLACE</span><span class="o">,</span> <span class="mi">1</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Cache id</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">cacheName</span><span class="o">.</span><span class="na">hashCode</span><span class="o">(),</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Flags = none</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">0</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Cache key data object</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">3</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Integer type code</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">key</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Cache key</span>
<span class="c1">// Cache value data object</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">3</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Integer type code</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">value</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Cache value</span></code></pre>
</div>
</div></code-tab><code-tab data-tab='Response'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="c1">// Read result</span>
<span class="nc">DataInputStream</span> <span class="n">in</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataInputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getInputStream</span><span class="o">());</span>
<span class="c1">// Response header</span>
<span class="n">readResponseHeader</span><span class="o">(</span><span class="n">in</span><span class="o">);</span>
<span class="kt">boolean</span> <span class="n">res</span> <span class="o">=</span> <span class="n">readBooleanLittleEndian</span><span class="o">(</span><span class="n">in</span><span class="o">);</span></code></pre>
</div>
</div></code-tab></code-tabs>
</div>
</div>
<div class="sect1">
<h2 id="op_cache_replace_if_equals">OP_CACHE_REPLACE_IF_EQUALS</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Puts a value with a given key to cache only if the key already exists and value equals provided value.</p>
</div>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Request Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Request Header.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Cache ID: Java-style hash code of the cache name.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">byte</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Use 0. This field is deprecated and will be removed in the future.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Data Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Key for the cache entry.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Data Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Value to be compared with the existing value in the cache for the given key.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Data Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">New value for the key.</p></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Response Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Response header.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">bool</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Value indicating whether replace happened.</p></td>
</tr>
</tbody>
</table>
<code-tabs><code-tab data-tab='Request'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="nc">DataOutputStream</span> <span class="n">out</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataOutputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getOutputStream</span><span class="o">());</span>
<span class="c1">// Request header</span>
<span class="n">writeRequestHeader</span><span class="o">(</span><span class="mi">20</span><span class="o">,</span> <span class="no">OP_CACHE_REPLACE_IF_EQUALS</span><span class="o">,</span> <span class="mi">1</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Cache id</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">cacheName</span><span class="o">.</span><span class="na">hashCode</span><span class="o">(),</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Flags = none</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">0</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Cache key data object</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">3</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Integer type code</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">key</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Cache key</span>
<span class="c1">// Cache value data object</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">3</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Integer type code</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">value</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Cache value to compare</span>
<span class="c1">// Cache value data object</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">3</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Integer type code</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">newValue</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// New cache value</span></code></pre>
</div>
</div></code-tab><code-tab data-tab='Response'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="c1">// Read result</span>
<span class="nc">DataInputStream</span> <span class="n">in</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataInputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getInputStream</span><span class="o">());</span>
<span class="c1">// Response header</span>
<span class="n">readResponseHeader</span><span class="o">(</span><span class="n">in</span><span class="o">);</span>
<span class="kt">boolean</span> <span class="n">res</span> <span class="o">=</span> <span class="n">readBooleanLittleEndian</span><span class="o">(</span><span class="n">in</span><span class="o">);</span></code></pre>
</div>
</div></code-tab></code-tabs>
</div>
</div>
<div class="sect1">
<h2 id="op_cache_clear">OP_CACHE_CLEAR</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Clears the cache without notifying listeners or cache writers. See the javadoc for the corresponding cache method.</p>
</div>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Request Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Request Header.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Cache ID: Java-style hash code of the cache name.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">byte</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Use 0. This field is deprecated and will be removed in the future.</p></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Response Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Response header.</p></td>
</tr>
</tbody>
</table>
<code-tabs><code-tab data-tab='Request'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="nc">DataOutputStream</span> <span class="n">out</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataOutputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getOutputStream</span><span class="o">());</span>
<span class="c1">// Request header</span>
<span class="n">writeRequestHeader</span><span class="o">(</span><span class="mi">5</span><span class="o">,</span> <span class="no">OP_CACHE_CLEAR</span><span class="o">,</span> <span class="mi">1</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Cache id</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">cacheName</span><span class="o">.</span><span class="na">hashCode</span><span class="o">(),</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Flags = none</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">0</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span></code></pre>
</div>
</div></code-tab><code-tab data-tab='Response'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="c1">// Read result</span>
<span class="nc">DataInputStream</span> <span class="n">in</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataInputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getInputStream</span><span class="o">());</span>
<span class="c1">// Response header</span>
<span class="n">readResponseHeader</span><span class="o">(</span><span class="n">in</span><span class="o">);</span></code></pre>
</div>
</div></code-tab></code-tabs>
</div>
</div>
<div class="sect1">
<h2 id="op_cache_clear_key">OP_CACHE_CLEAR_KEY</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Clears the cache key without notifying listeners or cache writers. See the javadoc for the corresponding cache method.</p>
</div>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Request Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Request Header.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Cache ID: Java-style hash code of the cache name.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">byte</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Use 0. This field is deprecated and will be removed in the future.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Data Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Key for the cache entry.</p></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Response Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Response header.</p></td>
</tr>
</tbody>
</table>
<code-tabs><code-tab data-tab='Request'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="nc">DataOutputStream</span> <span class="n">out</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataOutputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getOutputStream</span><span class="o">());</span>
<span class="c1">// Request header</span>
<span class="n">writeRequestHeader</span><span class="o">(</span><span class="mi">10</span><span class="o">,</span> <span class="no">OP_CACHE_CLEAR_KEY</span><span class="o">,</span> <span class="mi">1</span><span class="o">,</span> <span class="n">out</span><span class="o">);;</span>
<span class="c1">// Cache id</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">cacheName</span><span class="o">.</span><span class="na">hashCode</span><span class="o">(),</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Flags = none</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">0</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Cache key data object</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">3</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Integer type code</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">key</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Cache key</span></code></pre>
</div>
</div></code-tab><code-tab data-tab='Response'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="c1">// Read result</span>
<span class="nc">DataInputStream</span> <span class="n">in</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataInputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getInputStream</span><span class="o">());</span>
<span class="c1">// Response header</span>
<span class="n">readResponseHeader</span><span class="o">(</span><span class="n">in</span><span class="o">);</span></code></pre>
</div>
</div></code-tab></code-tabs>
</div>
</div>
<div class="sect1">
<h2 id="op_cache_clear_keys">OP_CACHE_CLEAR_KEYS</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Clears the cache keys without notifying listeners or cache writers. See the javadoc for the corresponding cache method.</p>
</div>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Request Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Request Header.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Cache ID: Java-style hash code of the cache name.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">byte</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Use 0. This field is deprecated and will be removed in the future.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Key count.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Data Object * count</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Keys</p></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Response Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Response header.</p></td>
</tr>
</tbody>
</table>
<code-tabs><code-tab data-tab='Request'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="nc">DataOutputStream</span> <span class="n">out</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataOutputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getOutputStream</span><span class="o">());</span>
<span class="c1">// Request header</span>
<span class="n">writeRequestHeader</span><span class="o">(</span><span class="mi">19</span><span class="o">,</span> <span class="no">OP_CACHE_CLEAR_KEYS</span><span class="o">,</span> <span class="mi">1</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Cache id</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">cacheName</span><span class="o">.</span><span class="na">hashCode</span><span class="o">(),</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Flags = none</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">0</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// key count</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="mi">2</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Cache key data object 1</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">3</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Integer type code</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">key1</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Cache key</span>
<span class="c1">// Cache key data object 2</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">3</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Integer type code</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">key2</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Cache key</span></code></pre>
</div>
</div></code-tab><code-tab data-tab='Response'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="c1">// Read result</span>
<span class="nc">DataInputStream</span> <span class="n">in</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataInputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getInputStream</span><span class="o">());</span>
<span class="c1">// Response header</span>
<span class="n">readResponseHeader</span><span class="o">(</span><span class="n">in</span><span class="o">);</span></code></pre>
</div>
</div></code-tab></code-tabs>
</div>
</div>
<div class="sect1">
<h2 id="op_cache_remove_key">OP_CACHE_REMOVE_KEY</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Removes an entry with a given key, notifying listeners and cache writers. See the javadoc for the corresponding cache method.</p>
</div>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Request Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Request Header.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Cache ID: Java-style hash code of the cache name.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">byte</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Use 0. This field is deprecated and will be removed in the future.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Data Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Key for the cache entry.</p></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Response Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Response header.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">bool</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Value indicating whether remove happened.</p></td>
</tr>
</tbody>
</table>
<code-tabs><code-tab data-tab='Request'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="nc">DataOutputStream</span> <span class="n">out</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataOutputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getOutputStream</span><span class="o">());</span>
<span class="c1">// Request header</span>
<span class="n">writeRequestHeader</span><span class="o">(</span><span class="mi">10</span><span class="o">,</span> <span class="no">OP_CACHE_REMOVE_KEY</span><span class="o">,</span> <span class="mi">1</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Cache id</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">cacheName</span><span class="o">.</span><span class="na">hashCode</span><span class="o">(),</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Flags = none</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">0</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Cache key data object</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">3</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Integer type code</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">key1</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Cache key</span></code></pre>
</div>
</div></code-tab><code-tab data-tab='Response'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="c1">// Read result</span>
<span class="nc">DataInputStream</span> <span class="n">in</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataInputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getInputStream</span><span class="o">());</span>
<span class="c1">// Response header</span>
<span class="n">readResponseHeader</span><span class="o">(</span><span class="n">in</span><span class="o">);</span>
<span class="c1">// Resulting boolean value</span>
<span class="kt">boolean</span> <span class="n">res</span> <span class="o">=</span> <span class="n">readBooleanLittleEndian</span><span class="o">(</span><span class="n">in</span><span class="o">);</span></code></pre>
</div>
</div></code-tab></code-tabs>
</div>
</div>
<div class="sect1">
<h2 id="op_cache_remove_if_equals">OP_CACHE_REMOVE_IF_EQUALS</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Removes an entry with a given key if the specified value is equal to the current value, notifying listeners and cache writers.</p>
</div>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Request Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Request Header.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Cache ID: Java-style hash code of the cache name.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">byte</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Use 0. This field is deprecated and will be removed in the future.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Data Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The key of the entry to be removed.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Data Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The value to be compared with the current value.</p></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Response Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Response header.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">bool</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Value indicating whether remove happened</p></td>
</tr>
</tbody>
</table>
<code-tabs><code-tab data-tab='Request'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="nc">DataOutputStream</span> <span class="n">out</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataOutputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getOutputStream</span><span class="o">());</span>
<span class="c1">// Request header</span>
<span class="n">writeRequestHeader</span><span class="o">(</span><span class="mi">15</span><span class="o">,</span> <span class="no">OP_CACHE_REMOVE_IF_EQUALS</span><span class="o">,</span> <span class="mi">1</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Cache id</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">cacheName</span><span class="o">.</span><span class="na">hashCode</span><span class="o">(),</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Flags = none</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">0</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Cache key data object</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">3</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Integer type code</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">key</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Cache key</span>
<span class="c1">// Cache value data object</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">3</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Integer type code</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">value</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Cache value</span></code></pre>
</div>
</div></code-tab><code-tab data-tab='Response'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="c1">// Read result</span>
<span class="nc">DataInputStream</span> <span class="n">in</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataInputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getInputStream</span><span class="o">());</span>
<span class="c1">// Response header</span>
<span class="n">readResponseHeader</span><span class="o">(</span><span class="n">in</span><span class="o">);</span>
<span class="c1">// Resulting boolean value</span>
<span class="kt">boolean</span> <span class="n">res</span> <span class="o">=</span> <span class="n">readBooleanLittleEndian</span><span class="o">(</span><span class="n">in</span><span class="o">);</span></code></pre>
</div>
</div></code-tab></code-tabs>
</div>
</div>
<div class="sect1">
<h2 id="op_cache_get_size">OP_CACHE_GET_SIZE</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Gets the number of entries in a cache. This method is equivalent to <code>IgniteCache.size(CachePeekMode&#8230;&#8203; peekModes)</code>.</p>
</div>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Request Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Request Header.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Cache ID: Java-style hash code of the cache name.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">byte</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Use 0. This field is deprecated and will be removed in the future.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The number of peek modes you are going to request. When set to 0, CachePeekMode.ALL is used. When set to a positive value, you need to specify in the following fields the type of entries that should be counted: all, backup, primary, or near cache entries.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">byte</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Indicates which type of entries should be counted: 0 = all, 1 = near cache entries, 2 = primary entries, 3 = backup entries.</p>
<p class="tableblock">This field must be provided as many times as specified in the previous field.</p></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Response Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Response header.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">long</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Cache size.</p></td>
</tr>
</tbody>
</table>
<code-tabs><code-tab data-tab='Request'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="nc">DataOutputStream</span> <span class="n">out</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataOutputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getOutputStream</span><span class="o">());</span>
<span class="c1">// Request header</span>
<span class="n">writeRequestHeader</span><span class="o">(</span><span class="mi">10</span><span class="o">,</span> <span class="no">OP_CACHE_GET_SIZE</span><span class="o">,</span> <span class="mi">1</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Cache id</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">cacheName</span><span class="o">.</span><span class="na">hashCode</span><span class="o">(),</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Flags = none</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">0</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Peek mode count; '0' means All</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="mi">0</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Peek mode</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">0</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span></code></pre>
</div>
</div></code-tab><code-tab data-tab='Response'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="c1">// Read result</span>
<span class="nc">DataInputStream</span> <span class="n">in</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataInputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getInputStream</span><span class="o">());</span>
<span class="c1">// Response header</span>
<span class="n">readResponseHeader</span><span class="o">(</span><span class="n">in</span><span class="o">);</span>
<span class="c1">// Number of entries in cache</span>
<span class="kt">long</span> <span class="n">cacheSize</span> <span class="o">=</span> <span class="n">readLongLittleEndian</span><span class="o">(</span><span class="n">in</span><span class="o">);</span></code></pre>
</div>
</div></code-tab></code-tabs>
</div>
</div>
<div class="sect1">
<h2 id="op_cache_remove_keys">OP_CACHE_REMOVE_KEYS</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Removes entries with given keys, notifying listeners and cache writers. See the javadoc for the corresponding cache method.</p>
</div>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Request Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Request Header.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Cache ID: Java-style hash code of the cache name.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">byte</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Use 0. This field is deprecated and will be removed in the future.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Number of keys to remove.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Data Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The key to be removed. If the cache does not contain the key, it is ignored. This field must be provided for each key to be removed.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">&#8230;&#8203;.</p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Data Object</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The key to be removed.</p></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Response Type Description</th>
<th class="tableblock halign-left valign-top">Header</th>
</tr>
</thead>
</table>
<code-tabs><code-tab data-tab='Request'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="nc">DataOutputStream</span> <span class="n">out</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataOutputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getOutputStream</span><span class="o">());</span>
<span class="c1">// Request header</span>
<span class="n">writeRequestHeader</span><span class="o">(</span><span class="mi">19</span><span class="o">,</span> <span class="no">OP_CACHE_REMOVE_KEYS</span><span class="o">,</span> <span class="mi">1</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Cache id</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">cacheName</span><span class="o">.</span><span class="na">hashCode</span><span class="o">(),</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Flags = none</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">0</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// key count</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="mi">2</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Cache key data object 1</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">3</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Integer type code</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">key1</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Cache key</span>
<span class="c1">// Cache value data object 2</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">3</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Integer type code</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">key2</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span> <span class="c1">// Cache key</span></code></pre>
</div>
</div></code-tab><code-tab data-tab='Response'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="c1">// Read result</span>
<span class="nc">DataInputStream</span> <span class="n">in</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataInputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getInputStream</span><span class="o">());</span>
<span class="c1">// Response header</span>
<span class="n">readResponseHeader</span><span class="o">(</span><span class="n">in</span><span class="o">);</span></code></pre>
</div>
</div></code-tab></code-tabs>
</div>
</div>
<div class="sect1">
<h2 id="op_cache_remove_all">OP_CACHE_REMOVE_ALL</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Removes all entries from cache, notifying listeners and cache writers. See the javadoc for the corresponding cache method.</p>
</div>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Request Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Request Header.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">int</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Cache ID: Java-style hash code of the cache name.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">byte</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Use 0. This field is deprecated and will be removed in the future.</p></td>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stripes-even stretch">
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 66.6667%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Response Type</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Header</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Response header.</p></td>
</tr>
</tbody>
</table>
<code-tabs><code-tab data-tab='Request'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="nc">DataOutputStream</span> <span class="n">out</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataOutputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getOutputStream</span><span class="o">());</span>
<span class="c1">// Request header</span>
<span class="n">writeRequestHeader</span><span class="o">(</span><span class="mi">5</span><span class="o">,</span> <span class="no">OP_CACHE_REMOVE_ALL</span><span class="o">,</span> <span class="mi">1</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Cache id</span>
<span class="n">writeIntLittleEndian</span><span class="o">(</span><span class="n">cacheName</span><span class="o">.</span><span class="na">hashCode</span><span class="o">(),</span> <span class="n">out</span><span class="o">);</span>
<span class="c1">// Flags = none</span>
<span class="n">writeByteLittleEndian</span><span class="o">(</span><span class="mi">0</span><span class="o">,</span> <span class="n">out</span><span class="o">);</span></code></pre>
</div>
</div></code-tab><code-tab data-tab='Response'><div class="listingblock">
<div class="content">
<pre class="rouge highlight"><code data-lang="java"><span class="c1">// Read result</span>
<span class="nc">DataInputStream</span> <span class="n">in</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DataInputStream</span><span class="o">(</span><span class="n">socket</span><span class="o">.</span><span class="na">getInputStream</span><span class="o">());</span>
<span class="c1">// Response length</span>
<span class="kd">final</span> <span class="kt">int</span> <span class="n">len</span> <span class="o">=</span> <span class="n">readIntLittleEndian</span><span class="o">(</span><span class="n">in</span><span class="o">);</span>
<span class="c1">// Request id</span>
<span class="kt">long</span> <span class="n">resReqId</span> <span class="o">=</span> <span class="n">readLongLittleEndian</span><span class="o">(</span><span class="n">in</span><span class="o">);</span>
<span class="c1">// Success</span>
<span class="kt">int</span> <span class="n">statusCode</span> <span class="o">=</span> <span class="n">readIntLittleEndian</span><span class="o">(</span><span class="n">in</span><span class="o">);</span></code></pre>
</div>
</div></code-tab></code-tabs>
</div>
</div>
<div class="copyright">
© 2021 The Apache Software Foundation.<br/>
Apache, Apache Ignite, the Apache feather and the Apache Ignite logo are either registered trademarks or trademarks of The Apache Software Foundation.
</div>
</article>
<nav class="right-nav" data-swiftype-index='false'>
<div class="toc-wrapper">
<ul class="sectlevel1">
<li><a href="#operation-codes">Operation Codes</a></li>
<li><a href="#op_cache_get">OP_CACHE_GET</a></li>
<li><a href="#op_cache_get_all">OP_CACHE_GET_ALL</a></li>
<li><a href="#op_cache_put">OP_CACHE_PUT</a></li>
<li><a href="#op_cache_put_all">OP_CACHE_PUT_ALL</a></li>
<li><a href="#op_cache_contains_key">OP_CACHE_CONTAINS_KEY</a></li>
<li><a href="#op_cache_contains_keys">OP_CACHE_CONTAINS_KEYS</a></li>
<li><a href="#op_cache_get_and_put">OP_CACHE_GET_AND_PUT</a></li>
<li><a href="#op_cache_get_and_replace">OP_CACHE_GET_AND_REPLACE</a></li>
<li><a href="#op_cache_get_and_remove">OP_CACHE_GET_AND_REMOVE</a></li>
<li><a href="#op_cache_put_if_absent">OP_CACHE_PUT_IF_ABSENT</a></li>
<li><a href="#op_cache_get_and_put_if_absent">OP_CACHE_GET_AND_PUT_IF_ABSENT</a></li>
<li><a href="#op_cache_replace">OP_CACHE_REPLACE</a></li>
<li><a href="#op_cache_replace_if_equals">OP_CACHE_REPLACE_IF_EQUALS</a></li>
<li><a href="#op_cache_clear">OP_CACHE_CLEAR</a></li>
<li><a href="#op_cache_clear_key">OP_CACHE_CLEAR_KEY</a></li>
<li><a href="#op_cache_clear_keys">OP_CACHE_CLEAR_KEYS</a></li>
<li><a href="#op_cache_remove_key">OP_CACHE_REMOVE_KEY</a></li>
<li><a href="#op_cache_remove_if_equals">OP_CACHE_REMOVE_IF_EQUALS</a></li>
<li><a href="#op_cache_get_size">OP_CACHE_GET_SIZE</a></li>
<li><a href="#op_cache_remove_keys">OP_CACHE_REMOVE_KEYS</a></li>
<li><a href="#op_cache_remove_all">OP_CACHE_REMOVE_ALL</a></li>
</ul>
</div>
<nav class="promo-nav">
<!--#include virtual="/includes/docs_rightnav_promotion.html" -->
<a href="#" data-trigger-bugyard-feedback="true" id="doc-feedback-btn">Docs Feedback</a>
</nav>
</nav>
</section>
<script type='module' src='/assets/js/code-copy-to-clipboard.js' async crossorigin></script>
<script>
// inits deep anchors -- needs to be done here because of https://www.bryanbraun.com/anchorjs/#dont-run-it-too-late
anchors.add('.page-docs h1, .page-docs h2, .page-docs h3:not(.discrete), .page-docs h4, .page-docs h5');
anchors.options = {
placement: 'right',
visible: 'always'
};
</script>
<script src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script>
<script>
docsearch({
// Your apiKey and indexName will be given to you once
// we create your config
apiKey: '3eee686c0ebe39eff3baeb18c56fa5f8',
indexName: 'apache_ignite',
// Replace inputSelector with a CSS selector
// matching your search input
inputSelector: '#search-input',
// algoliaOptions: { 'facetFilters': ["version:$VERSION"] },
// Set debug to true to inspect the dropdown
debug: false,
});
</script>
<script type='module' src='/assets/js/index.js?1634150556' async crossorigin></script>
<script type='module' src='/assets/js/versioning.js?1634150556' async crossorigin></script>
<link rel="stylesheet" href="/assets/css/styles.css?1634150556" media="print" onload="this.media='all'">
<noscript><link media="all" rel="stylesheet" href="/assets/css/styles.css?1634150556"></noscript>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css" media="print" onload="this.media='all'">
<noscript><link media="all" rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css"></noscript>
</body>
</html>