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.

372 lines
11 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>cookiejar - 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 cookiejar</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 "net/http/cookiejar"</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 cookiejar implements an in-memory RFC 6265-compliant http.CookieJar.
  68. </p>
  69. </div>
  70. </div>
  71. <div id="pkg-index" class="toggleVisible">
  72. <div class="collapsed">
  73. <h2 class="toggleButton" title="Click to show Index section">Index ▹</h2>
  74. </div>
  75. <div class="expanded">
  76. <h2 class="toggleButton" title="Click to hide Index section">Index ▾</h2>
  77. <!-- Table of contents for API; must be named manual-nav to turn off auto nav. -->
  78. <div id="manual-nav">
  79. <dl>
  80. <dd><a href="index.html#Jar">type Jar</a></dd>
  81. <dd>&nbsp; &nbsp; <a href="index.html#New">func New(o *Options) (*Jar, error)</a></dd>
  82. <dd>&nbsp; &nbsp; <a href="index.html#Jar.Cookies">func (j *Jar) Cookies(u *url.URL) (cookies []*http.Cookie)</a></dd>
  83. <dd>&nbsp; &nbsp; <a href="index.html#Jar.SetCookies">func (j *Jar) SetCookies(u *url.URL, cookies []*http.Cookie)</a></dd>
  84. <dd><a href="index.html#Options">type Options</a></dd>
  85. <dd><a href="index.html#PublicSuffixList">type PublicSuffixList</a></dd>
  86. </dl>
  87. </div><!-- #manual-nav -->
  88. <h4>Package files</h4>
  89. <p>
  90. <span style="font-size:90%">
  91. <a href="http://localhost:6060/src/net/http/cookiejar/jar.go">jar.go</a>
  92. <a href="http://localhost:6060/src/net/http/cookiejar/punycode.go">punycode.go</a>
  93. </span>
  94. </p>
  95. </div><!-- .expanded -->
  96. </div><!-- #pkg-index -->
  97. <div id="pkg-callgraph" class="toggle" style="display: none">
  98. <div class="collapsed">
  99. <h2 class="toggleButton" title="Click to show Internal Call Graph section">Internal call graph ▹</h2>
  100. </div> <!-- .expanded -->
  101. <div class="expanded">
  102. <h2 class="toggleButton" title="Click to hide Internal Call Graph section">Internal call graph ▾</h2>
  103. <p>
  104. In the call graph viewer below, each node
  105. is a function belonging to this package
  106. and its children are the functions it
  107. calls&mdash;perhaps dynamically.
  108. </p>
  109. <p>
  110. The root nodes are the entry points of the
  111. package: functions that may be called from
  112. outside the package.
  113. There may be non-exported or anonymous
  114. functions among them if they are called
  115. dynamically from another package.
  116. </p>
  117. <p>
  118. Click a node to visit that function's source code.
  119. From there you can visit its callers by
  120. clicking its declaring <code>func</code>
  121. token.
  122. </p>
  123. <p>
  124. Functions may be omitted if they were
  125. determined to be unreachable in the
  126. particular programs or tests that were
  127. analyzed.
  128. </p>
  129. <!-- Zero means show all package entry points. -->
  130. <ul style="margin-left: 0.5in" id="callgraph-0" class="treeview"></ul>
  131. </div>
  132. </div> <!-- #pkg-callgraph -->
  133. <h2 id="Jar">type <a href="http://localhost:6060/src/net/http/cookiejar/jar.go?s=1957:2301#L50">Jar</a></h2>
  134. <pre>type Jar struct {
  135. <span class="comment">// contains filtered or unexported fields</span>
  136. }</pre>
  137. <p>
  138. Jar implements the http.CookieJar interface from the net/http package.
  139. </p>
  140. <h3 id="New">func <a href="http://localhost:6060/src/net/http/cookiejar/jar.go?s=2387:2421#L67">New</a></h3>
  141. <pre>func New(o *<a href="index.html#Options">Options</a>) (*<a href="index.html#Jar">Jar</a>, <a href="../../../builtin/index.html#error">error</a>)</pre>
  142. <p>
  143. New returns a new cookie jar. A nil *Options is equivalent to a zero
  144. Options.
  145. </p>
  146. <h3 id="Jar.Cookies">func (*Jar) <a href="http://localhost:6060/src/net/http/cookiejar/jar.go?s=5174:5232#L161">Cookies</a></h3>
  147. <pre>func (j *<a href="index.html#Jar">Jar</a>) Cookies(u *<a href="../../url/index.html">url</a>.<a href="../../url/index.html#URL">URL</a>) (cookies []*<a href="../index.html">http</a>.<a href="../index.html#Cookie">Cookie</a>)</pre>
  148. <p>
  149. Cookies implements the Cookies method of the http.CookieJar interface.
  150. </p>
  151. <p>
  152. It returns an empty slice if the URL&#39;s scheme is not HTTP or HTTPS.
  153. </p>
  154. <h3 id="Jar.SetCookies">func (*Jar) <a href="http://localhost:6060/src/net/http/cookiejar/jar.go?s=6507:6567#L225">SetCookies</a></h3>
  155. <pre>func (j *<a href="index.html#Jar">Jar</a>) SetCookies(u *<a href="../../url/index.html">url</a>.<a href="../../url/index.html#URL">URL</a>, cookies []*<a href="../index.html">http</a>.<a href="../index.html#Cookie">Cookie</a>)</pre>
  156. <p>
  157. SetCookies implements the SetCookies method of the http.CookieJar interface.
  158. </p>
  159. <p>
  160. It does nothing if the URL&#39;s scheme is not HTTP or HTTPS.
  161. </p>
  162. <h2 id="Options">type <a href="http://localhost:6060/src/net/http/cookiejar/jar.go?s=1537:1881#L39">Options</a></h2>
  163. <pre>type Options struct {
  164. <span class="comment">// PublicSuffixList is the public suffix list that determines whether</span>
  165. <span class="comment">// an HTTP server can set a cookie for a domain.</span>
  166. <span class="comment">//</span>
  167. <span class="comment">// A nil value is valid and may be useful for testing but it is not</span>
  168. <span class="comment">// secure: it means that the HTTP server for foo.co.uk can set a cookie</span>
  169. <span class="comment">// for bar.co.uk.</span>
  170. PublicSuffixList <a href="index.html#PublicSuffixList">PublicSuffixList</a>
  171. }</pre>
  172. <p>
  173. Options are the options for creating a new Jar.
  174. </p>
  175. <h2 id="PublicSuffixList">type <a href="http://localhost:6060/src/net/http/cookiejar/jar.go?s=1003:1484#L24">PublicSuffixList</a></h2>
  176. <pre>type PublicSuffixList interface {
  177. <span class="comment">// PublicSuffix returns the public suffix of domain.</span>
  178. <span class="comment">//</span>
  179. <span class="comment">// TODO: specify which of the caller and callee is responsible for IP</span>
  180. <span class="comment">// addresses, for leading and trailing dots, for case sensitivity, and</span>
  181. <span class="comment">// for IDN/Punycode.</span>
  182. PublicSuffix(domain <a href="../../../builtin/index.html#string">string</a>) <a href="../../../builtin/index.html#string">string</a>
  183. <span class="comment">// String returns a description of the source of this public suffix</span>
  184. <span class="comment">// list. The description will typically contain something like a time</span>
  185. <span class="comment">// stamp or version number.</span>
  186. String() <a href="../../../builtin/index.html#string">string</a>
  187. }</pre>
  188. <p>
  189. PublicSuffixList provides the public suffix of a domain. For example:
  190. </p>
  191. <pre>- the public suffix of &#34;example.com&#34; is &#34;com&#34;,
  192. - the public suffix of &#34;foo1.foo2.foo3.co.uk&#34; is &#34;co.uk&#34;, and
  193. - the public suffix of &#34;bar.pvt.k12.ma.us&#34; is &#34;pvt.k12.ma.us&#34;.
  194. </pre>
  195. <p>
  196. Implementations of PublicSuffixList must be safe for concurrent use by
  197. multiple goroutines.
  198. </p>
  199. <p>
  200. An implementation that always returns &#34;&#34; is valid and may be useful for
  201. testing but it is not secure: it means that the HTTP server for foo.com can
  202. set a cookie for bar.com.
  203. </p>
  204. <p>
  205. A public suffix list implementation is in the package
  206. golang.org/x/net/publicsuffix.
  207. </p>
  208. <div id="footer">
  209. Build version go1.6.<br>
  210. Except as <a href="https://developers.google.com/site-policies#restrictions">noted</a>,
  211. the content of this page is licensed under the
  212. Creative Commons Attribution 3.0 License,
  213. and code is licensed under a <a href="http://localhost:6060/LICENSE">BSD license</a>.<br>
  214. <a href="http://localhost:6060/doc/tos.html">Terms of Service</a> |
  215. <a href="http://www.google.com/intl/en/policies/privacy/">Privacy Policy</a>
  216. </div>
  217. </div><!-- .container -->
  218. </div><!-- #page -->
  219. <!-- TODO(adonovan): load these from <head> using "defer" attribute? -->
  220. <script type="text/javascript" src="../../../../lib/godoc/jquery.js"></script>
  221. <script type="text/javascript" src="../../../../lib/godoc/jquery.treeview.js"></script>
  222. <script type="text/javascript" src="../../../../lib/godoc/jquery.treeview.edit.js"></script>
  223. <script type="text/javascript" src="../../../../lib/godoc/godocs.js"></script>
  224. </body>
  225. </html>