atscppapi::RemapPlugin Class Reference

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

#include "RemapPlugin.h"

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)
virtual Result	doRemap (const Url &map_from_url, const Url &map_to_url, Transaction &transaction, bool &redirect)

Detailed Description

Base class that remap plugins should extend.

Constructor & Destructor Documentation

RemapPlugin::RemapPlugin

(

void **

instance_handle

)

Constructor

Parameters

instance_handle

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

Member Function Documentation

virtual Result atscppapi::RemapPlugin::doRemap ( const Url &  map_from_url, const Url &  map_to_url, Transaction &  transaction, bool &  redirect  )

inlinevirtual

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.

---

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

• src/include/atscppapi/RemapPlugin.h
• src/RemapPlugin.cc