The base interface used when creating a Plugin. More...

#include <Plugin.h>

Inherits atscppapi::noncopyable.

Inherited by atscppapi::GlobalPlugin, and atscppapi::TransactionPlugin.

Collaboration diagram for atscppapi::Plugin:

Public Types
enum	HookType { HOOK_READ_REQUEST_HEADERS_PRE_REMAP = 0, HOOK_READ_REQUEST_HEADERS_POST_REMAP, HOOK_SEND_REQUEST_HEADERS, HOOK_READ_RESPONSE_HEADERS, HOOK_SEND_RESPONSE_HEADERS, HOOK_OS_DNS }
	A enumeration of the available types of Hooks. More...
Public Member Functions
virtual void	handleReadRequestHeadersPreRemap (Transaction &transaction)
	This method must be implemented when you hook HOOK_READ_REQUEST_HEADERS_PRE_REMAP.
virtual void	handleReadRequestHeadersPostRemap (Transaction &transaction)
	This method must be implemented when you hook HOOK_READ_REQUEST_HEADERS_POST_REMAP.
virtual void	handleSendRequestHeaders (Transaction &transaction)
	This method must be implemented when you hook HOOK_SEND_REQUEST_HEADERS.
virtual void	handleReadResponseHeaders (Transaction &transaction)
	This method must be implemented when you hook HOOK_READ_RESPONSE_HEADERS.
virtual void	handleSendResponseHeaders (Transaction &transaction)
	This method must be implemented when you hook HOOK_SEND_RESPONSE_HEADERS.
virtual void	handleOsDns (Transaction &transaction)
	This method must be implemented when you hook HOOK_OS_DNS.
virtual	~Plugin ()

Detailed Description

The base interface used when creating a Plugin.

Note:: This interface can never be implemented directly, it should be implemented through extending GlobalPlugin, TransactionPlugin, or TransformationPlugin.

See also:: TransactionPlugin; GlobalPlugin; TransformationPlugin

Definition at line 45 of file lib/atscppapi/src/include/atscppapi/Plugin.h.

Member Enumeration Documentation

enum atscppapi::Plugin::HookType

A enumeration of the available types of Hooks.

These are used with GlobalPlugin::registerHook() and TransactionPlugin::registerHook().

Enumerator:

HOOK_READ_REQUEST_HEADERS_PRE_REMAP	This hook will be fired before remap has occured.
HOOK_READ_REQUEST_HEADERS_POST_REMAP	This hook will be fired directly after remap has occured.
HOOK_SEND_REQUEST_HEADERS	This hook will be fired right before request headers are sent to the origin.
HOOK_READ_RESPONSE_HEADERS	This hook will be fired right after response headers have been read from the origin.
HOOK_SEND_RESPONSE_HEADERS	This hook will be fired right before the response headers are sent to the client.
HOOK_OS_DNS	This hook will be fired right after the OS DNS lookup.

Definition at line 51 of file lib/atscppapi/src/include/atscppapi/Plugin.h.

Constructor & Destructor Documentation

virtual atscppapi::Plugin::~Plugin ( ) [inline, virtual]

Definition at line 90 of file lib/atscppapi/src/include/atscppapi/Plugin.h.

Member Function Documentation

virtual void atscppapi::Plugin::handleOsDns ( Transaction & transaction ) [inline, virtual]

This method must be implemented when you hook HOOK_OS_DNS.

Definition at line 88 of file lib/atscppapi/src/include/atscppapi/Plugin.h.

References atscppapi::Transaction::resume().

virtual void atscppapi::Plugin::handleReadRequestHeadersPostRemap ( Transaction & transaction ) [inline, virtual]

This method must be implemented when you hook HOOK_READ_REQUEST_HEADERS_POST_REMAP.

Definition at line 68 of file lib/atscppapi/src/include/atscppapi/Plugin.h.

References atscppapi::Transaction::resume().

virtual void atscppapi::Plugin::handleReadRequestHeadersPreRemap ( Transaction & transaction ) [inline, virtual]

This method must be implemented when you hook HOOK_READ_REQUEST_HEADERS_PRE_REMAP.

Definition at line 63 of file lib/atscppapi/src/include/atscppapi/Plugin.h.

References atscppapi::Transaction::resume().

virtual void atscppapi::Plugin::handleReadResponseHeaders ( Transaction & transaction ) [inline, virtual]

This method must be implemented when you hook HOOK_READ_RESPONSE_HEADERS.

Definition at line 78 of file lib/atscppapi/src/include/atscppapi/Plugin.h.

References atscppapi::Transaction::resume().

virtual void atscppapi::Plugin::handleSendRequestHeaders ( Transaction & transaction ) [inline, virtual]

This method must be implemented when you hook HOOK_SEND_REQUEST_HEADERS.

Definition at line 73 of file lib/atscppapi/src/include/atscppapi/Plugin.h.

References atscppapi::Transaction::resume().

virtual void atscppapi::Plugin::handleSendResponseHeaders ( Transaction & transaction ) [inline, virtual]

This method must be implemented when you hook HOOK_SEND_RESPONSE_HEADERS.

Definition at line 83 of file lib/atscppapi/src/include/atscppapi/Plugin.h.

References atscppapi::Transaction::resume().

The documentation for this class was generated from the following file:

lib/atscppapi/src/include/atscppapi/Plugin.h

atscppapi::Plugin Class Reference

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation