php_stream_filter_api.h File Reference

Go to the source code of this file.

Data Structures
struct	_php_stream_bucket
struct	_php_stream_bucket_brigade
struct	_php_stream_filter_ops
struct	_php_stream_filter_chain
struct	_php_stream_filter
struct	_php_stream_filter_factory

Macros
#define	PHP_STREAM_FILTER_READ   0x0001
#define	PHP_STREAM_FILTER_WRITE   0x0002
#define	PHP_STREAM_FILTER_ALL   (PHP_STREAM_FILTER_READ | PHP_STREAM_FILTER_WRITE)
#define	php_stream_bucket_addref(bucket)
#define	PSFS_FLAG_NORMAL   0 /* regular read/write */
#define	PSFS_FLAG_FLUSH_INC   1 /* an incremental flush */
#define	PSFS_FLAG_FLUSH_CLOSE   2 /* final flush prior to closing */
#define	php_stream_filter_alloc(fops, thisptr, persistent)
#define	php_stream_filter_alloc_rel(fops, thisptr, persistent)
#define	php_stream_filter_prepend(chain, filter)
#define	php_stream_filter_append(chain, filter)
#define	php_stream_filter_flush(filter, finish)
#define	php_stream_is_filtered(stream)

Typedefs
typedef struct _php_stream_bucket	php_stream_bucket
typedef struct _php_stream_bucket_brigade	php_stream_bucket_brigade
typedef struct _php_stream_filter_ops	php_stream_filter_ops
typedef struct _php_stream_filter_chain	php_stream_filter_chain
typedef struct _php_stream_filter_factory	php_stream_filter_factory

Enumerations
enum	php_stream_filter_status_t { PSFS_ERR_FATAL , PSFS_FEED_ME , PSFS_PASS_ON }

Functions
PHPAPI php_stream_bucket *	php_stream_bucket_new (php_stream *stream, char *buf, size_t buflen, uint8_t own_buf, uint8_t buf_persistent)
PHPAPI int	php_stream_bucket_split (php_stream_bucket *in, php_stream_bucket **left, php_stream_bucket **right, size_t length)
PHPAPI void	php_stream_bucket_delref (php_stream_bucket *bucket)
PHPAPI void	php_stream_bucket_prepend (php_stream_bucket_brigade *brigade, php_stream_bucket *bucket)
PHPAPI void	php_stream_bucket_append (php_stream_bucket_brigade *brigade, php_stream_bucket *bucket)
PHPAPI void	php_stream_bucket_unlink (php_stream_bucket *bucket)
PHPAPI php_stream_bucket *	php_stream_bucket_make_writeable (php_stream_bucket *bucket)
PHPAPI void	_php_stream_filter_prepend (php_stream_filter_chain *chain, php_stream_filter *filter)
PHPAPI int	php_stream_filter_prepend_ex (php_stream_filter_chain *chain, php_stream_filter *filter)
PHPAPI void	_php_stream_filter_append (php_stream_filter_chain *chain, php_stream_filter *filter)
PHPAPI int	php_stream_filter_append_ex (php_stream_filter_chain *chain, php_stream_filter *filter)
PHPAPI int	_php_stream_filter_flush (php_stream_filter *filter, int finish)
PHPAPI php_stream_filter *	php_stream_filter_remove (php_stream_filter *filter, int call_dtor)
PHPAPI void	php_stream_filter_free (php_stream_filter *filter)
PHPAPI php_stream_filter *	_php_stream_filter_alloc (const php_stream_filter_ops *fops, void *abstract, uint8_t persistent STREAMS_DC)
PHPAPI int	php_stream_filter_register_factory (const char *filterpattern, const php_stream_filter_factory *factory)
PHPAPI int	php_stream_filter_unregister_factory (const char *filterpattern)
PHPAPI int	php_stream_filter_register_factory_volatile (zend_string *filterpattern, const php_stream_filter_factory *factory)
PHPAPI php_stream_filter *	php_stream_filter_create (const char *filtername, zval *filterparams, uint8_t persistent)

