#include <TransformInternal.h>

Collaboration diagram for TransformVConnection:

Public Member Functions
	TransformVConnection (Continuation cont, APIHook hooks)
	~TransformVConnection ()
int	handle_event (int event, void *edata)
VIO *	do_io_read (Continuation c, int64_t nbytes, MIOBuffer buf)
	Read data from the VConnection.
VIO *	do_io_write (Continuation c, int64_t nbytes, IOBufferReader buf, bool owner=false)
	Write data to the VConnection.
void	do_io_close (int lerrno=-1)
	Indicate that the VConnection is no longer needed.
void	do_io_shutdown (ShutdownHowTo_t howto)
	Terminate one or both directions of the VConnection.
void	reenable (VIO *vio)
virtual uint64_t	backlog (uint64_t limit=UINT64_MAX)
	Compute the backlog.
Data Fields
VConnection *	m_transform
Continuation *	m_cont
TransformTerminus	m_terminus
volatile int	m_closed

Detailed Description

Definition at line 62 of file TransformInternal.h.

Constructor & Destructor Documentation

TransformVConnection::TransformVConnection	(	Continuation *	cont,
		APIHook *	hooks
	)

Definition at line 388 of file Transform.cc.

References Debug, INKVConnInternal::do_io_transform(), handle_event(), ink_assert, APIHook::m_cont, m_terminus, m_transform, APIHook::next(), and SET_HANDLER.

TransformVConnection::~TransformVConnection ( )

Definition at line 412 of file Transform.cc.

References TransformTerminus::m_read_vio, m_terminus, TransformTerminus::m_write_vio, Continuation::mutex, and VIO::set_continuation().

Member Function Documentation

uint64_t TransformVConnection::backlog ( uint64_t limit = UINT64_MAX ) [virtual]

Compute the backlog.

Returns:: The actual backlog, or a value at least limit.

Implements TransformVCChain.

Definition at line 498 of file Transform.cc.

References VIO::buffer, VIO::get_reader(), INKVConnInternal::m_output_vc, TransformTerminus::m_read_vio, INKVConnInternal::m_read_vio, m_terminus, m_transform, TransformTerminus::m_write_vio, MIOBuffer::max_read_avail(), IOBufferReader::read_avail(), and MIOBufferAccessor::writer().

void TransformVConnection::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.

Implements VConnection.

Definition at line 459 of file Transform.cc.

References Debug, VConnection::do_io_close(), m_closed, and m_transform.

VIO * TransformVConnection::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.

Implements VConnection.

Definition at line 436 of file Transform.cc.

References Debug, TransformTerminus::do_io_read(), and m_terminus.

void TransformVConnection::do_io_shutdown ( ShutdownHowTo_t howto ) [virtual]

Terminate one or both directions of the VConnection.

Indicates that one or both sides of the VConnection should be terminated. After this call is issued, no further I/O can be done on the specified direction of the connection. The processor must not send any further events (including timeout events) to the state machine, and the state machine must not use any VIOs from a shutdown direction of the connection. Even if both sides of a connection are shutdown, the state machine must still call do_io_close() when it wishes the VConnection to be deallocated.

Possible howto values

Value	Meaning
IO_SHUTDOWN_READ	Indicates that this VConnection should not generate any more read events
IO_SHUTDOWN_WRITE	Indicates that this VConnection should not generate any more write events
IO_SHUTDOWN_READWRITE	Indicates that this VConnection should not generate any more read nor write events

Parameters:

howto

Specifies which direction of the VConnection to shutdown.

Implements VConnection.

Definition at line 476 of file Transform.cc.

References Debug, VConnection::do_io_shutdown(), ink_assert, IO_SHUTDOWN_WRITE, and m_transform.

VIO * TransformVConnection::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