Added: apr/site/trunk/docs/docs/apr/trunk/structapr__bucket__pool.html URL: http://svn.apache.org/viewvc/apr/site/trunk/docs/docs/apr/trunk/structapr__bucket__pool.html?rev=784636&view=auto ============================================================================== --- apr/site/trunk/docs/docs/apr/trunk/structapr__bucket__pool.html (added) +++ apr/site/trunk/docs/docs/apr/trunk/structapr__bucket__pool.html Mon Jun 15 00:01:38 2009 @@ -0,0 +1,114 @@ + + +Apache Portable Runtime: apr_bucket_pool Struct Reference + + + + + +
+

apr_bucket_pool Struct Reference
+ +[Bucket Brigades] +

#include <apr_buckets.h> +

+ + + + + + + + + + + +

Data Fields

apr_bucket_heap heap
const char * base
apr_pool_tpool
apr_bucket_alloc_tlist
+


Detailed Description

+A bucket referring to data allocated from a pool

Field Documentation

+ +
+
+ + + + +
const char* apr_bucket_pool::base
+
+
+ +

+The block of data actually allocated from the pool. Segments of this block are referenced by adjusting the start and length of the apr_bucket accordingly. This will be NULL after the pool gets cleaned up. +

+

+ +

+ +
+ +

+The pool bucket must be able to be easily morphed to a heap bucket if the pool gets cleaned up before all references are destroyed. This apr_bucket_heap structure is populated automatically when the pool gets cleaned up, and subsequent calls to pool_read() will result in the apr_bucket in question being morphed into a regular heap bucket. (To avoid having to do many extra refcount manipulations and b->data manipulations, the apr_bucket_pool struct actually *contains* the apr_bucket_heap struct that it will become as its first element; the two share their apr_bucket_refcount members.) +

+

+ +

+ +
+ +

+The freelist this structure was allocated from, which is needed in the cleanup phase in order to allocate space on the heap +

+

+ +

+ +
+ +

+The pool the data was allocated from. When the pool is cleaned up, this gets set to NULL as an indicator to pool_read() that the data is now on the heap and so it should morph the bucket into a regular heap bucket before continuing. +

+

+


The documentation for this struct was generated from the following file: +
+
Generated on Mon Jun 15 09:45:31 2009 for Apache Portable Runtime by  + +doxygen 1.5.8
+ + Added: apr/site/trunk/docs/docs/apr/trunk/structapr__bucket__refcount.html URL: http://svn.apache.org/viewvc/apr/site/trunk/docs/docs/apr/trunk/structapr__bucket__refcount.html?rev=784636&view=auto ============================================================================== --- apr/site/trunk/docs/docs/apr/trunk/structapr__bucket__refcount.html (added) +++ apr/site/trunk/docs/docs/apr/trunk/structapr__bucket__refcount.html Mon Jun 15 00:01:38 2009 @@ -0,0 +1,63 @@ + + +Apache Portable Runtime: apr_bucket_refcount Struct Reference + + + + + +
+

apr_bucket_refcount Struct Reference
+ +[Bucket Brigades] +

#include <apr_buckets.h> +

+ + + + + +

Data Fields

int refcount
+


Detailed Description

+The structure used to manage the shared resource must start with an apr_bucket_refcount which is updated by the general-purpose refcount code. A pointer to the bucket-type-dependent private data structure can be cast to a pointer to an apr_bucket_refcount and vice versa.

Field Documentation

+ +
+ +
+ +

+The number of references to this bucket +

+

+


The documentation for this struct was generated from the following file: +
+
Generated on Mon Jun 15 09:45:31 2009 for Apache Portable Runtime by  + +doxygen 1.5.8
+ + Added: apr/site/trunk/docs/docs/apr/trunk/structapr__bucket__type__t.html URL: http://svn.apache.org/viewvc/apr/site/trunk/docs/docs/apr/trunk/structapr__bucket__type__t.html?rev=784636&view=auto ============================================================================== --- apr/site/trunk/docs/docs/apr/trunk/structapr__bucket__type__t.html (added) +++ apr/site/trunk/docs/docs/apr/trunk/structapr__bucket__type__t.html Mon Jun 15 00:01:38 2009 @@ -0,0 +1,242 @@ + + +Apache Portable Runtime: apr_bucket_type_t Struct Reference + + + + + +
+

