This is an automated email from the ASF dual-hosted git repository.
kmiller pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/geode.git
The following commit(s) were added to refs/heads/develop by this push:
new 93a484d GEODE-4984 Add new Use Cases section to docs (#1733)
93a484d is described below
commit 93a484de3bd71ca574403eb018661c0845eb9f1b
Author: Karen Miller <[email protected]>
AuthorDate: Wed Apr 4 13:10:54 2018 -0700
GEODE-4984 Add new Use Cases section to docs (#1733)
- add the start of a subsection on using Geode as an inline cache
---
.../source/subnavs/geode-subnav.erb | 8 ++++
geode-docs/images/inline-cache.png | Bin 0 -> 18797 bytes
geode-docs/use_cases/book_intro.html.md.erb | 32 +++++++++++++++
geode-docs/use_cases/inline-cache.html.md.erb | 44 +++++++++++++++++++++
4 files changed, 84 insertions(+)
diff --git a/geode-book/master_middleman/source/subnavs/geode-subnav.erb
b/geode-book/master_middleman/source/subnavs/geode-subnav.erb
index 0677cea..2f12b59 100644
--- a/geode-book/master_middleman/source/subnavs/geode-subnav.erb
+++ b/geode-book/master_middleman/source/subnavs/geode-subnav.erb
@@ -2336,6 +2336,14 @@ gfsh</a>
</ul>
</li>
<li class="has_submenu">
+ <a
href="/docs/guide/<%=vars.product_version_nodot%>/use_cases/book_intro.html">Use
Cases</a>
+ <ul>
+ <li>
+ <a
href="/docs/guide/<%=vars.product_version_nodot%>/use_cases/inline-cache.html">The
Inline Cache</a>
+ </li>
+ </ul>
+ </li>
+ <li class="has_submenu">
<a
href="/docs/guide/<%=vars.product_version_nodot%>/reference/book_intro.html">Reference</a>
<ul>
<li class="has_submenu">
diff --git a/geode-docs/images/inline-cache.png
b/geode-docs/images/inline-cache.png
new file mode 100644
index 0000000..99c823b
Binary files /dev/null and b/geode-docs/images/inline-cache.png differ
diff --git a/geode-docs/use_cases/book_intro.html.md.erb
b/geode-docs/use_cases/book_intro.html.md.erb
new file mode 100644
index 0000000..34ae3f5
--- /dev/null
+++ b/geode-docs/use_cases/book_intro.html.md.erb
@@ -0,0 +1,32 @@
+---
+title: Use Cases
+---
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+<%=vars.product_name%> may be used to implement a wide variety
+of designs. This section introduces designs and informs developers how to
+implement and configure those designs.
+
+<a id="Use_Cases"></a>
+
+- **[The Inline Cache](inline-cache.html)**
+
+ This classic caching structure causes a backend data store lookup
+upon a cache miss.
+
diff --git a/geode-docs/use_cases/inline-cache.html.md.erb
b/geode-docs/use_cases/inline-cache.html.md.erb
new file mode 100644
index 0000000..87e1e5b
--- /dev/null
+++ b/geode-docs/use_cases/inline-cache.html.md.erb
@@ -0,0 +1,44 @@
+---
+title: The Inline Cache
+---
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+An inline cache holds region entries for a client application.
+
+## Description of an Inline Cache
+
+A cache is formed from a region within a <%=vars.product_name%> cluster,
+and the cache sits between the client application and a
+backing data store.
+
+<img src="../images/inline-cache.png" id="inline-cache-png" class="image" />
+
+The client application's cache lookup is a region get
+operation, and a cache write is a region put operation.
+
+When the cache (region) has the requested region entry,
+it quickly responds with the value for a lookup operation.
+This is a cache hit.
+If the requested region entry is not in the region,
+it is a cache miss,
+and code that has been deployed to the server acquires the
+entry from the data store.
+The acquired region entry is written to the region
+such that future lookups will cause a cache hit.
+
+## Implementation and Configuration
--
To stop receiving notification emails like this one, please contact
[email protected].
