Apama  10.3.1.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
AP_UserPluginException Class Reference

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

#include <correlator_plugin.hpp>

Inheritance diagram for AP_UserPluginException:
AP_PluginException

Public Member Functions

 AP_UserPluginException (const std::string &type, const std::string &what)
 
const std::string & getType () const
 
- Public Member Functions inherited from AP_PluginException
 AP_PluginException (const std::string &what)
 

Detailed Description

[DEPRECATED]
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.

Deprecated:
This class has been deprecated.

Constructor & Destructor Documentation

AP_UserPluginException::AP_UserPluginException ( const std::string &  type,
const std::string &  what 
)
inlineexplicit
Deprecated:
Construct an AP_UserPluginException from a type and a message.
Parameters
typeCalling getType() on the resulting EPL exception will result in "PluginException:<type>"
whatCalling getMessage() on the resulting EPL exception will return this string

Member Function Documentation

const std::string& AP_UserPluginException::getType ( ) const
inline
Deprecated:
Return the type of this user exception

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