apr_bucket_type_t Struct Reference
+ +[Bucket Brigades] +

#include <apr_buckets.h> +

+ + + + + + + + + + + + + + + + + + + + + + +

Public Types

enum  { APR_BUCKET_DATA = 0, +APR_BUCKET_METADATA = 1 + }

Data Fields

const char * name
int num_func
enum apr_bucket_type_t:: { ... }  is_metadata
void(* destroy )(void *data)
apr_status_t(* read )(apr_bucket *b, const char **str, apr_size_t *len, apr_read_type_e block)
apr_status_t(* setaside )(apr_bucket *e, apr_pool_t *pool)
apr_status_t(* split )(apr_bucket *e, apr_size_t point)
apr_status_t(* copy )(apr_bucket *e, apr_bucket **c)
+


Detailed Description

+Basic bucket type

Member Enumeration Documentation

+ +
+
+ + + + +
anonymous enum
+
+
+ +

+Whether the bucket contains metadata (ie, information that describes the regular contents of the brigade). The metadata is not returned by apr_bucket_read() and is not indicated by the ->length of the apr_bucket itself. In other words, an empty bucket is safe to arbitrarily remove if and only if it contains no metadata. In this sense, "data" is just raw bytes that are the "content" of the brigade and "metadata" describes that data but is not a proper part of it.

Enumerator:
+ + + +
APR_BUCKET_DATA  +This bucket type represents actual data to send to the client.
APR_BUCKET_METADATA  +This bucket type represents metadata.
+
+ +
+

+


Field Documentation

+ +
+ +
+ +

+Copy the bucket structure (not the data), assuming that this is possible for the bucket type. If it's not, APR_ENOTIMPL is returned.

Parameters:
+ + + +
e The bucket to copy
c Returns a pointer to the new bucket
+
+ +
+

+ +

+
+ + + + +
void(* apr_bucket_type_t::destroy)(void *data)
+
+
+ +

