Base class that remap plugins should extend. More...

Public Types
enum	Result { RESULT_ERROR = 0, RESULT_NO_REMAP, RESULT_DID_REMAP, RESULT_NO_REMAP_STOP, RESULT_DID_REMAP_STOP }
Public Member Functions
	RemapPlugin (void **instance_handle)
	Constructor.
virtual Result	doRemap (const Url &map_from_url ATSCPPAPI_UNUSED, const Url &map_to_url ATSCPPAPI_UNUSED, Transaction &transaction ATSCPPAPI_UNUSED, bool &redirect ATSCPPAPI_UNUSED)
	Invoked when a request matches the remap.config line - implementation should perform the remap.
virtual	~RemapPlugin ()

Detailed Description

Base class that remap plugins should extend.

Definition at line 36 of file RemapPlugin.h.

Member Enumeration Documentation

Enumerator:

Definition at line 45 of file RemapPlugin.h.

atscppapi::RemapPlugin::RemapPlugin ( void ** instance_handle )

Constructor.

Parameters:

instance_handle

The instance_handle argument received in TSRemapInit() should be passed here.

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

Definition at line 65 of file RemapPlugin.h.

virtual Result atscppapi::RemapPlugin::doRemap	(	const Url &map_from_url	ATSCPPAPI_UNUSED,
		const Url &map_to_url	ATSCPPAPI_UNUSED,
		Transaction &transaction	ATSCPPAPI_UNUSED,
		bool &redirect	ATSCPPAPI_UNUSED
	)			`[inline, virtual]`

Invoked when a request matches the remap.config line - implementation should perform the remap.

The client's URL is in the transaction and that's where it should be modified.

Parameters:

	map_from_url	The map from URL specified in the remap.config line.
	map_to_url	The map to URL specified in the remap.config line.
	transaction	Transaction
	redirect	Output argument that should be set to true if the (new) url should be used as a redirect.

Returns:: Result of the remap - will dictate futher processing by the system.

Definition at line 60 of file RemapPlugin.h.

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