atscppapi::Plugin Class Reference

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

#include "Plugin.h"

Inheritance 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 }

Public Member Functions
virtual void	handleReadRequestHeadersPreRemap (Transaction &transaction)
virtual void	handleReadRequestHeadersPostRemap (Transaction &transaction)
virtual void	handleSendRequestHeaders (Transaction &transaction)
virtual void	handleReadResponseHeaders (Transaction &transaction)
virtual void	handleSendResponseHeaders (Transaction &transaction)
virtual void	handleOsDns (Transaction &transaction)

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

TransformationPluginHuman readable strings for each HookType, you can access them as HOOK_TYPE_STRINGS[HOOK_OS_DNS] for example.

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

Member Function Documentation

virtual void atscppapi::Plugin::handleOsDns ( Transaction &  transaction )

inlinevirtual

This method must be implemented when you hook HOOK_OS_DNS

virtual void atscppapi::Plugin::handleReadRequestHeadersPostRemap ( Transaction &  transaction )

inlinevirtual

This method must be implemented when you hook HOOK_READ_REQUEST_HEADERS_POST_REMAP

virtual void atscppapi::Plugin::handleReadRequestHeadersPreRemap ( Transaction &  transaction )

inlinevirtual

This method must be implemented when you hook HOOK_READ_REQUEST_HEADERS_PRE_REMAP

virtual void atscppapi::Plugin::handleReadResponseHeaders ( Transaction &  transaction )

inlinevirtual

This method must be implemented when you hook HOOK_READ_RESPONSE_HEADERS

virtual void atscppapi::Plugin::handleSendRequestHeaders ( Transaction &  transaction )

inlinevirtual

This method must be implemented when you hook HOOK_SEND_REQUEST_HEADERS

virtual void atscppapi::Plugin::handleSendResponseHeaders ( Transaction &  transaction )

inlinevirtual

This method must be implemented when you hook HOOK_SEND_RESPONSE_HEADERS

---

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

• src/include/atscppapi/Plugin.h