+Free the private data and any resources used by the bucket (if they aren't shared with another bucket). This function is required to be implemented for all bucket types, though it might be a no-op on some of them (namely ones that never allocate any private data structures).

Parameters:
+ + +
data The private data pointer from the bucket to be destroyed
+
+ +
+

+ +

+
+ + + + +
enum { ... } apr_bucket_type_t::is_metadata
+
+
+ +

+Whether the bucket contains metadata (ie, information that describes the regular contents of the brigade). The metadata is not returned by apr_bucket_read() and is not indicated by the ->length of the apr_bucket itself. In other words, an empty bucket is safe to arbitrarily remove if and only if it contains no metadata. In this sense, "data" is just raw bytes that are the "content" of the brigade and "metadata" describes that data but is not a proper part of it. +

+

+ +

+
+ + + + +
const char* apr_bucket_type_t::name
+
+
+ +

+The name of the bucket type +

+

+ +

+ +
+ +

+The number of functions this bucket understands. Can not be less than five. +

+

+ +

+
+ + + + +
apr_status_t(* apr_bucket_type_t::read)(apr_bucket *b, const char **str, apr_size_t *len, apr_read_type_e block)
+
+
+ +

+Read the data from the bucket. This is required to be implemented for all bucket types.

Parameters:
+ + + + + +
b The bucket to read from
str A place to store the data read. Allocation should only be done if absolutely necessary.
len The amount of data read.
block Should this read function block if there is more data that cannot be read immediately.
+
+ +
+

+ +

+ +
+ +

+Make it possible to set aside the data for at least as long as the given pool. Buckets containing data that could potentially die before this pool (e.g. the data resides on the stack, in a child pool of the given pool, or in a disjoint pool) must somehow copy, shift, or transform the data to have the proper lifetime.

Parameters:
+ + +
e The bucket to convert
+
+
Remarks:
Some bucket types contain data that will always outlive the bucket itself. For example no data (EOS and FLUSH), or the data resides in global, constant memory (IMMORTAL), or the data is on the heap (HEAP). For these buckets, apr_bucket_setaside_noop can be used.
+ +
+

+ +

+
+ + + + +
apr_status_t(* apr_bucket_type_t::split)(apr_bucket *e, apr_size_t point)
+
+
+ +

+Split one bucket in two at the specified position by duplicating the bucket structure (not the data) and modifying any necessary start/end/offset information. If it's not possible to do this for the bucket type (perhaps the length of the data is indeterminate, as with pipe and socket buckets), then APR_ENOTIMPL is returned.

Parameters:
+ + + +
e The bucket to split
point The offset of the first byte in the new bucket
+
+ +
+

+


The documentation for this struct was generated from the following file: +
+
Generated on Mon Jun 15 09:45:31 2009 for Apache Portable Runtime by  + +doxygen 1.5.8
+ + Added: apr/site/trunk/docs/docs/apr/trunk/structapr__datum__t.html URL: http://svn.apache.org/viewvc/apr/site/trunk/docs/docs/apr/trunk/structapr__datum__t.html?rev=784636&view=auto ============================================================================== --- apr/site/trunk/docs/docs/apr/trunk/structapr__datum__t.html (added) +++ apr/site/trunk/docs/docs/apr/trunk/structapr__datum__t.html Mon Jun 15 00:01:38 2009 @@ -0,0 +1,80 @@ + + +Apache Portable Runtime: apr_datum_t Struct Reference + + + + + +
+

apr_datum_t Struct Reference
+ +[DBM routines] +

#include <apr_dbm.h> +

+ + + + + + + +

Data Fields

char * dptr
apr_size_t dsize
+


Detailed Description

+Structure for referencing the datum record within a dbm

Field Documentation

+ +
+
+ + + + +
char* apr_datum_t::dptr
+
+
+ +

+pointer to the 'data' to retrieve/store in the DBM +

+

+ +

+
+ + + + +
apr_size_t apr_datum_t::dsize
+
+
+ +

+size of the 'data' to retrieve/store in the DBM +

+

+


The documentation for this struct was generated from the following file: +
+
Generated on Mon Jun 15 09:45:31 2009 for Apache Portable Runtime by  + +doxygen 1.5.8
+ + Added: apr/site/trunk/docs/docs/apr/trunk/structapr__dbm__t.html URL: http://svn.apache.org/viewvc/apr/site/trunk/docs/docs/apr/trunk/structapr__dbm__t.html?rev=784636&view=auto ============================================================================== --- apr/site/trunk/docs/docs/apr/trunk/structapr__dbm__t.html (added) +++ apr/site/trunk/docs/docs/apr/trunk/structapr__dbm__t.html Mon Jun 15 00:01:38 2009 @@ -0,0 +1,128 @@ + + +Apache Portable Runtime: apr_dbm_t Struct Reference + + + + + +
+

apr_dbm_t Struct Reference

#include <apr_dbm_private.h> +

+ + + + + + + + + + + + + +

Data Fields

apr_pool_tpool
void * file
int errcode
const char * errmsg
const apr_dbm_type_ttype
+


Detailed Description

+The actual DBM

Field Documentation

+ +
+
+ + + + +
int apr_dbm_t::errcode
+
+
+ +

+Current integer error code +

+

+ +

+
+ + + + +
const char* apr_dbm_t::errmsg
+
+
+ +

+Current string error code +

+

+ +

+
+ + + + +
void* apr_dbm_t::file
+
+
+ +

+pointer to DB Implementation Specific data +

+

+ +

+ +
+ +

+Associated pool +

+

+ +

+
+ + + + +
const apr_dbm_type_t* apr_dbm_t::type
+
+
+ +

+the type of DBM +

+

+


The documentation for this struct was generated from the following file: +
+
Generated on Mon Jun 15 09:45:31 2009 for Apache Portable Runtime by  + +doxygen 1.5.8
+ + Added: apr/site/trunk/docs/docs/apr/trunk/structapr__dbm__type__t.html URL: http://svn.apache.org/viewvc/apr/site/trunk/docs/docs/apr/trunk/structapr__dbm__type__t.html?rev=784636&view=auto ============================================================================== --- apr/site/trunk/docs/docs/apr/trunk/structapr__dbm__type__t.html (added) +++ apr/site/trunk/docs/docs/apr/trunk/structapr__dbm__type__t.html Mon Jun 15 00:01:38 2009 @@ -0,0 +1,230 @@ + + +Apache Portable Runtime: apr_dbm_type_t Struct Reference + + + + + +
+

apr_dbm_type_t Struct Reference

#include <apr_dbm_private.h> +

+ + + + + + + + + + + + + + + + + + + + + + + + + +

Data Fields

const char * name
apr_status_t(* open )(apr_dbm_t **pdb, const char *pathname, apr_int32_t mode, apr_fileperms_t perm, apr_pool_t *pool)
void(* close )(apr_dbm_t *dbm)
apr_status_t(* fetch )(apr_dbm_t *dbm, apr_datum_t key, apr_datum_t *pvalue)
apr_status_t(* store )(apr_dbm_t *dbm, apr_datum_t key, apr_datum_t value)
apr_status_t(* del )(apr_dbm_t *dbm, apr_datum_t key)
int(* exists )(apr_dbm_t *dbm, apr_datum_t key)
apr_status_t(* firstkey )(apr_dbm_t *dbm, apr_datum_t *pkey)
apr_status_t(* nextkey )(apr_dbm_t *dbm, apr_datum_t *pkey)
void(* freedatum )(apr_dbm_t *dbm, apr_datum_t data)
void(* getusednames )(apr_pool_t *pool, const char *pathname, const char **used1, const char **used2)
+


Detailed Description

+Structure to describe the operations of the DBM

Field Documentation

+ +
+
+ + + + +
void(* apr_dbm_type_t::close)(apr_dbm_t *dbm)
+
+
+ +

+Close the DBM +

+

+ +

+ +
+ +

+Delete a dbm record value by key +

+

+ +

+
+ + + + +
int(* apr_dbm_type_t::exists)(apr_dbm_t *dbm, apr_datum_t key)
+
+
+ +

+Search for a key within the dbm +

+

+ +

+ +
+ +

+Fetch a dbm record value by key +

+

+ +

+ +
+ +

+Retrieve the first record key from a dbm +

+

+ +

+
+ + + + +
void(* apr_dbm_type_t::freedatum)(apr_dbm_t *dbm, apr_datum_t data)
+
+
+ +

+Proactively toss any memory associated with the apr_datum_t. +

+

+ +

+
+ + + + +
void(* apr_dbm_type_t::getusednames)(apr_pool_t *pool, const char *pathname, const char **used1, const char **used2)
+
+
+ +

+Get the names that the DBM will use for a given pathname. +

+

+ +

+
+ + + + +
const char* apr_dbm_type_t::name
+
+
+ +

+The name of the DBM Type +

+

+ +

+ +
+ +

+Retrieve the next record key from a dbm +

+

+ +

+
+ + + + +
apr_status_t(* apr_dbm_type_t::open)(apr_dbm_t **pdb, const char *pathname, apr_int32_t mode, apr_fileperms_t perm, apr_pool_t *pool)
+
+
+ +

+Open the DBM +

+

+ +

+ +
+ +

+Store a dbm record value by key +

+

+


The documentation for this struct was generated from the following file: +
+
Generated on Mon Jun 15 09:45:31 2009 for Apache Portable Runtime by  + +doxygen 1.5.8
+ + Modified: apr/site/trunk/docs/docs/apr/trunk/structapr__finfo__t.html URL: http://svn.apache.org/viewvc/apr/site/trunk/docs/docs/apr/trunk/structapr__finfo__t.html?rev=784636&r1=784635&r2=784636&view=diff ============================================================================== --- apr/site/trunk/docs/docs/apr/trunk/structapr__finfo__t.html (original) +++ apr/site/trunk/docs/docs/apr/trunk/structapr__finfo__t.html Mon Jun 15 00:01:38 2009 @@ -1,16 +1,17 @@ Apache Portable Runtime: apr_finfo_t Struct Reference - + - +