go-neb/pkg/github.com/die-net/lrucache/index.html

<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="theme-color" content="#375EAB">

  <title>lrucache - The Go Programming Language</title>

<link type="text/css" rel="stylesheet" href="../../../../lib/godoc/style.css">

<link rel="stylesheet" href="../../../../lib/godoc/jquery.treeview.css">
<script type="text/javascript">window.initFuncs = [];</script>
</head>
<body>

<div id='lowframe' style="position: fixed; bottom: 0; left: 0; height: 0; width: 100%; border-top: thin solid grey; background-color: white; overflow: auto;">
...
</div><!-- #lowframe -->

<div id="topbar" class="wide"><div class="container">
<div class="top-heading" id="heading-wide"><a href="http://localhost:6060/">The Go Programming Language</a></div>
<div class="top-heading" id="heading-narrow"><a href="http://localhost:6060/">Go</a></div>
<a href="index.html#" id="menu-button"><span id="menu-button-arrow">&#9661;</span></a>
<form method="GET" action="http://localhost:6060/search">
<div id="menu">
<a href="http://localhost:6060/doc/">Documents</a>
<a href="http://localhost:6060/pkg/">Packages</a>
<a href="http://localhost:6060/project/">The Project</a>
<a href="http://localhost:6060/help/">Help</a>
<a href="http://localhost:6060/blog/">Blog</a>

<input type="text" id="search" name="q" class="inactive" value="Search" placeholder="Search">
</div>
</form>

</div></div>


<div id="page" class="wide">
<div class="container">


  <h1>Package lrucache</h1>


<div id="nav"></div>


<!--
	Copyright 2009 The Go Authors. All rights reserved.
	Use of this source code is governed by a BSD-style
	license that can be found in the LICENSE file.
-->
<!--
	Note: Static (i.e., not template-generated) href and id
	attributes start with "pkg-" to make it impossible for
	them to conflict with generated attributes (some of which
	correspond to Go identifiers).
-->

	<script type='text/javascript'>
	document.ANALYSIS_DATA = null;
	document.CALLGRAPH = null;
	</script>

	
		<div id="short-nav">
			<dl>
			<dd><code>import "github.com/die-net/lrucache"</code></dd>
			</dl>
			<dl>
			<dd><a href="index.html#pkg-overview" class="overviewLink">Overview</a></dd>
			<dd><a href="index.html#pkg-index" class="indexLink">Index</a></dd>
			
			
				<dd><a href="index.html#pkg-subdirectories">Subdirectories</a></dd>
			
			</dl>
		</div>
		<!-- The package's Name is printed as title by the top-level template -->
		<div id="pkg-overview" class="toggleVisible">
			<div class="collapsed">
				<h2 class="toggleButton" title="Click to show Overview section">Overview ▹</h2>
			</div>
			<div class="expanded">
				<h2 class="toggleButton" title="Click to hide Overview section">Overview ▾</h2>
				<p>
Package lrucache provides a byte-size-limited implementation of
httpcache.Cache that stores data in memory.
</p>

			</div>
		</div>
		

		<div id="pkg-index" class="toggleVisible">
		<div class="collapsed">
			<h2 class="toggleButton" title="Click to show Index section">Index ▹</h2>
		</div>
		<div class="expanded">
			<h2 class="toggleButton" title="Click to hide Index section">Index ▾</h2>

		<!-- Table of contents for API; must be named manual-nav to turn off auto nav. -->
			<div id="manual-nav">
			<dl>
			
			
				<dd><a href="index.html#LruCache">type LruCache</a></dd>
				
					
					<dd>&nbsp; &nbsp; <a href="index.html#New">func New(maxSize int64, maxAge int64) *LruCache</a></dd>
				
				
					<dd>&nbsp; &nbsp; <a href="index.html#LruCache.Delete">func (c *LruCache) Delete(key string)</a></dd>
				
					
					<dd>&nbsp; &nbsp; <a href="index.html#LruCache.Get">func (c *LruCache) Get(key string) ([]byte, bool)</a></dd>
				
					
					<dd>&nbsp; &nbsp; <a href="index.html#LruCache.Set">func (c *LruCache) Set(key string, value []byte)</a></dd>
				
					
					<dd>&nbsp; &nbsp; <a href="index.html#LruCache.Size">func (c *LruCache) Size() int64</a></dd>
				
			
			</dl>
			</div><!-- #manual-nav -->

		
			<h4>Package files</h4>
			<p>
			<span style="font-size:90%">
			
				<a href="http://localhost:6060/src/github.com/die-net/lrucache/lrucache.go">lrucache.go</a>
			
			</span>
			</p>
		
		</div><!-- .expanded -->
		</div><!-- #pkg-index -->

		<div id="pkg-callgraph" class="toggle" style="display: none">
		<div class="collapsed">
			<h2 class="toggleButton" title="Click to show Internal Call Graph section">Internal call graph ▹</h2>
		</div> <!-- .expanded -->
		<div class="expanded">
			<h2 class="toggleButton" title="Click to hide Internal Call Graph section">Internal call graph ▾</h2>
			<p>
			  In the call graph viewer below, each node
			  is a function belonging to this package
			  and its children are the functions it
			  calls&mdash;perhaps dynamically.
			</p>
			<p>
			  The root nodes are the entry points of the
			  package: functions that may be called from
			  outside the package.
			  There may be non-exported or anonymous
			  functions among them if they are called
			  dynamically from another package.
			</p>
			<p>
			  Click a node to visit that function's source code.
			  From there you can visit its callers by
			  clicking its declaring <code>func</code>
			  token.
			</p>
			<p>
			  Functions may be omitted if they were
			  determined to be unreachable in the
			  particular programs or tests that were
			  analyzed.
			</p>
			<!-- Zero means show all package entry points. -->
			<ul style="margin-left: 0.5in" id="callgraph-0" class="treeview"></ul>
		</div>
		</div> <!-- #pkg-callgraph -->

		
			<h2 id="LruCache">type <a href="http://localhost:6060/src/github.com/die-net/lrucache/lrucache.go?s=454:615#L5">LruCache</a></h2>
			<pre>type LruCache struct {
    MaxSize <a href="../../../builtin/index.html#int64">int64</a>
    MaxAge  <a href="../../../builtin/index.html#int64">int64</a>
    <span class="comment">// contains filtered or unexported fields</span>
}</pre>
			<p>