Macro Definition Documentation

php_stream_bucket_addref

#define php_stream_bucket_addref

(

bucket

)

Value:

(bucket)->refcount++

Definition at line 69 of file php_stream_filter_api.h.

PHP_STREAM_FILTER_ALL

#define PHP_STREAM_FILTER_ALL   (PHP_STREAM_FILTER_READ | PHP_STREAM_FILTER_WRITE)

Definition at line 35 of file php_stream_filter_api.h.

php_stream_filter_alloc

#define php_stream_filter_alloc	(		fops,
			thisptr,
			persistent )

Value:

_php_stream_filter_alloc((fops), (thisptr), (persistent) STREAMS_CC)

Definition at line 132 of file php_stream_filter_api.h.

php_stream_filter_alloc_rel

#define php_stream_filter_alloc_rel	(		fops,
			thisptr,
			persistent )

Value:

_php_stream_filter_alloc((fops), (thisptr), (persistent) STREAMS_REL_CC)

Definition at line 133 of file php_stream_filter_api.h.

php_stream_filter_append

#define php_stream_filter_append	(		chain,
			filter )

Value:

_php_stream_filter_append((chain), (filter))

Definition at line 135 of file php_stream_filter_api.h.

php_stream_filter_flush

#define php_stream_filter_flush	(		filter,
			finish )

Value:

_php_stream_filter_flush((filter), (finish))

Definition at line 136 of file php_stream_filter_api.h.

php_stream_filter_prepend

#define php_stream_filter_prepend	(		chain,
			filter )

Value:

_php_stream_filter_prepend((chain), (filter))

Definition at line 134 of file php_stream_filter_api.h.

PHP_STREAM_FILTER_READ

#define PHP_STREAM_FILTER_READ   0x0001

Definition at line 33 of file php_stream_filter_api.h.

PHP_STREAM_FILTER_WRITE

#define PHP_STREAM_FILTER_WRITE   0x0002

Definition at line 34 of file php_stream_filter_api.h.

php_stream_is_filtered

#define php_stream_is_filtered

(

stream

)

Value:

((stream)->readfilters.head || (stream)->writefilters.head)

Definition at line 138 of file php_stream_filter_api.h.

PSFS_FLAG_FLUSH_CLOSE

#define PSFS_FLAG_FLUSH_CLOSE   2 /* final flush prior to closing */

Definition at line 78 of file php_stream_filter_api.h.

PSFS_FLAG_FLUSH_INC

#define PSFS_FLAG_FLUSH_INC   1 /* an incremental flush */

Definition at line 77 of file php_stream_filter_api.h.

PSFS_FLAG_NORMAL

#define PSFS_FLAG_NORMAL   0 /* regular read/write */

Definition at line 76 of file php_stream_filter_api.h.

Typedef Documentation

php_stream_bucket

typedef struct _php_stream_bucket php_stream_bucket

Definition at line 37 of file php_stream_filter_api.h.

php_stream_bucket_brigade

typedef struct _php_stream_bucket_brigade php_stream_bucket_brigade

Definition at line 38 of file php_stream_filter_api.h.

php_stream_filter_chain

typedef struct _php_stream_filter_chain php_stream_filter_chain

php_stream_filter_factory

typedef struct _php_stream_filter_factory php_stream_filter_factory

php_stream_filter_ops

typedef struct _php_stream_filter_ops php_stream_filter_ops

Enumeration Type Documentation

php_stream_filter_status_t

enum php_stream_filter_status_t

Enumerator
PSFS_ERR_FATAL
PSFS_FEED_ME
PSFS_PASS_ON

Definition at line 58 of file php_stream_filter_api.h.

Function Documentation

_php_stream_filter_alloc()

