AP_UserPluginException Class Reference

Thrown by plugin authors to signal an error to any EPL calling this plugin. More...

#include <correlator_plugin.hpp>

Inheritance diagram for AP_UserPluginException:

Public Member Functions
	AP_UserPluginException (const std::string &type, const std::string &what)
	Construct an AP_UserPluginException from a type and a message. More...
const std::string &	getType () const
	Return the type of this user exception. More...
Public Member Functions inherited from AP_PluginException
	AP_PluginException (const std::string &what)
	Construct an AP_PluginException from a message. More...

Detailed Description

Thrown by plugin authors to signal an error to any EPL calling this plugin.

While all exceptions thrown from a plugin method can be caught within EPL, this class is preferred as it allows the plugin author to determine the type of the EPL exception.

Constructor & Destructor Documentation

AP_UserPluginException::AP_UserPluginException ( const std::string &  type, const std::string &  what  )

inlineexplicit

Construct an AP_UserPluginException from a type and a message.

Parameters

type	Calling getType() on the resulting EPL exception will result in "PluginException:<type>"
what	Calling getMessage() on the resulting EPL exception will return this string

Member Function Documentation

const std::string& AP_UserPluginException::getType ( ) const

inline

Return the type of this user exception.

---

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

• correlator_plugin.hpp