LruCache is a thread-safe, in-memory httpcache.Cache that evicts the
least recently used entries from memory when either MaxSize (in bytes)
limit would be exceeded or (if set) the entries are older than MaxAge (in
seconds).  Use the New constructor to create one.
</p>


				<h3 id="New">func <a href="http://localhost:6060/src/github.com/die-net/lrucache/lrucache.go?s=771:818#L18">New</a></h3>
				<pre>func New(maxSize <a href="../../../builtin/index.html#int64">int64</a>, maxAge <a href="../../../builtin/index.html#int64">int64</a>) *<a href="index.html#LruCache">LruCache</a></pre>
				<p>
New creates an LruCache that will restrict itself to maxSize bytes of
memory.  If maxAge &gt; 0, entries will also be expired after maxAge
seconds.
</p>

				
				<h3 id="LruCache.Delete">func (*LruCache) <a href="http://localhost:6060/src/github.com/die-net/lrucache/lrucache.go?s=2155:2192#L82">Delete</a></h3>
				<pre>func (c *<a href="index.html#LruCache">LruCache</a>) Delete(key <a href="../../../builtin/index.html#string">string</a>)</pre>
				<p>
Delete removes the value associated with a key.
</p>

				
				<h3 id="LruCache.Get">func (*LruCache) <a href="http://localhost:6060/src/github.com/die-net/lrucache/lrucache.go?s=1070:1119#L31">Get</a></h3>
				<pre>func (c *<a href="index.html#LruCache">LruCache</a>) Get(key <a href="../../../builtin/index.html#string">string</a>) ([]<a href="../../../builtin/index.html#byte">byte</a>, <a href="../../../builtin/index.html#bool">bool</a>)</pre>
				<p>
Get returns the []byte representation of a cached response and a bool
set to true if the key was found.
</p>

				
				<h3 id="LruCache.Set">func (*LruCache) <a href="http://localhost:6060/src/github.com/die-net/lrucache/lrucache.go?s=1613:1661#L56">Set</a></h3>
				<pre>func (c *<a href="index.html#LruCache">LruCache</a>) Set(key <a href="../../../builtin/index.html#string">string</a>, value []<a href="../../../builtin/index.html#byte">byte</a>)</pre>
				<p>
Set stores the []byte representation of a response for a given key.
</p>

				
				<h3 id="LruCache.Size">func (*LruCache) <a href="http://localhost:6060/src/github.com/die-net/lrucache/lrucache.go?s=2350:2381#L93">Size</a></h3>
				<pre>func (c *<a href="index.html#LruCache">LruCache</a>) Size() <a href="../../../builtin/index.html#int64">int64</a></pre>
				<p>
Size returns the estimated current memory usage of LruCache.
</p>

				
		<h2 id="pkg-subdirectories">Subdirectories</h2>
	
	
	<div class="pkg-dir">
		<table>
			<tr>
				<th class="pkg-name">Name</th>
				<th class="pkg-synopsis">Synopsis</th>
			</tr>

			
			<tr>
				<td colspan="2"><a href="../index.html">..</a></td>
			</tr>
			

					<tr>
						<td class="pkg-name" style="padding-left: 0px;">
							<a href="twotier/index.html">twotier</a>
						</td>
						<td class="pkg-synopsis">
							Package twotier provides a wrapper for two httpcache.Cache instances, allowing you to use both a small and fast cache for popular objects and fall back to a larger and slower cache for less popular ones.
						</td>
					</tr>
				
			
		</table>
	</div>


<div id="footer">
Build version go1.6.<br>
Except as <a href="https://developers.google.com/site-policies#restrictions">noted</a>,
the content of this page is licensed under the
Creative Commons Attribution 3.0 License,
and code is licensed under a <a href="http://localhost:6060/LICENSE">BSD license</a>.<br>
<a href="http://localhost:6060/doc/tos.html">Terms of Service</a> | 
<a href="http://www.google.com/intl/en/policies/privacy/">Privacy Policy</a>
</div>

</div><!-- .container -->
</div><!-- #page -->

<!-- TODO(adonovan): load these from <head> using "defer" attribute? -->
<script type="text/javascript" src="../../../../lib/godoc/jquery.js"></script>
<script type="text/javascript" src="../../../../lib/godoc/jquery.treeview.js"></script>
<script type="text/javascript" src="../../../../lib/godoc/jquery.treeview.edit.js"></script>


<script type="text/javascript" src="../../../../lib/godoc/godocs.js"></script>

</body>
</html>