#include <P_ClusterCache.h>

Collaboration diagram for ClusterVConnection:

Public Member Functions
int	startEvent (int event, Event *e)
int	mainEvent (int event, Event *e)
int	start (EThread *t)
	ClusterVConnection (int is_new_connect_read=0)
	~ClusterVConnection ()
void	free ()
virtual void	do_io_close (int lerrno=-1)
	Indicate that the VConnection is no longer needed.
virtual VIO *	do_io_read (Continuation c, int64_t nbytes, MIOBuffer buf)
	Read data from the VConnection.
virtual VIO *	do_io_write (Continuation c, int64_t nbytes, IOBufferReader buf, bool owner=false)
	Write data to the VConnection.
virtual void	reenable (VIO *vio)
	SLINK (ClusterVConnection, ready_alink)
int	was_closed ()
void	allow_close ()
void	disable_close ()
int	was_remote_closed ()
void	allow_remote_close ()
bool	schedule_write ()
void	set_type (int)
void	set_remote_fill_action (Action *)
bool	is_ram_cache_hit () const
void	set_ram_cache_hit (bool remote_hit)
virtual bool	get_data (int id, void *data)
	Convenience function to retrieve information from VConnection.
virtual void	get_http_info (CacheHTTPInfo **)
virtual int64_t	get_object_size ()
virtual bool	is_pread_capable ()
	Test if the VC can support pread.
virtual void	set_http_info (CacheHTTPInfo *)
virtual bool	set_pin_in_cache (time_t time_pin)
virtual time_t	get_pin_in_cache ()
virtual bool	set_disk_io_priority (int priority)
virtual int	get_disk_io_priority ()
virtual int	get_header (void *ptr, int len)
virtual int	set_header (void *ptr, int len)
virtual int	get_single_data (void *ptr, int len)
Data Fields
ClusterHandler *	ch
int	new_connect_read
int	remote_free
int	last_local_free
int	channel
ClusterVCToken	token
volatile int	close_disabled
volatile int	remote_closed
volatile int	remote_close_disabled
volatile int	remote_lerrno
volatile uint32_t	in_vcs
volatile uint32_t	type
ink_hrtime	start_time
ink_hrtime	last_activity_time
Queue< ByteBankDescriptor >	byte_bank_q
int	n_set_data_msgs
int	n_recv_set_data_msgs
volatile int	pending_remote_fill
Ptr< IOBufferBlock >	read_block
bool	remote_ram_cache_hit
bool	have_all_data
int	initial_data_bytes
Ptr< IOBufferBlock >	remote_write_block
void *	current_cont
int	iov_map
Ptr< ProxyMutex >	read_locked
Ptr< ProxyMutex >	write_locked
Ptr< IOBufferData >	marshal_buf
Ptr< IOBufferBlock >	write_list
IOBufferBlock *	write_list_tail
int	write_list_bytes
int	write_bytes_in_transit
CacheHTTPInfo	alternate
time_t	time_pin
int	disk_io_priority

Detailed Description

Definition at line 483 of file P_ClusterCache.h.

Constructor & Destructor Documentation

ClusterVConnection::ClusterVConnection ( int is_new_connect_read = 0 )

Definition at line 191 of file ClusterVConnection.cc.

References VIO::buffer, ClusterVConnectionBase::read, SET_HANDLER, startEvent(), ClusterVConnState::vio, and ClusterVConnectionBase::write.

ClusterVConnection::~ClusterVConnection ( )

Definition at line 227 of file ClusterVConnection.cc.

References free().

Member Function Documentation

void ClusterVConnection::allow_close ( )

Definition at line 412 of file ClusterVConnection.cc.

References close_disabled.

void ClusterVConnection::allow_remote_close ( )

Definition at line 433 of file ClusterVConnection.cc.

References remote_close_disabled.

Referenced by CacheContinuation::disposeOfDataBuffer(), ClusterVConnectionCacheEvent::eventHandler(), CacheContinuation::remoteOpEvent(), and CacheContinuation::replyOpEvent().

void ClusterVConnection::disable_close ( )

Definition at line 418 of file ClusterVConnection.cc.

References close_disabled.

