You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

310 lines
9.3 KiB

8 years ago
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  5. <meta name="viewport" content="width=device-width, initial-scale=1">
  6. <meta name="theme-color" content="#375EAB">
  7. <title>memcache - The Go Programming Language</title>
  8. <link type="text/css" rel="stylesheet" href="../../../../../lib/godoc/style.css">
  9. <link rel="stylesheet" href="../../../../../lib/godoc/jquery.treeview.css">
  10. <script type="text/javascript">window.initFuncs = [];</script>
  11. </head>
  12. <body>
  13. <div id='lowframe' style="position: fixed; bottom: 0; left: 0; height: 0; width: 100%; border-top: thin solid grey; background-color: white; overflow: auto;">
  14. ...
  15. </div><!-- #lowframe -->
  16. <div id="topbar" class="wide"><div class="container">
  17. <div class="top-heading" id="heading-wide"><a href="http://localhost:6060/">The Go Programming Language</a></div>
  18. <div class="top-heading" id="heading-narrow"><a href="http://localhost:6060/">Go</a></div>
  19. <a href="index.html#" id="menu-button"><span id="menu-button-arrow">&#9661;</span></a>
  20. <form method="GET" action="http://localhost:6060/search">
  21. <div id="menu">
  22. <a href="http://localhost:6060/doc/">Documents</a>
  23. <a href="http://localhost:6060/pkg/">Packages</a>
  24. <a href="http://localhost:6060/project/">The Project</a>
  25. <a href="http://localhost:6060/help/">Help</a>
  26. <a href="http://localhost:6060/blog/">Blog</a>
  27. <input type="text" id="search" name="q" class="inactive" value="Search" placeholder="Search">
  28. </div>
  29. </form>
  30. </div></div>
  31. <div id="page" class="wide">
  32. <div class="container">
  33. <h1>Package memcache</h1>
  34. <div id="nav"></div>
  35. <!--
  36. Copyright 2009 The Go Authors. All rights reserved.
  37. Use of this source code is governed by a BSD-style
  38. license that can be found in the LICENSE file.
  39. -->
  40. <!--
  41. Note: Static (i.e., not template-generated) href and id
  42. attributes start with "pkg-" to make it impossible for
  43. them to conflict with generated attributes (some of which
  44. correspond to Go identifiers).
  45. -->
  46. <script type='text/javascript'>
  47. document.ANALYSIS_DATA = null;
  48. document.CALLGRAPH = null;
  49. </script>
  50. <div id="short-nav">
  51. <dl>
  52. <dd><code>import "github.com/gregjones/httpcache/memcache"</code></dd>
  53. </dl>
  54. <dl>
  55. <dd><a href="index.html#pkg-overview" class="overviewLink">Overview</a></dd>
  56. <dd><a href="index.html#pkg-index" class="indexLink">Index</a></dd>
  57. </dl>
  58. </div>
  59. <!-- The package's Name is printed as title by the top-level template -->
  60. <div id="pkg-overview" class="toggleVisible">
  61. <div class="collapsed">
  62. <h2 class="toggleButton" title="Click to show Overview section">Overview ▹</h2>
  63. </div>
  64. <div class="expanded">
  65. <h2 class="toggleButton" title="Click to hide Overview section">Overview ▾</h2>
  66. <p>
  67. Package memcache provides an implementation of httpcache.Cache that uses
  68. gomemcache to store cached responses.
  69. </p>
  70. <p>
  71. When built for Google App Engine, this package will provide an
  72. implementation that uses App Engine&#39;s memcache service. See the
  73. appengine.go file in this package for details.
  74. </p>
  75. </div>
  76. </div>
  77. <div id="pkg-index" class="toggleVisible">
  78. <div class="collapsed">
  79. <h2 class="toggleButton" title="Click to show Index section">Index ▹</h2>
  80. </div>
  81. <div class="expanded">
  82. <h2 class="toggleButton" title="Click to hide Index section">Index ▾</h2>
  83. <!-- Table of contents for API; must be named manual-nav to turn off auto nav. -->
  84. <div id="manual-nav">
  85. <dl>
  86. <dd><a href="index.html#Cache">type Cache</a></dd>
  87. <dd>&nbsp; &nbsp; <a href="index.html#New">func New(server ...string) *Cache</a></dd>
  88. <dd>&nbsp; &nbsp; <a href="index.html#NewWithClient">func NewWithClient(client *memcache.Client) *Cache</a></dd>
  89. <dd>&nbsp; &nbsp; <a href="index.html#Cache.Delete">func (c *Cache) Delete(key string)</a></dd>
  90. <dd>&nbsp; &nbsp; <a href="index.html#Cache.Get">func (c *Cache) Get(key string) (resp []byte, ok bool)</a></dd>
  91. <dd>&nbsp; &nbsp; <a href="index.html#Cache.Set">func (c *Cache) Set(key string, resp []byte)</a></dd>
  92. </dl>
  93. </div><!-- #manual-nav -->
  94. <h4>Package files</h4>
  95. <p>
  96. <span style="font-size:90%">
  97. <a href="http://localhost:6060/src/github.com/gregjones/httpcache/memcache/memcache.go">memcache.go</a>
  98. </span>
  99. </p>
  100. </div><!-- .expanded -->
  101. </div><!-- #pkg-index -->
  102. <div id="pkg-callgraph" class="toggle" style="display: none">
  103. <div class="collapsed">
  104. <h2 class="toggleButton" title="Click to show Internal Call Graph section">Internal call graph ▹</h2>
  105. </div> <!-- .expanded -->
  106. <div class="expanded">
  107. <h2 class="toggleButton" title="Click to hide Internal Call Graph section">Internal call graph ▾</h2>
  108. <p>
  109. In the call graph viewer below, each node
  110. is a function belonging to this package
  111. and its children are the functions it
  112. calls&mdash;perhaps dynamically.
  113. </p>
  114. <p>
  115. The root nodes are the entry points of the
  116. package: functions that may be called from
  117. outside the package.
  118. There may be non-exported or anonymous
  119. functions among them if they are called
  120. dynamically from another package.
  121. </p>
  122. <p>
  123. Click a node to visit that function's source code.
  124. From there you can visit its callers by
  125. clicking its declaring <code>func</code>
  126. token.
  127. </p>
  128. <p>
  129. Functions may be omitted if they were
  130. determined to be unreachable in the
  131. particular programs or tests that were
  132. analyzed.
  133. </p>
  134. <!-- Zero means show all package entry points. -->
  135. <ul style="margin-left: 0.5in" id="callgraph-0" class="treeview"></ul>
  136. </div>
  137. </div> <!-- #pkg-callgraph -->
  138. <h2 id="Cache">type <a href="http://localhost:6060/src/github.com/gregjones/httpcache/memcache/memcache.go?s=495:534#L7">Cache</a></h2>
  139. <pre>type Cache struct {
  140. *<a href="../../../bradfitz/gomemcache/memcache/index.html">memcache</a>.<a href="../../../bradfitz/gomemcache/memcache/index.html#Client">Client</a>
  141. }</pre>
  142. <p>
  143. Cache is an implementation of httpcache.Cache that caches responses in a
  144. memcache server.
  145. </p>
  146. <h3 id="New">func <a href="http://localhost:6060/src/github.com/gregjones/httpcache/memcache/memcache.go?s=1457:1490#L43">New</a></h3>
  147. <pre>func New(server ...<a href="../../../../builtin/index.html#string">string</a>) *<a href="index.html#Cache">Cache</a></pre>
  148. <p>
  149. New returns a new Cache using the provided memcache server(s) with equal
  150. weight. If a server is listed multiple times, it gets a proportional amount
  151. of weight.
  152. </p>
  153. <h3 id="NewWithClient">func <a href="http://localhost:6060/src/github.com/gregjones/httpcache/memcache/memcache.go?s=1612:1662#L48">NewWithClient</a></h3>
  154. <pre>func NewWithClient(client *<a href="../../../bradfitz/gomemcache/memcache/index.html">memcache</a>.<a href="../../../bradfitz/gomemcache/memcache/index.html#Client">Client</a>) *<a href="index.html#Cache">Cache</a></pre>
  155. <p>
  156. NewWithClient returns a new Cache with the given memcache client.
  157. </p>
  158. <h3 id="Cache.Delete">func (*Cache) <a href="http://localhost:6060/src/github.com/gregjones/httpcache/memcache/memcache.go?s=1216:1250#L36">Delete</a></h3>
  159. <pre>func (c *<a href="index.html#Cache">Cache</a>) Delete(key <a href="../../../../builtin/index.html#string">string</a>)</pre>
  160. <p>
  161. Delete removes the response with key from the cache.
  162. </p>
  163. <h3 id="Cache.Get">func (*Cache) <a href="http://localhost:6060/src/github.com/gregjones/httpcache/memcache/memcache.go?s=811:865#L18">Get</a></h3>
  164. <pre>func (c *<a href="index.html#Cache">Cache</a>) Get(key <a href="../../../../builtin/index.html#string">string</a>) (resp []<a href="../../../../builtin/index.html#byte">byte</a>, ok <a href="../../../../builtin/index.html#bool">bool</a>)</pre>
  165. <p>
  166. Get returns the response corresponding to key if present.
  167. </p>
  168. <h3 id="Cache.Set">func (*Cache) <a href="http://localhost:6060/src/github.com/gregjones/httpcache/memcache/memcache.go?s=1023:1067#L27">Set</a></h3>
  169. <pre>func (c *<a href="index.html#Cache">Cache</a>) Set(key <a href="../../../../builtin/index.html#string">string</a>, resp []<a href="../../../../builtin/index.html#byte">byte</a>)</pre>
  170. <p>
  171. Set saves a response to the cache as key.
  172. </p>
  173. <div id="footer">
  174. Build version go1.6.<br>
  175. Except as <a href="https://developers.google.com/site-policies#restrictions">noted</a>,
  176. the content of this page is licensed under the
  177. Creative Commons Attribution 3.0 License,
  178. and code is licensed under a <a href="http://localhost:6060/LICENSE">BSD license</a>.<br>
  179. <a href="http://localhost:6060/doc/tos.html">Terms of Service</a> |
  180. <a href="http://www.google.com/intl/en/policies/privacy/">Privacy Policy</a>
  181. </div>
  182. </div><!-- .container -->
  183. </div><!-- #page -->
  184. <!-- TODO(adonovan): load these from <head> using "defer" attribute? -->
  185. <script type="text/javascript" src="../../../../../lib/godoc/jquery.js"></script>
  186. <script type="text/javascript" src="../../../../../lib/godoc/jquery.treeview.js"></script>
  187. <script type="text/javascript" src="../../../../../lib/godoc/jquery.treeview.edit.js"></script>
  188. <script type="text/javascript" src="../../../../../lib/godoc/godocs.js"></script>
  189. </body>
  190. </html>