<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>apreq_cookie.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.3 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> <a class="qindex" href="pages.html">Related Pages</a> </center>
<hr><h1>apreq_cookie.h</h1><a href="apreq__cookie_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">/* ====================================================================</span>
00002 <span class="comment"> * The Apache Software License, Version 1.1</span>
00003 <span class="comment"> *</span>
00004 <span class="comment"> * Copyright (c) 2003 The Apache Software Foundation. All rights</span>
00005 <span class="comment"> * reserved.</span>
00006 <span class="comment"> *</span>
00007 <span class="comment"> * Redistribution and use in source and binary forms, with or without</span>
00008 <span class="comment"> * modification, are permitted provided that the following conditions</span>
00009 <span class="comment"> * are met:</span>
00010 <span class="comment"> *</span>
00011 <span class="comment"> * 1. Redistributions of source code must retain the above copyright</span>
00012 <span class="comment"> * notice, this list of conditions and the following disclaimer.</span>
00013 <span class="comment"> *</span>
00014 <span class="comment"> * 2. Redistributions in binary form must reproduce the above copyright</span>
00015 <span class="comment"> * notice, this list of conditions and the following disclaimer in</span>
00016 <span class="comment"> * the documentation and/or other materials provided with the</span>
00017 <span class="comment"> * distribution.</span>
00018 <span class="comment"> *</span>
00019 <span class="comment"> * 3. The end-user documentation included with the redistribution,</span>
00020 <span class="comment"> * if any, must include the following acknowledgment:</span>
00021 <span class="comment"> * "This product includes software developed by the</span>
00023 <span class="comment"> * Alternately, this acknowledgment may appear in the software itself,</span>
00024 <span class="comment"> * if and wherever such third-party acknowledgments normally appear.</span>
00025 <span class="comment"> *</span>
00026 <span class="comment"> * 4. The names "Apache" and "Apache Software Foundation" must</span>
00027 <span class="comment"> * not be used to endorse or promote products derived from this</span>
00028 <span class="comment"> * software without prior written permission. For written</span>
00029 <span class="comment"> * permission, please contact apache@apache.org.</span>
00030 <span class="comment"> *</span>
00031 <span class="comment"> * 5. Products derived from this software may not be called "Apache",</span>
00032 <span class="comment"> * nor may "Apache" appear in their name, without prior written</span>
00033 <span class="comment"> * permission of the Apache Software Foundation.</span>
00034 <span class="comment"> *</span>
00035 <span class="comment"> * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED</span>
00036 <span class="comment"> * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES</span>
00037 <span class="comment"> * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE</span>
00038 <span class="comment"> * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR</span>
00039 <span class="comment"> * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,</span>
00040 <span class="comment"> * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT</span>
00041 <span class="comment"> * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF</span>
00042 <span class="comment"> * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND</span>
00043 <span class="comment"> * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,</span>
00044 <span class="comment"> * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT</span>
00045 <span class="comment"> * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF</span>
00046 <span class="comment"> * SUCH DAMAGE.</span>
00047 <span class="comment"> * ====================================================================</span>
00048 <span class="comment"> *</span>
00049 <span class="comment"> * This software consists of voluntary contributions made by many</span>
00050 <span class="comment"> * individuals on behalf of the Apache Software Foundation. For more</span>
00051 <span class="comment"> * information on the Apache Software Foundation, please see</span>
00053 <span class="comment"> */</span>
00054
00055 <span class="preprocessor">#ifndef APREQ_COOKIE_H</span>
00056 <span class="preprocessor"></span><span class="preprocessor">#define APREQ_COOKIE_H</span>
00057 <span class="preprocessor"></span>
00058 <span class="preprocessor">#include "<a class="code" href="apreq_8h.html">apreq.h</a>"</span>
00060
00061 <span class="preprocessor">#ifdef __cplusplus</span>
00062 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
00063 <span class="preprocessor">#endif </span>
00064 <span class="preprocessor"></span>
<a name="l00078"></a><a class="code" href="structapreq__jar__t.html">00078</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structapreq__jar__t.html">apreq_jar_t</a> {
<a name="l00080"></a><a class="code" href="structapreq__jar__t.html#m1">00080</a> <span class="keywordtype">void</span> *<a class="code" href="structapreq__jar__t.html#m1">env</a>;
00081 } <a class="code" href="structapreq__jar__t.html">apreq_jar_t</a>;
00082
00083 <span class="keyword">typedef</span> <span class="keyword">enum</span> { NETSCAPE, RFC } apreq_cookie_version_t;
00084
00085 <span class="preprocessor">#define APREQ_COOKIE_VERSION NETSCAPE</span>
00086 <span class="preprocessor"></span><span class="preprocessor">#define APREQ_COOKIE_LENGTH 4096</span>
00087 <span class="preprocessor"></span>
<a name="l00089"></a><a class="code" href="structapreq__cookie__t.html">00089</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structapreq__cookie__t.html">apreq_cookie_t</a> {
00090
<a name="l00091"></a><a class="code" href="structapreq__cookie__t.html#m0">00091</a> apreq_cookie_version_t <a class="code" href="structapreq__cookie__t.html#m0">version</a>;
00093 <span class="keywordtype">char</span> *path;
00094 <span class="keywordtype">char</span> *domain;
00095 <span class="keywordtype">char</span> *port;
00096 <span class="keywordtype">unsigned</span> secure;
00097
00098 <span class="keywordtype">char</span> *comment;
00099 <span class="keywordtype">char</span> *commentURL;
<a name="l00101"></a><a class="code" href="structapreq__cookie__t.html#m8">00101</a> <a class="code" href="structapreq__value__t.html">apreq_value_t</a> <a class="code" href="structapreq__cookie__t.html#m8">v</a>;
00103 } <a class="code" href="structapreq__cookie__t.html">apreq_cookie_t</a>;
00104
00105
00106 <span class="preprocessor">#define apreq_value_to_cookie(ptr) apreq_attr_to_type(apreq_cookie_t, \</span>
00107 <span class="preprocessor"> v, ptr)</span>
00108 <span class="preprocessor"></span><span class="preprocessor">#define apreq_cookie_name(c) ((c)->v.name)</span>
00109 <span class="preprocessor"></span><span class="preprocessor">#define apreq_cookie_value(c) ((c)->v.data)</span>
00110 <span class="preprocessor"></span>
00111 <span class="preprocessor">#define apreq_jar_items(j) apr_table_elts(j->cookies)->nelts</span>
00112 <span class="preprocessor"></span><span class="preprocessor">#define apreq_jar_nelts(j) apr_table_elts(j->cookies)->nelts</span>
00113 <span class="preprocessor"></span>
00121 APREQ_DECLARE(<a class="code" href="structapreq__cookie__t.html">apreq_cookie_t</a> *)<a class="code" href="group__cookies.html#a2">apreq_cookie</a>(<span class="keyword">const</span> <a class="code" href="structapreq__jar__t.html">apreq_jar_t</a> *jar,
00122 <span class="keyword">const</span> <span class="keywordtype">char</span> *name);
00123
00131 APREQ_DECLARE(<span class="keywordtype">void</span>) <a class="code" href="group__cookies.html#a3">apreq_add_cookie</a>(<a class="code" href="structapreq__jar__t.html">apreq_jar_t</a> *jar,
00132 <span class="keyword">const</span> <a class="code" href="structapreq__cookie__t.html">apreq_cookie_t</a> *c);
00133
00150 APREQ_DECLARE(<a class="code" href="structapreq__jar__t.html">apreq_jar_t</a> *) <a class="code" href="group__cookies.html#a4">apreq_jar</a>(<span class="keywordtype">void</span> *env, <span class="keyword">const</span> <span class="keywordtype">char</span> *hdr);
00151
00162 APREQ_DECLARE(<a class="code" href="structapreq__cookie__t.html">apreq_cookie_t</a> *) <a class="code" href="group__cookies.html#a5">apreq_make_cookie</a>(apr_pool_t *pool,
00163 <span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keyword">const</span> apr_size_t nlen,
00164 <span class="keyword">const</span> <span class="keywordtype">char</span> *value, <span class="keyword">const</span> apr_size_t vlen);
00165
00177 APREQ_DECLARE(apr_status_t)
00178 <a class="code" href="group__cookies.html#a6">apreq_cookie_attr</a>(apr_pool_t *p, <a class="code" href="structapreq__cookie__t.html">apreq_cookie_t</a> *c,
00179 <span class="keyword">const</span> <span class="keywordtype">char</span> *attr, apr_size_t alen,
00180 <span class="keyword">const</span> <span class="keywordtype">char</span> *val, apr_size_t vlen);
00181
00182
00190 APREQ_DECLARE(<span class="keywordtype">char</span>*) <a class="code" href="group__cookies.html#a7">apreq_cookie_as_string</a>(apr_pool_t *p,
00191 <span class="keyword">const</span> <a class="code" href="structapreq__cookie__t.html">apreq_cookie_t</a> *c);
00192
00204 APREQ_DECLARE(<span class="keywordtype">int</span>) <a class="code" href="group__cookies.html#a8">apreq_serialize_cookie</a>(<span class="keywordtype">char</span> *buf, apr_size_t len,
00205 <span class="keyword">const</span> <a class="code" href="structapreq__cookie__t.html">apreq_cookie_t</a> *c);
00206
00217 APREQ_DECLARE(<span class="keywordtype">void</span>) <a class="code" href="group__cookies.html#a9">apreq_cookie_expires</a>(<a class="code" href="structapreq__cookie__t.html">apreq_cookie_t</a> *c,
00218 <span class="keyword">const</span> <span class="keywordtype">char</span> *time_str);
00219
00225 APREQ_DECLARE(apr_status_t) <a class="code" href="group__cookies.html#a10">apreq_cookie_bake</a>(<span class="keyword">const</span> <a class="code" href="structapreq__cookie__t.html">apreq_cookie_t</a> *c,
00226 <span class="keywordtype">void</span> *env);
00227
00228 <span class="comment">/* XXX: how about baking whole cookie jars, too ??? */</span>
00229
00235 APREQ_DECLARE(apr_status_t) <a class="code" href="group__cookies.html#a11">apreq_cookie_bake2</a>(<span class="keyword">const</span> <a class="code" href="structapreq__cookie__t.html">apreq_cookie_t</a> *c,
00236 <span class="keywordtype">void</span> *env);
00237
00238 APREQ_DECLARE(apreq_cookie_version_t) apreq_ua_cookie_version(<span class="keywordtype">void</span> *env);
00239
00242 <span class="preprocessor">#ifdef __cplusplus</span>
00243 <span class="preprocessor"></span> }
00244 <span class="preprocessor">#endif</span>
00245 <span class="preprocessor"></span>
00246 <span class="preprocessor">#endif </span><span class="comment">/*APREQ_COOKIE_H*/</span>
00247
00248
</pre></div><hr><address style="align: right;"><small>Generated on Sat Nov 15 23:04:48 2003 for libapreq2 by
<img src="doxygen.png" alt="doxygen" align="middle" border=0
width=110 height=53></a>1.3 </small></address>
</body>
</html>