PHPAPI php_stream_filter * _php_stream_filter_alloc	(	const php_stream_filter_ops *	fops,
		void *	abstract,
		uint8_t persistent	STREAMS_DC )

Definition at line 264 of file filter.c.

_php_stream_filter_append()

PHPAPI void _php_stream_filter_append	(	php_stream_filter_chain *	chain,
		php_stream_filter *	filter )

Definition at line 385 of file filter.c.

_php_stream_filter_flush()

PHPAPI int _php_stream_filter_flush	(	php_stream_filter *	filter,
		int	finish )

Definition at line 398 of file filter.c.

_php_stream_filter_prepend()

PHPAPI void _php_stream_filter_prepend	(	php_stream_filter_chain *	chain,
		php_stream_filter *	filter )

Definition at line 301 of file filter.c.

php_stream_bucket_append()

PHPAPI void php_stream_bucket_append	(	php_stream_bucket_brigade *	brigade,
		php_stream_bucket *	bucket )

Definition at line 174 of file filter.c.

php_stream_bucket_delref()

PHPAPI void php_stream_bucket_delref

(

php_stream_bucket *

bucket

)

Definition at line 150 of file filter.c.

php_stream_bucket_make_writeable()

PHPAPI php_stream_bucket * php_stream_bucket_make_writeable

(

php_stream_bucket *

bucket

)

Definition at line 104 of file filter.c.

php_stream_bucket_new()

PHPAPI php_stream_bucket * php_stream_bucket_new	(	php_stream *	stream,
		char *	buf,
		size_t	buflen,
		uint8_t	own_buf,
		uint8_t	buf_persistent )

Definition at line 71 of file filter.c.

php_stream_bucket_prepend()

PHPAPI void php_stream_bucket_prepend	(	php_stream_bucket_brigade *	brigade,
		php_stream_bucket *	bucket )

Definition at line 160 of file filter.c.

php_stream_bucket_split()

PHPAPI int php_stream_bucket_split	(	php_stream_bucket *	in,
		php_stream_bucket **	left,
		php_stream_bucket **	right,
		size_t	length )

Definition at line 128 of file filter.c.

php_stream_bucket_unlink()

PHPAPI void php_stream_bucket_unlink

(

php_stream_bucket *

bucket

)

Definition at line 192 of file filter.c.

php_stream_filter_append_ex()

PHPAPI int php_stream_filter_append_ex	(	php_stream_filter_chain *	chain,
		php_stream_filter *	filter )

Definition at line 306 of file filter.c.

php_stream_filter_create()

PHPAPI php_stream_filter * php_stream_filter_create	(	const char *	filtername,
		zval *	filterparams,
		uint8_t	persistent )

Definition at line 220 of file filter.c.

php_stream_filter_free()

PHPAPI void php_stream_filter_free

(

php_stream_filter *

filter

)

Definition at line 278 of file filter.c.

php_stream_filter_prepend_ex()

PHPAPI int php_stream_filter_prepend_ex	(	php_stream_filter_chain *	chain,
		php_stream_filter *	filter )

Definition at line 285 of file filter.c.

php_stream_filter_register_factory()

PHPAPI int php_stream_filter_register_factory	(	const char *	filterpattern,
		const php_stream_filter_factory *	factory )

Definition at line 43 of file filter.c.

php_stream_filter_register_factory_volatile()

PHPAPI int php_stream_filter_register_factory_volatile	(	zend_string *	filterpattern,
		const php_stream_filter_factory *	factory )

Definition at line 58 of file filter.c.

php_stream_filter_remove()

PHPAPI php_stream_filter * php_stream_filter_remove	(	php_stream_filter *	filter,
		int	call_dtor )

Definition at line 483 of file filter.c.

php_stream_filter_unregister_factory()

PHPAPI int php_stream_filter_unregister_factory

(

const char *

filterpattern

)

Definition at line 52 of file filter.c.