void ClusterVConnection::do_io_close ( int lerrno = -1 ) [virtual]

Indicate that the VConnection is no longer needed.

Once the state machine has finished using this VConnection, it must call this function to indicate that the VConnection can be deallocated. After a close has been called, the VConnection and underlying processor must not send any more events related to this VConnection to the state machine. Likeswise, the state machine must not access the VConnection or any VIOs obtained from it after calling this method.

Parameters:

lerrno

indicates where a close is a normal close or an abort. The difference between a normal close and an abort depends on the underlying type of the VConnection.

Reimplemented from ClusterVConnectionBase.

Definition at line 272 of file ClusterVConnection.cc.

References ch, current_cont, type, VC_CLUSTER, and ClusterHandler::vcs_push().

VIO * ClusterVConnection::do_io_read	(	Continuation *	c,
		int64_t	nbytes,
		MIOBuffer *	buf
	)			`[virtual]`

Read data from the VConnection.

Called by a state machine to read data from the VConnection. Processors implementing read functionality take out lock, put new bytes on the buffer and call the continuation back before releasing the lock in order to enable the state machine to handle transfer schemes where the end of a given transaction is marked by a special character (ie: NNTP).

Possible Event Codes

On the callback to the continuation, the VConnection may use on of the following values for the event code:

Event code	Meaning
VC_EVENT_READ_READY	Data has been added to the buffer or the buffer is full
VC_EVENT_READ_COMPLETE	The amount of data indicated by 'nbytes' has been read into the buffer
VC_EVENT_EOS	The stream being read from has been shutdown
VC_EVENT_ERROR	An error occurred during the read

Parameters:

	c	Continuation to be called back with events.
	nbytes	Number of bytes to read. If unknown, nbytes must be set to INT64_MAX.
	buf	buffer to read into.

Returns:: VIO representing the scheduled IO operation.

Reimplemented from ClusterVConnectionBase.

Definition at line 252 of file ClusterVConnection.cc.

References ch, type, VC_CLUSTER, VC_CLUSTER_READ, and ClusterHandler::vcs_push().

VIO * ClusterVConnection::do_io_write	(	Continuation *	c,
		int64_t	nbytes,
		IOBufferReader *	buf,
		bool	owner = `false`
	)			`[virtual]`

Write data to the VConnection.

This method is called by a state machine to write data to the VConnection.

Possible Event Codes

On the callback to the continuation, the VConnection may use on of the following event codes:

Event code	Meaning
VC_EVENT_WRITE_READY	Data was written from the reader or there are no bytes available for the reader to write.
VC_EVENT_WRITE_COMPLETE	The amount of data indicated by 'nbytes' has been written to the VConnection
VC_EVENT_INACTIVITY_TIMEOUT	No activity was performed for a certain period.
VC_EVENT_ACTIVE_TIMEOUT	Write operation continued beyond a time limit.
VC_EVENT_ERROR	An error occurred during the write

Parameters:

	c	Continuation to be called back with events.
	nbytes	Number of bytes to write. If unknown, nbytes must be set to INT64_MAX.
	buf	Reader whose data is to be read from.
	owner

Returns:: VIO representing the scheduled IO operation.

Reimplemented from ClusterVConnectionBase.

Definition at line 262 of file ClusterVConnection.cc.

References ch, type, VC_CLUSTER, VC_CLUSTER_WRITE, and ClusterHandler::vcs_push().

void ClusterVConnection::free ( )

Definition at line 233 of file ClusterVConnection.cc.

References alternate, byte_bank_q, ByteBankDescriptor::ByteBankDescriptor_free(), Queue< C, L >::dequeue(), marshal_buf, read_block, remote_write_block, write_bytes_in_transit, write_list, write_list_bytes, and write_list_tail.

Referenced by clusterVCAllocator_free(), and ~ClusterVConnection().

bool ClusterVConnection::get_data	(	int	id,
		void *	data
	)			`[virtual]`

Convenience function to retrieve information from VConnection.

This function is provided as a convenience for state machines to transmit information from/to a VConnection without breaking the VConnection abstraction. Its behavior varies depending on the type of VConnection being used.

Parameters: