You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by tv...@apache.org on 2018/08/23 13:24:56 UTC
svn commit: r28907 [5/15] - /dev/commons/jcs/site-2.2.1-RC4/
Added: dev/commons/jcs/site-2.2.1-RC4/LateralJavaGroupsAuxCache.html
==============================================================================
--- dev/commons/jcs/site-2.2.1-RC4/LateralJavaGroupsAuxCache.html (added)
+++ dev/commons/jcs/site-2.2.1-RC4/LateralJavaGroupsAuxCache.html Thu Aug 23 13:24:56 2018
@@ -0,0 +1,388 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 23 August 2018
+ | Rendered using Apache Maven Fluido Skin 1.3.0
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="author" content="Aaron Smuts" />
+ <meta name="Date-Revision-yyyymmdd" content="20180823" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>JCS – Lateral JGroups Auxiliary Cache</title>
+
+ <link rel="stylesheet" href="./css/bootstrap.min.css" type="text/css" />
+ <link rel="stylesheet" href="./css/site.css" type="text/css" />
+ <link rel="stylesheet" href="./css/print.css" media="print" />
+
+ <script type="text/javascript" src="./js/jquery.min.js"></script>
+ <script type="text/javascript" src="./js/bootstrap.min.js"></script>
+ <script type="text/javascript" src="./js/prettify.min.js"></script>
+ <script type="text/javascript" src="./js/site.js"></script>
+
+
+ </head>
+
+ <body class="composite">
+ <a href="http://commons.apache.org/" id="bannerLeft" title="Apache Commons logo">
+ <img class="logo-left" src="./images/commons-logo.png" alt="Apache Commons logo"/>
+ </a>
+ <a href="index.html" id="bannerRight">
+ <h2>Commons JCSâ¢</h2>
+ </a>
+ <div class="clear"></div>
+
+ <div class="navbar">
+ <div class="navbar-inner">
+ <div class="container-fluid">
+ <a class="brand" href="http://commons.apache.org/proper/commons-jcs/">Apache Commons JCS ™</a>
+ <ul class="nav">
+
+ <li id="publishDate">Last Published: 23 August 2018</li>
+ <li class="divider">|</li> <li id="projectVersion">Version: 2.2.1</li>
+ </ul>
+ <div class="pull-right"> <ul class="nav">
+ <li>
+ <a href="http://www.apachecon.com/" class="externalLink" title="ApacheCon">
+ ApacheCon</a>
+ </li>
+ <li>
+ <a href="http://www.apache.org" class="externalLink" title="Apache">
+ Apache</a>
+ </li>
+ <li>
+ <a href="../../" title="Commons">
+ Commons</a>
+ </li>
+ </ul>
+</div>
+ </div>
+ </div>
+ </div>
+
+ <div class="container-fluid">
+ <table class="layout-table">
+ <tr>
+ <td class="sidebar">
+ <div class="well sidebar-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">JCS</li>
+ <li class="none">
+ <a href="index.html" title="Overview">
+ Overview</a>
+ </li>
+ <li class="none">
+ <a href="JCSandJCACHE.html" title="JCS and JCACHE">
+ JCS and JCACHE</a>
+ </li>
+ <li class="none">
+ <a href="download_jcs.cgi" title="Downloads">
+ Downloads</a>
+ </li>
+ <li class="none">
+ <a href="faq.html" title="FAQ">
+ FAQ</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header"><i class="icon-cog"></i>Development</li>
+ <li class="none">
+ <a href="changes-report.html" title="Release Notes">
+ Release Notes</a>
+ </li>
+ <li class="none">
+ <a href="UpgradingFrom13.html" title="Upgrading from 1.3 to 2.0">
+ Upgrading from 1.3 to 2.0</a>
+ </li>
+ <li class="none">
+ <a href="mail-lists.html" title="Mailing Lists">
+ Mailing Lists</a>
+ </li>
+ <li class="none">
+ <a href="issue-tracking.html" title="Issue Tracking">
+ Issue Tracking</a>
+ </li>
+ <li class="none">
+ <a href="source-repository.html" title="Source Repository">
+ Source Repository</a>
+ </li>
+ <li class="none">
+ <a href="commons-jcs-core/apidocs/index.html" title="Core Javadoc (SVN latest)">
+ Core Javadoc (SVN latest)</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">Getting Started</li>
+ <li class="none">
+ <a href="getting_started/intro.html" title="Overview">
+ Overview</a>
+ </li>
+ <li class="none">
+ <a href="BasicJCSConfiguration.html" title="Basic JCS Config">
+ Basic JCS Config</a>
+ </li>
+ <li class="none">
+ <a href="JCSPlugins.html" title="Plugin Overview">
+ Plugin Overview</a>
+ </li>
+ <li class="none">
+ <a href="UsingJCSBasicWeb.html" title="Basic Web Example">
+ Basic Web Example</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">JCS User's Guide</li>
+ <li class="collapsed">
+ <a href="LocalCacheConfig.html" title="Core">
+ Core</a>
+ </li>
+ <li class="expanded">
+ <a href="JCSPlugins.html" title="Auxiliary">
+ Auxiliary</a>
+ <ul>
+ <li class="none">
+ <a href="CacheEventLogging.html" title="Cache Event Logging">
+ Cache Event Logging</a>
+ </li>
+ <li class="none">
+ <a href="IndexedDiskAuxCache.html" title="Indexed Disk Cache">
+ Indexed Disk Cache</a>
+ </li>
+ <li class="none">
+ <a href="IndexedDiskCacheProperties.html" title="Indexed Disk Properties">
+ Indexed Disk Properties</a>
+ </li>
+ <li class="none">
+ <a href="BlockDiskCache.html" title="Block Disk Cache">
+ Block Disk Cache</a>
+ </li>
+ <li class="none">
+ <a href="JDBCDiskCache.html" title="JDBC Disk Cache">
+ JDBC Disk Cache</a>
+ </li>
+ <li class="none">
+ <a href="JDBCDiskCacheProperties.html" title="JDBC Disk Properties">
+ JDBC Disk Properties</a>
+ </li>
+ <li class="none">
+ <a href="MySQLDiskCacheProperties.html" title="MySQL Disk Properties">
+ MySQL Disk Properties</a>
+ </li>
+ <li class="none">
+ <a href="RemoteAuxCache.html" title="Remote Cache">
+ Remote Cache</a>
+ </li>
+ <li class="none">
+ <a href="RemoteCacheProperties.html" title="Remote Cache Properties">
+ Remote Cache Properties</a>
+ </li>
+ <li class="none">
+ <a href="RemoteHttpCacheProperties.html" title="Remote Http Cache Properties">
+ Remote Http Cache Properties</a>
+ </li>
+ <li class="none">
+ <a href="LateralTCPAuxCache.html" title="Lateral TCP Cache">
+ Lateral TCP Cache</a>
+ </li>
+ <li class="none">
+ <a href="LateralTCPProperties.html" title="Lateral TCP Properties">
+ Lateral TCP Properties</a>
+ </li>
+ <li class="none">
+ <a href="LateralUDPDiscovery.html" title="Lateral UDP Discovery">
+ Lateral UDP Discovery</a>
+ </li>
+ <li class="none active">
+ <a href="LateralJavaGroupsAuxCache.html" title="Lateral JGroups Cache">
+ Lateral JGroups Cache</a>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">Modules</li>
+ <li class="none">
+ <a href="commons-jcs-core/index.html" title="Apache Commons JCS :: Core">
+ Apache Commons JCS :: Core</a>
+ </li>
+ <li class="none">
+ <a href="commons-jcs-jcache/index.html" title="Apache Commons JCS :: JCache">
+ Apache Commons JCS :: JCache</a>
+ </li>
+ <li class="none">
+ <a href="commons-jcs-jcache-tck/index.html" title="Apache Commons JCS :: JCache TCK">
+ Apache Commons JCS :: JCache TCK</a>
+ </li>
+ <li class="none">
+ <a href="commons-jcs-jcache-extras/index.html" title="Apache Commons JCS :: JCache Extras">
+ Apache Commons JCS :: JCache Extras</a>
+ </li>
+ <li class="none">
+ <a href="commons-jcs-jcache-openjpa/index.html" title="Apache Commons JCS :: JCache OpenJPA">
+ Apache Commons JCS :: JCache OpenJPA</a>
+ </li>
+ <li class="none">
+ <a href="commons-jcs-dist/index.html" title="Apache Commons JCS :: Distribution">
+ Apache Commons JCS :: Distribution</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header"><i class="icon-info-sign"></i>Project Documentation</li>
+ <li class="collapsed">
+ <a href="project-info.html" title="Project Information">
+ Project Information</a>
+ </li>
+ <li class="collapsed">
+ <a href="project-reports.html" title="Project Reports">
+ Project Reports</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">Commons</li>
+ <li class="none">
+ <a href="../../" title="Home">
+ Home</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/licenses/" class="externalLink" title="License">
+ License</a>
+ </li>
+ <li class="collapsed">
+ <a href="../../components.html" title="Components">
+ Components</a>
+ </li>
+ <li class="collapsed">
+ <a href="../../sandbox/index.html" title="Sandbox">
+ Sandbox</a>
+ </li>
+ <li class="collapsed">
+ <a href="../../dormant/index.html" title="Dormant">
+ Dormant</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">General Information</li>
+ <li class="none">
+ <a href="../../security.html" title="Security">
+ Security</a>
+ </li>
+ <li class="none">
+ <a href="../../volunteering.html" title="Volunteering">
+ Volunteering</a>
+ </li>
+ <li class="none">
+ <a href="../../patches.html" title="Contributing Patches">
+ Contributing Patches</a>
+ </li>
+ <li class="none">
+ <a href="../../building.html" title="Building Components">
+ Building Components</a>
+ </li>
+ <li class="none">
+ <a href="../../commons-parent-pom.html" title="Commons Parent Pom">
+ Commons Parent Pom</a>
+ </li>
+ <li class="none">
+ <a href="../../build-plugin/index.html" title="Commons Build Plugin">
+ Commons Build Plugin</a>
+ </li>
+ <li class="none">
+ <a href="../../releases/index.html" title="Releasing Components">
+ Releasing Components</a>
+ </li>
+ <li class="none">
+ <a href="http://wiki.apache.org/commons/FrontPage" class="externalLink" title="Wiki">
+ Wiki</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">ASF</li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink" title="How the ASF works">
+ How the ASF works</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/getinvolved.html" class="externalLink" title="Get Involved">
+ Get Involved</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/dev/" class="externalLink" title="Developer Resources">
+ Developer Resources</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/policies/conduct.html" class="externalLink" title="Code of Conduct">
+ Code of Conduct</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsorship">
+ Sponsorship</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks">
+ Thanks</a>
+ </li>
+ </ul>
+ </div>
+ <div id="poweredBy">
+ <a href="http://www.apache.org/events/current-event.html" title="ApacheCon" class="builtBy">
+ <img class="builtBy" alt="ApacheCon" src="http://www.apache.org/events/current-event-125x125.png" />
+ </a>
+ <a href="http://maven.apache.org/" title="Maven" class="builtBy">
+ <img class="builtBy" alt="Maven" src="http://maven.apache.org/images/logos/maven-feather.png" />
+ </a>
+ </div>
+ </td>
+ <td class="content">
+
+
+ <div class="section">
+<h2><a name="Lateral_JGroups_Auxiliary_Cache"></a>Lateral JGroups Auxiliary Cache</h2>
+
+<p>
+ The Lateral JGroups Auxiliary Cache is an optional plug in for
+ JCS. It is primarily intended to broadcast puts and removals to
+ other local caches, though it can also get cached objects. It uses JGroups
+ for distribution.
+ </p>
+
+<p>
+ The Lateral Lateral JGroups Auxiliary Cache is far slower than
+ that Lateral TCP Auxiliary Cache. Since the Lateral TCP Auxiliary
+ is faster and has UDP discovery built in, the TCP auxiliary is the recommended form of lateral
+ distribution. However, the JGroups Auxiliary requires fewer socket connections than
+ the TCP lateral.
+ </p>
+
+<p>
+ A functional configuration example is below:
+ </p>
+
+
+<div class="source">
+<pre>
+# Lateral JavaGroups Distribution
+jcs.auxiliary.LJG=org.apache.commons.jcs.auxiliary.lateral.LateralCacheFactory
+jcs.auxiliary.LJG.attributes=org.apache.commons.jcs.auxiliary.lateral.LateralCacheAttributes
+jcs.auxiliary.LJG.attributes.TransmissionTypeName=JAVAGROUPS
+jcs.auxiliary.LJG.attributes.PutOnlyMode=true
+jcs.auxiliary.LJG.attributes.JGChannelProperties=UDP(mcast_addr=224.0.0.100;mcast_port=7501):PING:FD:STABLE:NAKACK:UNICAST:FRAG:FLUSH:GMS:QUEUE
+ </pre></div>
+
+
+ </div>
+
+
+ </td>
+ </tr>
+ </table>
+ </div>
+
+ <div class="footer">
+ <p>Copyright © 2002-2018
+ <a href="https://www.apache.org/">The Apache Software Foundation</a>.
+ All Rights Reserved.</p>
+ </div>
+ </body>
+
+</html>
Added: dev/commons/jcs/site-2.2.1-RC4/LateralTCPAuxCache.html
==============================================================================
--- dev/commons/jcs/site-2.2.1-RC4/LateralTCPAuxCache.html (added)
+++ dev/commons/jcs/site-2.2.1-RC4/LateralTCPAuxCache.html Thu Aug 23 13:24:56 2018
@@ -0,0 +1,503 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 23 August 2018
+ | Rendered using Apache Maven Fluido Skin 1.3.0
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="author" content="Pete Kazmier" />
+ <meta name="author" content="Aaron Smuts" />
+ <meta name="Date-Revision-yyyymmdd" content="20180823" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>JCS – Lateral TCP Auxiliary Cache</title>
+
+ <link rel="stylesheet" href="./css/bootstrap.min.css" type="text/css" />
+ <link rel="stylesheet" href="./css/site.css" type="text/css" />
+ <link rel="stylesheet" href="./css/print.css" media="print" />
+
+ <script type="text/javascript" src="./js/jquery.min.js"></script>
+ <script type="text/javascript" src="./js/bootstrap.min.js"></script>
+ <script type="text/javascript" src="./js/prettify.min.js"></script>
+ <script type="text/javascript" src="./js/site.js"></script>
+
+
+ </head>
+
+ <body class="composite">
+ <a href="http://commons.apache.org/" id="bannerLeft" title="Apache Commons logo">
+ <img class="logo-left" src="./images/commons-logo.png" alt="Apache Commons logo"/>
+ </a>
+ <a href="index.html" id="bannerRight">
+ <h2>Commons JCSâ¢</h2>
+ </a>
+ <div class="clear"></div>
+
+ <div class="navbar">
+ <div class="navbar-inner">
+ <div class="container-fluid">
+ <a class="brand" href="http://commons.apache.org/proper/commons-jcs/">Apache Commons JCS ™</a>
+ <ul class="nav">
+
+ <li id="publishDate">Last Published: 23 August 2018</li>
+ <li class="divider">|</li> <li id="projectVersion">Version: 2.2.1</li>
+ </ul>
+ <div class="pull-right"> <ul class="nav">
+ <li>
+ <a href="http://www.apachecon.com/" class="externalLink" title="ApacheCon">
+ ApacheCon</a>
+ </li>
+ <li>
+ <a href="http://www.apache.org" class="externalLink" title="Apache">
+ Apache</a>
+ </li>
+ <li>
+ <a href="../../" title="Commons">
+ Commons</a>
+ </li>
+ </ul>
+</div>
+ </div>
+ </div>
+ </div>
+
+ <div class="container-fluid">
+ <table class="layout-table">
+ <tr>
+ <td class="sidebar">
+ <div class="well sidebar-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">JCS</li>
+ <li class="none">
+ <a href="index.html" title="Overview">
+ Overview</a>
+ </li>
+ <li class="none">
+ <a href="JCSandJCACHE.html" title="JCS and JCACHE">
+ JCS and JCACHE</a>
+ </li>
+ <li class="none">
+ <a href="download_jcs.cgi" title="Downloads">
+ Downloads</a>
+ </li>
+ <li class="none">
+ <a href="faq.html" title="FAQ">
+ FAQ</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header"><i class="icon-cog"></i>Development</li>
+ <li class="none">
+ <a href="changes-report.html" title="Release Notes">
+ Release Notes</a>
+ </li>
+ <li class="none">
+ <a href="UpgradingFrom13.html" title="Upgrading from 1.3 to 2.0">
+ Upgrading from 1.3 to 2.0</a>
+ </li>
+ <li class="none">
+ <a href="mail-lists.html" title="Mailing Lists">
+ Mailing Lists</a>
+ </li>
+ <li class="none">
+ <a href="issue-tracking.html" title="Issue Tracking">
+ Issue Tracking</a>
+ </li>
+ <li class="none">
+ <a href="source-repository.html" title="Source Repository">
+ Source Repository</a>
+ </li>
+ <li class="none">
+ <a href="commons-jcs-core/apidocs/index.html" title="Core Javadoc (SVN latest)">
+ Core Javadoc (SVN latest)</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">Getting Started</li>
+ <li class="none">
+ <a href="getting_started/intro.html" title="Overview">
+ Overview</a>
+ </li>
+ <li class="none">
+ <a href="BasicJCSConfiguration.html" title="Basic JCS Config">
+ Basic JCS Config</a>
+ </li>
+ <li class="none">
+ <a href="JCSPlugins.html" title="Plugin Overview">
+ Plugin Overview</a>
+ </li>
+ <li class="none">
+ <a href="UsingJCSBasicWeb.html" title="Basic Web Example">
+ Basic Web Example</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">JCS User's Guide</li>
+ <li class="collapsed">
+ <a href="LocalCacheConfig.html" title="Core">
+ Core</a>
+ </li>
+ <li class="expanded">
+ <a href="JCSPlugins.html" title="Auxiliary">
+ Auxiliary</a>
+ <ul>
+ <li class="none">
+ <a href="CacheEventLogging.html" title="Cache Event Logging">
+ Cache Event Logging</a>
+ </li>
+ <li class="none">
+ <a href="IndexedDiskAuxCache.html" title="Indexed Disk Cache">
+ Indexed Disk Cache</a>
+ </li>
+ <li class="none">
+ <a href="IndexedDiskCacheProperties.html" title="Indexed Disk Properties">
+ Indexed Disk Properties</a>
+ </li>
+ <li class="none">
+ <a href="BlockDiskCache.html" title="Block Disk Cache">
+ Block Disk Cache</a>
+ </li>
+ <li class="none">
+ <a href="JDBCDiskCache.html" title="JDBC Disk Cache">
+ JDBC Disk Cache</a>
+ </li>
+ <li class="none">
+ <a href="JDBCDiskCacheProperties.html" title="JDBC Disk Properties">
+ JDBC Disk Properties</a>
+ </li>
+ <li class="none">
+ <a href="MySQLDiskCacheProperties.html" title="MySQL Disk Properties">
+ MySQL Disk Properties</a>
+ </li>
+ <li class="none">
+ <a href="RemoteAuxCache.html" title="Remote Cache">
+ Remote Cache</a>
+ </li>
+ <li class="none">
+ <a href="RemoteCacheProperties.html" title="Remote Cache Properties">
+ Remote Cache Properties</a>
+ </li>
+ <li class="none">
+ <a href="RemoteHttpCacheProperties.html" title="Remote Http Cache Properties">
+ Remote Http Cache Properties</a>
+ </li>
+ <li class="none active">
+ <a href="LateralTCPAuxCache.html" title="Lateral TCP Cache">
+ Lateral TCP Cache</a>
+ </li>
+ <li class="none">
+ <a href="LateralTCPProperties.html" title="Lateral TCP Properties">
+ Lateral TCP Properties</a>
+ </li>
+ <li class="none">
+ <a href="LateralUDPDiscovery.html" title="Lateral UDP Discovery">
+ Lateral UDP Discovery</a>
+ </li>
+ <li class="none">
+ <a href="LateralJavaGroupsAuxCache.html" title="Lateral JGroups Cache">
+ Lateral JGroups Cache</a>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">Modules</li>
+ <li class="none">
+ <a href="commons-jcs-core/index.html" title="Apache Commons JCS :: Core">
+ Apache Commons JCS :: Core</a>
+ </li>
+ <li class="none">
+ <a href="commons-jcs-jcache/index.html" title="Apache Commons JCS :: JCache">
+ Apache Commons JCS :: JCache</a>
+ </li>
+ <li class="none">
+ <a href="commons-jcs-jcache-tck/index.html" title="Apache Commons JCS :: JCache TCK">
+ Apache Commons JCS :: JCache TCK</a>
+ </li>
+ <li class="none">
+ <a href="commons-jcs-jcache-extras/index.html" title="Apache Commons JCS :: JCache Extras">
+ Apache Commons JCS :: JCache Extras</a>
+ </li>
+ <li class="none">
+ <a href="commons-jcs-jcache-openjpa/index.html" title="Apache Commons JCS :: JCache OpenJPA">
+ Apache Commons JCS :: JCache OpenJPA</a>
+ </li>
+ <li class="none">
+ <a href="commons-jcs-dist/index.html" title="Apache Commons JCS :: Distribution">
+ Apache Commons JCS :: Distribution</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header"><i class="icon-info-sign"></i>Project Documentation</li>
+ <li class="collapsed">
+ <a href="project-info.html" title="Project Information">
+ Project Information</a>
+ </li>
+ <li class="collapsed">
+ <a href="project-reports.html" title="Project Reports">
+ Project Reports</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">Commons</li>
+ <li class="none">
+ <a href="../../" title="Home">
+ Home</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/licenses/" class="externalLink" title="License">
+ License</a>
+ </li>
+ <li class="collapsed">
+ <a href="../../components.html" title="Components">
+ Components</a>
+ </li>
+ <li class="collapsed">
+ <a href="../../sandbox/index.html" title="Sandbox">
+ Sandbox</a>
+ </li>
+ <li class="collapsed">
+ <a href="../../dormant/index.html" title="Dormant">
+ Dormant</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">General Information</li>
+ <li class="none">
+ <a href="../../security.html" title="Security">
+ Security</a>
+ </li>
+ <li class="none">
+ <a href="../../volunteering.html" title="Volunteering">
+ Volunteering</a>
+ </li>
+ <li class="none">
+ <a href="../../patches.html" title="Contributing Patches">
+ Contributing Patches</a>
+ </li>
+ <li class="none">
+ <a href="../../building.html" title="Building Components">
+ Building Components</a>
+ </li>
+ <li class="none">
+ <a href="../../commons-parent-pom.html" title="Commons Parent Pom">
+ Commons Parent Pom</a>
+ </li>
+ <li class="none">
+ <a href="../../build-plugin/index.html" title="Commons Build Plugin">
+ Commons Build Plugin</a>
+ </li>
+ <li class="none">
+ <a href="../../releases/index.html" title="Releasing Components">
+ Releasing Components</a>
+ </li>
+ <li class="none">
+ <a href="http://wiki.apache.org/commons/FrontPage" class="externalLink" title="Wiki">
+ Wiki</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">ASF</li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink" title="How the ASF works">
+ How the ASF works</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/getinvolved.html" class="externalLink" title="Get Involved">
+ Get Involved</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/dev/" class="externalLink" title="Developer Resources">
+ Developer Resources</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/policies/conduct.html" class="externalLink" title="Code of Conduct">
+ Code of Conduct</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsorship">
+ Sponsorship</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks">
+ Thanks</a>
+ </li>
+ </ul>
+ </div>
+ <div id="poweredBy">
+ <a href="http://www.apache.org/events/current-event.html" title="ApacheCon" class="builtBy">
+ <img class="builtBy" alt="ApacheCon" src="http://www.apache.org/events/current-event-125x125.png" />
+ </a>
+ <a href="http://maven.apache.org/" title="Maven" class="builtBy">
+ <img class="builtBy" alt="Maven" src="http://maven.apache.org/images/logos/maven-feather.png" />
+ </a>
+ </div>
+ </td>
+ <td class="content">
+
+
+ <div class="section">
+<h2><a name="Lateral_TCP_Auxiliary_Cache"></a>Lateral TCP Auxiliary Cache</h2>
+
+<p>
+ The TCP Lateral Auxiliary Cache is an optional plug in for the
+ JCS. It is primarily intended to broadcast puts and removals to
+ other local caches, though it can also get cached objects. It
+ functions by opening up a <tt>SocketServer</tt> that
+ listens to a configurable port and by creating
+ <tt>Socket</tt> connections with other local cache
+ <tt>SocketServers</tt>. It can be configured to connect to
+ any number of servers.
+ </p>
+
+<p>
+ If there is an error connecting to another server or if an error
+ occurs in transmission, it will move into a recovery mode. In
+ recovery mode the TCP Lateral Auxiliary Cache will continue to
+ communicate with healthy servers while it tries to restore the
+ connection with the server that is in error.
+ </p>
+
+<p>
+ The cache hub communicates with a facade that implements a
+ zombie pattern (balking facade) to prevent blocking. Puts and
+ removals are queued and occur synchronously in the background.
+ Get requests are synchronous and can potentially block for a
+ configurable interval if there is a communication problem.
+ </p>
+
+<div class="section">
+<h3><a name="Non-UDP_Discovery_Configuration"></a>Non-UDP Discovery Configuration</h3>
+
+<p>
+ The configuration is fairly straightforward and is done in the
+ auxiliary cache section of the <tt>cache.ccf</tt>
+ configuration file. In the example below, I created a TCP
+ Lateral Auxiliary Cache referenced by <tt>LTCP</tt>. It
+ connects to two servers defined in a comma separated list in
+ the <tt>TcpServers</tt> attribute. It listens to port
+ <tt>1110</tt> and does <tt>AllowGet</tt>.
+ Setting <tt>AllowGet</tt>
+ equal to <tt>false</tt> would cause the auxiliary cache to
+ return <tt>null</tt> from any get request. In most cases this
+ attribute should be set to <tt>false</tt>, since if the
+ lateral caches were properly configured, the elements in one
+ would be present in all.
+ </p>
+
+<div class="source">
+<pre>
+jcs.auxiliary.LTCP=org.apache.commons.jcs.auxiliary.lateral.socket.tcp.LateralTCPCacheFactory
+jcs.auxiliary.LTCP.attributes=org.apache.commons.jcs.auxiliary.lateral.socket.tcp.TCPLateralCacheAttributes
+jcs.auxiliary.LTCP.attributes.TcpServers=localhost:1111,localhost:1112
+jcs.auxiliary.LTCP.attributes.TcpListenerPort=1110
+jcs.auxiliary.LTCP.attributes.AllowGet=true
+ </pre></div>
+
+<p>
+ A mostly configurationless mode is available for the TCP
+ lateral cache if you use the <a href="LateralUDPDiscovery.html">UDP Discovery</a>
+ mechanism.
+ </p>
+ </div>
+
+<div class="section">
+<h3><a name="Send_Only_Configuration"></a>Send Only Configuration</h3>
+
+<p>
+ You can configure the TCP lateral cache to operate
+ in send only mode by setting the <tt>Receive</tt> attribute
+ to false. By default the receive attribute is true.
+ When it is set to false, the lateral cache will not
+ establish a socket server.
+ </p>
+
+<p>
+ Setting receive to false allows you to broadcast puts
+ and removes, but not receive any. This is useful for
+ nodes of an application that produce data, but are not
+ involved in data retrieval.
+ </p>
+
+<p>
+ The configuration below is the same as above, except the
+ <tt>Receive</tt> attribute is set to false. It also uses UDP
+ discovery to find the servers, rather than listing them in the
+ servers attribute.
+ </p>
+
+<div class="source">
+<pre>
+jcs.auxiliary.LTCP=org.apache.commons.jcs.auxiliary.lateral.socket.tcp.LateralTCPCacheFactory
+jcs.auxiliary.LTCP.attributes=org.apache.commons.jcs.auxiliary.lateral.socket.tcp.TCPLateralCacheAttributes
+#jcs.auxiliary.LTCP.attributes.TcpServers=
+jcs.auxiliary.LTCP.attributes.TcpListenerPort=1118
+jcs.auxiliary.LTCP.attributes.UdpDiscoveryAddr=228.5.6.8
+jcs.auxiliary.LTCP.attributes.UdpDiscoveryPort=6780
+jcs.auxiliary.LTCP.attributes.UdpDiscoveryEnabled=true
+jcs.auxiliary.LTCP.attributes.Receive=true
+jcs.auxiliary.LTCP.attributes.AllowGet=false
+jcs.auxiliary.LTCP.attributes.IssueRemoveOnPut=false
+jcs.auxiliary.LTCP.attributes.FilterRemoveByHashCode=false
+ </pre></div>
+ </div>
+
+
+<div class="section">
+<h3><a name="Potential_Issues"></a>Potential Issues</h3>
+
+<p>
+ The TCP Lateral Auxiliary Cache can provide a high level of
+ consistency but it does not guarantee consistency between
+ caches. A put for the same object could be issued in two
+ different local caches. Since the transmission is queued, a
+ situation could occur where the item put last in one cache is
+ overridden by a put request from another local cache. The two
+ local caches could potentially have different versions of the
+ same item. Like most caches, this is intended for high get
+ and low put utilization, and this occurrence would hint at
+ improper usage. The RMI Remote cache makes this situation a
+ bit less likely to occur, since the default behavior is to
+ remove local copies on put operations. If either local cache
+ needed the item put in the above situation, it would have to
+ go remote to retrieve it. Both local copies would have been
+ expired and would end up using the same version, though it is
+ possible that the version stored remotely would not be the
+ last version created. The OCS4J tries to implement a locking
+ system to prevent this from occurring, but the locking system
+ itself could suffer from similar problems (when granting locks
+ from two roughly simultaneous lock requests) and it would
+ create a significant burden on all the caches involved. Since
+ this situation would be extremely rare and is nearly
+ impossible to solve practically, for now JCS will not offer
+ any type of locking.
+ </p>
+ </div>
+
+<div class="section">
+<h3><a name="Recent"></a>Recent</h3>
+
+<p>
+ I added a <tt>IssueRemoveOnPut</tt> attribute that
+ causes the lateral cache to remove an element from the
+ cache rather than inserting it when a put. This allows the local caches to
+ dictate their own memory usage pattern.
+ </p>
+ </div>
+ </div>
+
+
+ </td>
+ </tr>
+ </table>
+ </div>
+
+ <div class="footer">
+ <p>Copyright © 2002-2018
+ <a href="https://www.apache.org/">The Apache Software Foundation</a>.
+ All Rights Reserved.</p>
+ </div>
+ </body>
+
+</html>
Added: dev/commons/jcs/site-2.2.1-RC4/LateralTCPProperties.html
==============================================================================
--- dev/commons/jcs/site-2.2.1-RC4/LateralTCPProperties.html (added)
+++ dev/commons/jcs/site-2.2.1-RC4/LateralTCPProperties.html Thu Aug 23 13:24:56 2018
@@ -0,0 +1,552 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 23 August 2018
+ | Rendered using Apache Maven Fluido Skin 1.3.0
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="author" content="Aaron Smuts" />
+ <meta name="Date-Revision-yyyymmdd" content="20180823" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>JCS – Lateral TCP Auxiliary Cache Configuration</title>
+
+ <link rel="stylesheet" href="./css/bootstrap.min.css" type="text/css" />
+ <link rel="stylesheet" href="./css/site.css" type="text/css" />
+ <link rel="stylesheet" href="./css/print.css" media="print" />
+
+ <script type="text/javascript" src="./js/jquery.min.js"></script>
+ <script type="text/javascript" src="./js/bootstrap.min.js"></script>
+ <script type="text/javascript" src="./js/prettify.min.js"></script>
+ <script type="text/javascript" src="./js/site.js"></script>
+
+
+ </head>
+
+ <body class="composite">
+ <a href="http://commons.apache.org/" id="bannerLeft" title="Apache Commons logo">
+ <img class="logo-left" src="./images/commons-logo.png" alt="Apache Commons logo"/>
+ </a>
+ <a href="index.html" id="bannerRight">
+ <h2>Commons JCSâ¢</h2>
+ </a>
+ <div class="clear"></div>
+
+ <div class="navbar">
+ <div class="navbar-inner">
+ <div class="container-fluid">
+ <a class="brand" href="http://commons.apache.org/proper/commons-jcs/">Apache Commons JCS ™</a>
+ <ul class="nav">
+
+ <li id="publishDate">Last Published: 23 August 2018</li>
+ <li class="divider">|</li> <li id="projectVersion">Version: 2.2.1</li>
+ </ul>
+ <div class="pull-right"> <ul class="nav">
+ <li>
+ <a href="http://www.apachecon.com/" class="externalLink" title="ApacheCon">
+ ApacheCon</a>
+ </li>
+ <li>
+ <a href="http://www.apache.org" class="externalLink" title="Apache">
+ Apache</a>
+ </li>
+ <li>
+ <a href="../../" title="Commons">
+ Commons</a>
+ </li>
+ </ul>
+</div>
+ </div>
+ </div>
+ </div>
+
+ <div class="container-fluid">
+ <table class="layout-table">
+ <tr>
+ <td class="sidebar">
+ <div class="well sidebar-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">JCS</li>
+ <li class="none">
+ <a href="index.html" title="Overview">
+ Overview</a>
+ </li>
+ <li class="none">
+ <a href="JCSandJCACHE.html" title="JCS and JCACHE">
+ JCS and JCACHE</a>
+ </li>
+ <li class="none">
+ <a href="download_jcs.cgi" title="Downloads">
+ Downloads</a>
+ </li>
+ <li class="none">
+ <a href="faq.html" title="FAQ">
+ FAQ</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header"><i class="icon-cog"></i>Development</li>
+ <li class="none">
+ <a href="changes-report.html" title="Release Notes">
+ Release Notes</a>
+ </li>
+ <li class="none">
+ <a href="UpgradingFrom13.html" title="Upgrading from 1.3 to 2.0">
+ Upgrading from 1.3 to 2.0</a>
+ </li>
+ <li class="none">
+ <a href="mail-lists.html" title="Mailing Lists">
+ Mailing Lists</a>
+ </li>
+ <li class="none">
+ <a href="issue-tracking.html" title="Issue Tracking">
+ Issue Tracking</a>
+ </li>
+ <li class="none">
+ <a href="source-repository.html" title="Source Repository">
+ Source Repository</a>
+ </li>
+ <li class="none">
+ <a href="commons-jcs-core/apidocs/index.html" title="Core Javadoc (SVN latest)">
+ Core Javadoc (SVN latest)</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">Getting Started</li>
+ <li class="none">
+ <a href="getting_started/intro.html" title="Overview">
+ Overview</a>
+ </li>
+ <li class="none">
+ <a href="BasicJCSConfiguration.html" title="Basic JCS Config">
+ Basic JCS Config</a>
+ </li>
+ <li class="none">
+ <a href="JCSPlugins.html" title="Plugin Overview">
+ Plugin Overview</a>
+ </li>
+ <li class="none">
+ <a href="UsingJCSBasicWeb.html" title="Basic Web Example">
+ Basic Web Example</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">JCS User's Guide</li>
+ <li class="collapsed">
+ <a href="LocalCacheConfig.html" title="Core">
+ Core</a>
+ </li>
+ <li class="expanded">
+ <a href="JCSPlugins.html" title="Auxiliary">
+ Auxiliary</a>
+ <ul>
+ <li class="none">
+ <a href="CacheEventLogging.html" title="Cache Event Logging">
+ Cache Event Logging</a>
+ </li>
+ <li class="none">
+ <a href="IndexedDiskAuxCache.html" title="Indexed Disk Cache">
+ Indexed Disk Cache</a>
+ </li>
+ <li class="none">
+ <a href="IndexedDiskCacheProperties.html" title="Indexed Disk Properties">
+ Indexed Disk Properties</a>
+ </li>
+ <li class="none">
+ <a href="BlockDiskCache.html" title="Block Disk Cache">
+ Block Disk Cache</a>
+ </li>
+ <li class="none">
+ <a href="JDBCDiskCache.html" title="JDBC Disk Cache">
+ JDBC Disk Cache</a>
+ </li>
+ <li class="none">
+ <a href="JDBCDiskCacheProperties.html" title="JDBC Disk Properties">
+ JDBC Disk Properties</a>
+ </li>
+ <li class="none">
+ <a href="MySQLDiskCacheProperties.html" title="MySQL Disk Properties">
+ MySQL Disk Properties</a>
+ </li>
+ <li class="none">
+ <a href="RemoteAuxCache.html" title="Remote Cache">
+ Remote Cache</a>
+ </li>
+ <li class="none">
+ <a href="RemoteCacheProperties.html" title="Remote Cache Properties">
+ Remote Cache Properties</a>
+ </li>
+ <li class="none">
+ <a href="RemoteHttpCacheProperties.html" title="Remote Http Cache Properties">
+ Remote Http Cache Properties</a>
+ </li>
+ <li class="none">
+ <a href="LateralTCPAuxCache.html" title="Lateral TCP Cache">
+ Lateral TCP Cache</a>
+ </li>
+ <li class="none active">
+ <a href="LateralTCPProperties.html" title="Lateral TCP Properties">
+ Lateral TCP Properties</a>
+ </li>
+ <li class="none">
+ <a href="LateralUDPDiscovery.html" title="Lateral UDP Discovery">
+ Lateral UDP Discovery</a>
+ </li>
+ <li class="none">
+ <a href="LateralJavaGroupsAuxCache.html" title="Lateral JGroups Cache">
+ Lateral JGroups Cache</a>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">Modules</li>
+ <li class="none">
+ <a href="commons-jcs-core/index.html" title="Apache Commons JCS :: Core">
+ Apache Commons JCS :: Core</a>
+ </li>
+ <li class="none">
+ <a href="commons-jcs-jcache/index.html" title="Apache Commons JCS :: JCache">
+ Apache Commons JCS :: JCache</a>
+ </li>
+ <li class="none">
+ <a href="commons-jcs-jcache-tck/index.html" title="Apache Commons JCS :: JCache TCK">
+ Apache Commons JCS :: JCache TCK</a>
+ </li>
+ <li class="none">
+ <a href="commons-jcs-jcache-extras/index.html" title="Apache Commons JCS :: JCache Extras">
+ Apache Commons JCS :: JCache Extras</a>
+ </li>
+ <li class="none">
+ <a href="commons-jcs-jcache-openjpa/index.html" title="Apache Commons JCS :: JCache OpenJPA">
+ Apache Commons JCS :: JCache OpenJPA</a>
+ </li>
+ <li class="none">
+ <a href="commons-jcs-dist/index.html" title="Apache Commons JCS :: Distribution">
+ Apache Commons JCS :: Distribution</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header"><i class="icon-info-sign"></i>Project Documentation</li>
+ <li class="collapsed">
+ <a href="project-info.html" title="Project Information">
+ Project Information</a>
+ </li>
+ <li class="collapsed">
+ <a href="project-reports.html" title="Project Reports">
+ Project Reports</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">Commons</li>
+ <li class="none">
+ <a href="../../" title="Home">
+ Home</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/licenses/" class="externalLink" title="License">
+ License</a>
+ </li>
+ <li class="collapsed">
+ <a href="../../components.html" title="Components">
+ Components</a>
+ </li>
+ <li class="collapsed">
+ <a href="../../sandbox/index.html" title="Sandbox">
+ Sandbox</a>
+ </li>
+ <li class="collapsed">
+ <a href="../../dormant/index.html" title="Dormant">
+ Dormant</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">General Information</li>
+ <li class="none">
+ <a href="../../security.html" title="Security">
+ Security</a>
+ </li>
+ <li class="none">
+ <a href="../../volunteering.html" title="Volunteering">
+ Volunteering</a>
+ </li>
+ <li class="none">
+ <a href="../../patches.html" title="Contributing Patches">
+ Contributing Patches</a>
+ </li>
+ <li class="none">
+ <a href="../../building.html" title="Building Components">
+ Building Components</a>
+ </li>
+ <li class="none">
+ <a href="../../commons-parent-pom.html" title="Commons Parent Pom">
+ Commons Parent Pom</a>
+ </li>
+ <li class="none">
+ <a href="../../build-plugin/index.html" title="Commons Build Plugin">
+ Commons Build Plugin</a>
+ </li>
+ <li class="none">
+ <a href="../../releases/index.html" title="Releasing Components">
+ Releasing Components</a>
+ </li>
+ <li class="none">
+ <a href="http://wiki.apache.org/commons/FrontPage" class="externalLink" title="Wiki">
+ Wiki</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">ASF</li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink" title="How the ASF works">
+ How the ASF works</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/getinvolved.html" class="externalLink" title="Get Involved">
+ Get Involved</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/dev/" class="externalLink" title="Developer Resources">
+ Developer Resources</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/policies/conduct.html" class="externalLink" title="Code of Conduct">
+ Code of Conduct</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsorship">
+ Sponsorship</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks">
+ Thanks</a>
+ </li>
+ </ul>
+ </div>
+ <div id="poweredBy">
+ <a href="http://www.apache.org/events/current-event.html" title="ApacheCon" class="builtBy">
+ <img class="builtBy" alt="ApacheCon" src="http://www.apache.org/events/current-event-125x125.png" />
+ </a>
+ <a href="http://maven.apache.org/" title="Maven" class="builtBy">
+ <img class="builtBy" alt="Maven" src="http://maven.apache.org/images/logos/maven-feather.png" />
+ </a>
+ </div>
+ </td>
+ <td class="content">
+
+
+ <div class="section">
+<h2><a name="Lateral_TCP_Auxiliary_Cache_Configuration"></a>Lateral TCP Auxiliary Cache Configuration</h2>
+
+<p> The following properties apply to the TCP Lateral Cache plugin.
+ </p>
+
+<div class="section">
+<h3><a name="TCP_Configuration_Properties"></a>TCP Configuration Properties</h3>
+
+<table border="0" class="bodyTable">
+
+<tr class="a">
+
+<th>Property</th>
+
+<th>Description</th>
+
+<th>Required</th>
+
+<th>Default Value</th>
+ </tr>
+
+<tr class="b">
+
+<td>TcpServers</td>
+
+<td> This is the list of servers this cache should try to connect
+ to. With UDP discovery this is not necessary.</td>
+
+<td>N</td>
+
+<td>none</td>
+ </tr>
+
+<tr class="a">
+
+<td>TcpListenerPort</td>
+
+<td> This is the port this cache should listen on.</td>
+
+<td>Y</td>
+
+<td>n/a</td>
+ </tr>
+
+<tr class="b">
+
+<td>AllowGet</td>
+
+<td> Should this cache be allowed to get from other laterals.
+ False means that it can only put, i.e. send updates and remove
+ requests to other laterals. Lateral gets are not recommended for
+ performance reasons. This used to be controlled by the attribute
+ PutOnlyMode.</td>
+
+<td>N</td>
+
+<td>true</td>
+ </tr>
+
+<tr class="a">
+
+<td>Receive</td>
+
+<td> Should this cache receive or only send to other laterals. You
+ may want to set receive to false if you just need to broadcast to
+ other caches. If you have a feed data parser, that doesn't need
+ to receive updates, but you do want it to send invalidation
+ messages, then you would set receive to false. If receive is
+ false, the discovery service, if enabled, will only listen.</td>
+
+<td>N</td>
+
+<td>true</td>
+ </tr>
+
+<tr class="b">
+
+<td>IssueRemoveOnPut</td>
+
+<td> If this is set to true, then the lateral client will send a
+ remove command rather than a put command to any registered
+ listeners.</td>
+
+<td>N</td>
+
+<td>false</td>
+ </tr>
+
+<tr class="a">
+
+<td>FilterRemoveByHashCode</td>
+
+<td> If this is true, and IssueRemoveOnPut is true, the client
+ will include the hashCode of the element to remove. If it is also
+ true on the receiving end, the receiver will check to see if the
+ element exists. If the element exists, and the hashCodes are the
+ same, the item will not be removed.</td>
+
+<td>N</td>
+
+<td>false</td>
+ </tr>
+
+<tr class="b">
+
+<td>SocketTimeOut</td>
+
+<td> This allows you to set the socket (read) timeout.</td>
+
+<td>N</td>
+
+<td>1000</td>
+ </tr>
+
+<tr class="a">
+
+<td>OpenTimeOut</td>
+
+<td> This allows you to set the socket open timeout.</td>
+
+<td>N</td>
+
+<td>2000</td>
+ </tr>
+
+<tr class="b">
+
+<td>UdpDiscoveryAddr</td>
+
+<td> The address the UDP discovery process should broadcast
+ messages to.</td>
+
+<td>N</td>
+
+<td>228.5.6.7</td>
+ </tr>
+
+<tr class="a">
+
+<td>UdpDiscoveryPort</td>
+
+<td> The port the UDP discovery process should send messages to.
+ </td>
+
+<td>N</td>
+
+<td>6789</td>
+ </tr>
+
+<tr class="b">
+
+<td>UdpDiscoveryEnabled</td>
+
+<td> Whether or not the UDP discovery service should be used to
+ locate other lateral caches.</td>
+
+<td>N</td>
+
+<td>true</td>
+ </tr>
+
+<tr class="a">
+
+<td>ZombieQueueMaxSize</td>
+
+<td> The number of elements the zombie queue will hold. This queue
+ is used to store events if we lose our connection with the
+ server.</td>
+
+<td>N</td>
+
+<td>1000</td>
+ </tr>
+ </table>
+ </div>
+
+<div class="section">
+<h3><a name="Example_Configuration"></a>Example Configuration</h3>
+
+<div class="source">
+<pre>
+jcs.auxiliary.LTCP=org.apache.commons.jcs.auxiliary.lateral.socket.tcp.LateralTCPCacheFactory
+jcs.auxiliary.LTCP.attributes=org.apache.commons.jcs.auxiliary.lateral.socket.tcp.TCPLateralCacheAttributes
+#jcs.auxiliary.LTCP.attributes.TcpServers=
+jcs.auxiliary.LTCP.attributes.TcpListenerPort=1118
+jcs.auxiliary.LTCP.attributes.UdpDiscoveryAddr=228.5.6.8
+jcs.auxiliary.LTCP.attributes.UdpDiscoveryPort=6780
+jcs.auxiliary.LTCP.attributes.UdpDiscoveryEnabled=true
+jcs.auxiliary.LTCP.attributes.Receive=true
+jcs.auxiliary.LTCP.attributes.AllowGet=false
+jcs.auxiliary.LTCP.attributes.IssueRemoveOnPut=false
+jcs.auxiliary.LTCP.attributes.FilterRemoveByHashCode=false
+jcs.auxiliary.LTCP.attributes.SocketTimeoOt=1001
+jcs.auxiliary.LTCP.attributes.OpenTimeOut=2002
+jcs.auxiliary.LTCP.attributes.ZombieQueueMaxSize=2000
+ </pre></div>
+ </div>
+ </div>
+
+
+ </td>
+ </tr>
+ </table>
+ </div>
+
+ <div class="footer">
+ <p>Copyright © 2002-2018
+ <a href="https://www.apache.org/">The Apache Software Foundation</a>.
+ All Rights Reserved.</p>
+ </div>
+ </body>
+
+</html>
Added: dev/commons/jcs/site-2.2.1-RC4/LateralUDPDiscovery.html
==============================================================================
--- dev/commons/jcs/site-2.2.1-RC4/LateralUDPDiscovery.html (added)
+++ dev/commons/jcs/site-2.2.1-RC4/LateralUDPDiscovery.html Thu Aug 23 13:24:56 2018
@@ -0,0 +1,406 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 23 August 2018
+ | Rendered using Apache Maven Fluido Skin 1.3.0
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="author" content="Aaron Smuts" />
+ <meta name="Date-Revision-yyyymmdd" content="20180823" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>JCS – Lateral UDP Discovery</title>
+
+ <link rel="stylesheet" href="./css/bootstrap.min.css" type="text/css" />
+ <link rel="stylesheet" href="./css/site.css" type="text/css" />
+ <link rel="stylesheet" href="./css/print.css" media="print" />
+
+ <script type="text/javascript" src="./js/jquery.min.js"></script>
+ <script type="text/javascript" src="./js/bootstrap.min.js"></script>
+ <script type="text/javascript" src="./js/prettify.min.js"></script>
+ <script type="text/javascript" src="./js/site.js"></script>
+
+
+ </head>
+
+ <body class="composite">
+ <a href="http://commons.apache.org/" id="bannerLeft" title="Apache Commons logo">
+ <img class="logo-left" src="./images/commons-logo.png" alt="Apache Commons logo"/>
+ </a>
+ <a href="index.html" id="bannerRight">
+ <h2>Commons JCSâ¢</h2>
+ </a>
+ <div class="clear"></div>
+
+ <div class="navbar">
+ <div class="navbar-inner">
+ <div class="container-fluid">
+ <a class="brand" href="http://commons.apache.org/proper/commons-jcs/">Apache Commons JCS ™</a>
+ <ul class="nav">
+
+ <li id="publishDate">Last Published: 23 August 2018</li>
+ <li class="divider">|</li> <li id="projectVersion">Version: 2.2.1</li>
+ </ul>
+ <div class="pull-right"> <ul class="nav">
+ <li>
+ <a href="http://www.apachecon.com/" class="externalLink" title="ApacheCon">
+ ApacheCon</a>
+ </li>
+ <li>
+ <a href="http://www.apache.org" class="externalLink" title="Apache">
+ Apache</a>
+ </li>
+ <li>
+ <a href="../../" title="Commons">
+ Commons</a>
+ </li>
+ </ul>
+</div>
+ </div>
+ </div>
+ </div>
+
+ <div class="container-fluid">
+ <table class="layout-table">
+ <tr>
+ <td class="sidebar">
+ <div class="well sidebar-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">JCS</li>
+ <li class="none">
+ <a href="index.html" title="Overview">
+ Overview</a>
+ </li>
+ <li class="none">
+ <a href="JCSandJCACHE.html" title="JCS and JCACHE">
+ JCS and JCACHE</a>
+ </li>
+ <li class="none">
+ <a href="download_jcs.cgi" title="Downloads">
+ Downloads</a>
+ </li>
+ <li class="none">
+ <a href="faq.html" title="FAQ">
+ FAQ</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header"><i class="icon-cog"></i>Development</li>
+ <li class="none">
+ <a href="changes-report.html" title="Release Notes">
+ Release Notes</a>
+ </li>
+ <li class="none">
+ <a href="UpgradingFrom13.html" title="Upgrading from 1.3 to 2.0">
+ Upgrading from 1.3 to 2.0</a>
+ </li>
+ <li class="none">
+ <a href="mail-lists.html" title="Mailing Lists">
+ Mailing Lists</a>
+ </li>
+ <li class="none">
+ <a href="issue-tracking.html" title="Issue Tracking">
+ Issue Tracking</a>
+ </li>
+ <li class="none">
+ <a href="source-repository.html" title="Source Repository">
+ Source Repository</a>
+ </li>
+ <li class="none">
+ <a href="commons-jcs-core/apidocs/index.html" title="Core Javadoc (SVN latest)">
+ Core Javadoc (SVN latest)</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">Getting Started</li>
+ <li class="none">
+ <a href="getting_started/intro.html" title="Overview">
+ Overview</a>
+ </li>
+ <li class="none">
+ <a href="BasicJCSConfiguration.html" title="Basic JCS Config">
+ Basic JCS Config</a>
+ </li>
+ <li class="none">
+ <a href="JCSPlugins.html" title="Plugin Overview">
+ Plugin Overview</a>
+ </li>
+ <li class="none">
+ <a href="UsingJCSBasicWeb.html" title="Basic Web Example">
+ Basic Web Example</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">JCS User's Guide</li>
+ <li class="collapsed">
+ <a href="LocalCacheConfig.html" title="Core">
+ Core</a>
+ </li>
+ <li class="expanded">
+ <a href="JCSPlugins.html" title="Auxiliary">
+ Auxiliary</a>
+ <ul>
+ <li class="none">
+ <a href="CacheEventLogging.html" title="Cache Event Logging">
+ Cache Event Logging</a>
+ </li>
+ <li class="none">
+ <a href="IndexedDiskAuxCache.html" title="Indexed Disk Cache">
+ Indexed Disk Cache</a>
+ </li>
+ <li class="none">
+ <a href="IndexedDiskCacheProperties.html" title="Indexed Disk Properties">
+ Indexed Disk Properties</a>
+ </li>
+ <li class="none">
+ <a href="BlockDiskCache.html" title="Block Disk Cache">
+ Block Disk Cache</a>
+ </li>
+ <li class="none">
+ <a href="JDBCDiskCache.html" title="JDBC Disk Cache">
+ JDBC Disk Cache</a>
+ </li>
+ <li class="none">
+ <a href="JDBCDiskCacheProperties.html" title="JDBC Disk Properties">
+ JDBC Disk Properties</a>
+ </li>
+ <li class="none">
+ <a href="MySQLDiskCacheProperties.html" title="MySQL Disk Properties">
+ MySQL Disk Properties</a>
+ </li>
+ <li class="none">
+ <a href="RemoteAuxCache.html" title="Remote Cache">
+ Remote Cache</a>
+ </li>
+ <li class="none">
+ <a href="RemoteCacheProperties.html" title="Remote Cache Properties">
+ Remote Cache Properties</a>
+ </li>
+ <li class="none">
+ <a href="RemoteHttpCacheProperties.html" title="Remote Http Cache Properties">
+ Remote Http Cache Properties</a>
+ </li>
+ <li class="none">
+ <a href="LateralTCPAuxCache.html" title="Lateral TCP Cache">
+ Lateral TCP Cache</a>
+ </li>
+ <li class="none">
+ <a href="LateralTCPProperties.html" title="Lateral TCP Properties">
+ Lateral TCP Properties</a>
+ </li>
+ <li class="none active">
+ <a href="LateralUDPDiscovery.html" title="Lateral UDP Discovery">
+ Lateral UDP Discovery</a>
+ </li>
+ <li class="none">
+ <a href="LateralJavaGroupsAuxCache.html" title="Lateral JGroups Cache">
+ Lateral JGroups Cache</a>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">Modules</li>
+ <li class="none">
+ <a href="commons-jcs-core/index.html" title="Apache Commons JCS :: Core">
+ Apache Commons JCS :: Core</a>
+ </li>
+ <li class="none">
+ <a href="commons-jcs-jcache/index.html" title="Apache Commons JCS :: JCache">
+ Apache Commons JCS :: JCache</a>
+ </li>
+ <li class="none">
+ <a href="commons-jcs-jcache-tck/index.html" title="Apache Commons JCS :: JCache TCK">
+ Apache Commons JCS :: JCache TCK</a>
+ </li>
+ <li class="none">
+ <a href="commons-jcs-jcache-extras/index.html" title="Apache Commons JCS :: JCache Extras">
+ Apache Commons JCS :: JCache Extras</a>
+ </li>
+ <li class="none">
+ <a href="commons-jcs-jcache-openjpa/index.html" title="Apache Commons JCS :: JCache OpenJPA">
+ Apache Commons JCS :: JCache OpenJPA</a>
+ </li>
+ <li class="none">
+ <a href="commons-jcs-dist/index.html" title="Apache Commons JCS :: Distribution">
+ Apache Commons JCS :: Distribution</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header"><i class="icon-info-sign"></i>Project Documentation</li>
+ <li class="collapsed">
+ <a href="project-info.html" title="Project Information">
+ Project Information</a>
+ </li>
+ <li class="collapsed">
+ <a href="project-reports.html" title="Project Reports">
+ Project Reports</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">Commons</li>
+ <li class="none">
+ <a href="../../" title="Home">
+ Home</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/licenses/" class="externalLink" title="License">
+ License</a>
+ </li>
+ <li class="collapsed">
+ <a href="../../components.html" title="Components">
+ Components</a>
+ </li>
+ <li class="collapsed">
+ <a href="../../sandbox/index.html" title="Sandbox">
+ Sandbox</a>
+ </li>
+ <li class="collapsed">
+ <a href="../../dormant/index.html" title="Dormant">
+ Dormant</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">General Information</li>
+ <li class="none">
+ <a href="../../security.html" title="Security">
+ Security</a>
+ </li>
+ <li class="none">
+ <a href="../../volunteering.html" title="Volunteering">
+ Volunteering</a>
+ </li>
+ <li class="none">
+ <a href="../../patches.html" title="Contributing Patches">
+ Contributing Patches</a>
+ </li>
+ <li class="none">
+ <a href="../../building.html" title="Building Components">
+ Building Components</a>
+ </li>
+ <li class="none">
+ <a href="../../commons-parent-pom.html" title="Commons Parent Pom">
+ Commons Parent Pom</a>
+ </li>
+ <li class="none">
+ <a href="../../build-plugin/index.html" title="Commons Build Plugin">
+ Commons Build Plugin</a>
+ </li>
+ <li class="none">
+ <a href="../../releases/index.html" title="Releasing Components">
+ Releasing Components</a>
+ </li>
+ <li class="none">
+ <a href="http://wiki.apache.org/commons/FrontPage" class="externalLink" title="Wiki">
+ Wiki</a>
+ </li>
+ </ul>
+ <ul class="nav nav-list">
+ <li class="nav-header">ASF</li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink" title="How the ASF works">
+ How the ASF works</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/getinvolved.html" class="externalLink" title="Get Involved">
+ Get Involved</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/dev/" class="externalLink" title="Developer Resources">
+ Developer Resources</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/policies/conduct.html" class="externalLink" title="Code of Conduct">
+ Code of Conduct</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsorship">
+ Sponsorship</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks">
+ Thanks</a>
+ </li>
+ </ul>
+ </div>
+ <div id="poweredBy">
+ <a href="http://www.apache.org/events/current-event.html" title="ApacheCon" class="builtBy">
+ <img class="builtBy" alt="ApacheCon" src="http://www.apache.org/events/current-event-125x125.png" />
+ </a>
+ <a href="http://maven.apache.org/" title="Maven" class="builtBy">
+ <img class="builtBy" alt="Maven" src="http://maven.apache.org/images/logos/maven-feather.png" />
+ </a>
+ </div>
+ </td>
+ <td class="content">
+
+
+ <div class="section">
+<h2><a name="Lateral_UDP_Discovery"></a>Lateral UDP Discovery</h2>
+
+<p>
+ Rather than list all the other lateral servers in the configuration
+ file, you can configure the TCP lateral to use UDP
+ discovery. In discovery mode, lateral TCP caches will broadcast
+ to a multicast address and port, letting all listeners know where they are.
+ </p>
+
+<p>
+ On startup each lateral will issue a special message requesting a
+ broadcast from the other caches. Normal broadcasts occur every
+ 30 seconds. (This is to be made configurable.) Regions that don't
+ receive, are running in send only mode, don't broadcast anything but requests.
+ </p>
+
+<p>
+ When a lateral receives a discovery message it will try to add
+ the lateral to the nowait facade for the region. If it already exists
+ nothing happens. If a region is not configured to send laterally, nothing
+ happens, since it doesn't have a no wait.
+ </p>
+
+<p>
+ This allows you to have the same configuration on every machine.
+ </p>
+
+<div class="section">
+<h3><a name="Configuration"></a>Configuration</h3>
+
+<p>
+ The configuration is fairly straightforward and is done in the
+ auxiliary cache section of the <tt>cache.ccf</tt>
+ configuration file. In the example below, I created a TCP
+ Lateral Auxiliary Cache referenced by <tt>LTCP</tt>. It uses
+ UDP Discovery to locate other servers. It broadcasts to
+ multicast address <tt>228.5.6.8</tt> and port <tt>6780</tt>.
+ It listens to port <tt>1110</tt>.
+ </p>
+
+<div class="source">
+<pre>
+jcs.auxiliary.LTCP=org.apache.commons.jcs.auxiliary.lateral.socket.tcp.LateralTCPCacheFactory
+jcs.auxiliary.LTCP.attributes=org.apache.commons.jcs.auxiliary.lateral.socket.tcp.TCPLateralCacheAttributes
+jcs.auxiliary.LTCP.attributes.TcpListenerPort=1110
+jcs.auxiliary.LTCP.attributes.PutOnlyMode=true
+jcs.auxiliary.LTCP.attributes.UdpDiscoveryAddr=228.5.6.8
+jcs.auxiliary.LTCP.attributes.UdpDiscoveryPort=6780
+jcs.auxiliary.LTCP.attributes.UdpDiscoveryEnabled=true
+ </pre></div>
+ </div>
+ </div>
+
+
+ </td>
+ </tr>
+ </table>
+ </div>
+
+ <div class="footer">
+ <p>Copyright © 2002-2018
+ <a href="https://www.apache.org/">The Apache Software Foundation</a>.
+ All Rights Reserved.</p>
+ </div>
+ </body>
+
+</html>