/ 
mod_perl-1.99_14
River stage three • 156 direct dependents • 184 total dependents
/ APR::Bucket

NAME

APR::Bucket - Perl API for XXX

Synopsis

use APR::Bucket ();

META: to be completed

Description

META: to be completed

API

APR::Bucket provides the following functions and/or methods:

eos_create

META: Autogenerated - needs to be reviewed/completed

Each bucket type foo has two initialization functions: apr_bucket_foo_make which sets up some already-allocated memory as a bucket of type foo; and apr_bucket_foo_create which allocates memory for the bucket, calls apr_bucket_make_foo, and initializes the bucket's list pointers. The apr_bucket_foo_make functions are used inside the bucket code to change the type of buckets in place; other code should call apr_bucket_foo_create. All the initialization functions change nothing if they fail. *

Create an End of Stream bucket. This indicates that there is no more data coming from down the filter stack. All filters should flush at this point.

$ret = $list->eos_create();
obj: $list (APR::BucketAlloc)

The freelist from which this bucket should be allocated

ret: $ret (APR::Bucket)

The new bucket, or NULL if allocation failed

flush_create

META: Autogenerated - needs to be reviewed/completed

Create a flush bucket. This indicates that filters should flush their data. There is no guarantee that they will flush it, but this is the best we can do.

$ret = $list->flush_create();
obj: $list (APR::BucketAlloc)

The freelist from which this bucket should be allocated

ret: $ret (APR::Bucket)

The new bucket, or NULL if allocation failed

insert_after

META: Autogenerated - needs to be reviewed/completed

$a->insert_after($b);
obj: $a (APR::Bucket)
arg1: $b (APR::Bucket)
ret: no return value

insert_before

META: Autogenerated - needs to be reviewed/completed

$a->insert_before($b);
obj: $a (APR::Bucket)
arg1: $b (APR::Bucket)
ret: no return value

is_eos

META: Autogenerated - needs to be reviewed/completed

$ret = $bucket->is_eos();
obj: $bucket (APR::Bucket)
ret: $ret (integer)

is_flush

META: Autogenerated - needs to be reviewed/completed

$ret = $bucket->is_flush();
obj: $bucket (APR::Bucket)
ret: $ret (integer)

remove

META: Autogenerated - needs to be reviewed/completed

$bucket->remove();
obj: $bucket (APR::Bucket)
ret: no return value

See Also

mod_perl 2.0 documentation.

Copyright

mod_perl 2.0 and its core modules are copyrighted under The Apache Software License, Version 1.1.

Authors

The mod_perl development team and numerous contributors.