ApacheTrafficServer: HttpTunnelConsumer Struct Reference

#include <HttpTunnel.h>

Collaboration diagram for HttpTunnelConsumer:

Collaboration graph

Public Member Functions
	HttpTunnelConsumer ()
	LINK (HttpTunnelConsumer, link)
bool	is_downstream_from (VConnection *vc)
	Check if this consumer is downstream from vc.
bool	is_sink () const
	Check if this is a sink (final data destination).
Data Fields
HttpTunnelProducer *	producer
HttpTunnelProducer *	self_producer
HttpTunnelType_t	vc_type
VConnection *	vc
IOBufferReader *	buffer_reader
HttpConsumerHandler	vc_handler
VIO *	write_vio
int64_t	skip_bytes
int64_t	bytes_written
int	handler_state
bool	alive
bool	write_success
const char *	name

Detailed Description

Definition at line 166 of file HttpTunnel.h.

Constructor & Destructor Documentation

HttpTunnelConsumer::HttpTunnelConsumer ( )

Definition at line 458 of file HttpTunnel.cc.

Member Function Documentation

bool HttpTunnelConsumer::is_downstream_from ( VConnection * vc ) [inline]

Check if this consumer is downstream from vc.

Returns:: true if any producer in the tunnel eventually feeds data to this consumer.

Definition at line 521 of file HttpTunnel.h.

References producer, HttpTunnelProducer::self_consumer, and HttpTunnelProducer::vc.

Referenced by HttpSM::tunnel_handler_ua().

bool HttpTunnelConsumer::is_sink ( ) const [inline]

Check if this is a sink (final data destination).

Returns:: true if data exits the ATS process at this consumer.

Definition at line 537 of file HttpTunnel.h.

References HT_CACHE_WRITE, HT_HTTP_CLIENT, and vc_type.

Referenced by HttpTunnel::consumer_reenable().

HttpTunnelConsumer::LINK	(	HttpTunnelConsumer	,
		link
	)

Field Documentation

bool HttpTunnelConsumer::alive

Definition at line 184 of file HttpTunnel.h.

Referenced by HttpTunnel::add_consumer(), HttpTunnel::chain_abort_all(), HttpTunnel::chain_abort_cache_write(), HttpTunnel::close_vc(), HttpTunnel::consumer_handler(), HttpUpdateSM::handle_api_return(), HttpTunnel::producer_handler(), HttpSM::state_watch_for_client_abort(), HttpSM::tunnel_handler_post_server(), HttpSM::tunnel_handler_ssl_consumer(), HttpSM::tunnel_handler_ssl_producer(), and HttpSM::tunnel_handler_transform_read().

IOBufferReader* HttpTunnelConsumer::buffer_reader

Definition at line 176 of file HttpTunnel.h.

Referenced by HttpTunnel::consumer_handler().

int64_t HttpTunnelConsumer::bytes_written

Definition at line 181 of file HttpTunnel.h.

Referenced by HttpTunnel::close_vc(), HttpTunnel::consumer_handler(), HttpSM::is_bg_fill_necessary(), HttpSM::tunnel_handler_post_server(), HttpSM::tunnel_handler_ssl_consumer(), and HttpSM::tunnel_handler_ua().

int HttpTunnelConsumer::handler_state

Definition at line 182 of file HttpTunnel.h.

Referenced by HttpSM::handle_server_setup_error(), HttpSM::state_common_wait_for_transform_read(), and HttpSM::tunnel_handler_transform_write().

const char* HttpTunnelConsumer::name

Definition at line 186 of file HttpTunnel.h.

Referenced by HttpTunnel::add_consumer(), and HttpTunnel::consumer_handler().

HttpTunnelProducer* HttpTunnelConsumer::self_producer

Definition at line 172 of file HttpTunnel.h.

Referenced by HttpTunnel::chain(), HttpTunnel::chain_abort_all(), HttpTunnel::chain_abort_cache_write(), HttpTunnel::close_vc(), HttpSM::tunnel_handler_ssl_consumer(), and HttpSM::tunnel_handler_transform_write().

int64_t HttpTunnelConsumer::skip_bytes

Definition at line 180 of file HttpTunnel.h.

Referenced by HttpTunnel::add_consumer().

VConnection* HttpTunnelConsumer::vc

Definition at line 175 of file HttpTunnel.h.

Referenced by HttpTunnel::add_consumer(), HttpTunnel::chain_abort_all(), HttpTunnel::chain_abort_cache_write(), HttpTunnel::close_vc(), HttpSM::setup_transfer_from_transform(), HttpSM::setup_transfer_from_transform_to_cache_only(), HttpSM::state_common_wait_for_transform_read(), HttpSM::tunnel_handler_100_continue_ua(), HttpSM::tunnel_handler_cache_write(), HttpSM::tunnel_handler_plugin_agent(), HttpSM::tunnel_handler_post_server(), HttpSM::tunnel_handler_ssl_consumer(), HttpSM::tunnel_handler_transform_write(), and HttpSM::tunnel_handler_ua().

HttpConsumerHandler HttpTunnelConsumer::vc_handler

Definition at line 177 of file HttpTunnel.h.

Referenced by HttpTunnel::add_consumer(), and HttpTunnel::consumer_handler().

HttpTunnelType_t HttpTunnelConsumer::vc_type

Definition at line 174 of file HttpTunnel.h.

Referenced by HttpTunnel::add_consumer(), HttpTunnel::chain_abort_all(), HttpTunnel::chain_abort_cache_write(), HttpSM::is_bg_fill_necessary(), is_sink(), HttpSM::setup_transfer_from_transform(), HttpSM::setup_transfer_from_transform_to_cache_only(), HttpSM::tunnel_handler_post_ua(), HttpSM::tunnel_handler_push(), and HttpSM::tunnel_handler_ssl_consumer().

bool HttpTunnelConsumer::write_success

Definition at line 185 of file HttpTunnel.h.

Referenced by HttpSM::state_common_wait_for_transform_read(), HttpSM::tunnel_handler_100_continue(), HttpSM::tunnel_handler_100_continue_ua(), HttpSM::tunnel_handler_cache_write(), HttpSM::tunnel_handler_plugin_agent(), HttpSM::tunnel_handler_post_or_put(), HttpSM::tunnel_handler_post_server(), HttpSM::tunnel_handler_push(), HttpSM::tunnel_handler_ssl_consumer(), HttpSM::tunnel_handler_transform_write(), and HttpSM::tunnel_handler_ua().

VIO* HttpTunnelConsumer::write_vio

Definition at line 178 of file HttpTunnel.h.

Referenced by HttpTunnel::chain_abort_all(), HttpTunnel::chain_abort_cache_write(), HttpTunnel::close_vc(), HttpTunnel::consumer_handler(), HttpUpdateSM::handle_api_return(), HttpSM::handle_server_setup_error(), HttpTunnel::main_handler(), HttpTunnel::producer_handler(), HttpSM::state_watch_for_client_abort(), and HttpSM::tunnel_handler_cache_write().

The documentation for this struct was generated from the following files: