RestWebPlugin Class Reference

REST web plugin. More...

#include <RestWebPlugin.hh>

Inherits SystemPlugin.

Public Types

typedef boost::shared_ptr< SystemPluginTPtr
 plugin pointer type definition More...
 

Public Member Functions

 RestWebPlugin ()
 Constructor. More...
 
virtual ~RestWebPlugin ()
 Destructor. More...
 
std::string GetFilename () const
 Get the name of the handler. More...
 
std::string GetHandle () const
 Get the short name of the handler. More...
 
PluginType GetType () const
 Returns the type of the plugin. More...
 
virtual void Load (int _argc, char **_argv)
 Plugin Load. More...
 
void OnEventRestPost (ConstRestPostPtr &_msg)
 Called everytime a REST POST event message is received. More...
 
void OnRestLoginRequest (ConstRestLoginPtr &_msg)
 Called everytime a login message is received. More...
 
void OnRestLogoutRequest (ConstRestLogoutPtr &_msg)
 Called everytime a logout message is received. More...
 
void OnSimEvent (ConstSimEventPtr &_msg)
 Called everytime a SimEvent message is received. More...
 
virtual void Reset ()
 Override this method for custom plugin reset behavior. More...
 

Static Public Member Functions

static TPtr Create (const std::string &_filename, const std::string &_name)
 a class method that creates a plugin from a file name. More...
 

Protected Attributes

std::string filename
 Path to the shared library file. More...
 
std::string handleName
 Short name. More...
 
PluginType type
 Type of plugin. More...
 

Detailed Description

REST web plugin.

Member Typedef Documentation

typedef boost::shared_ptr<SystemPlugin > TPtr
inherited

plugin pointer type definition

Constructor & Destructor Documentation

Constructor.

virtual ~RestWebPlugin ( )
virtual

Destructor.

Member Function Documentation

static TPtr Create ( const std::string &  _filename,
const std::string &  _name 
)
inlinestaticinherited

a class method that creates a plugin from a file name.

It locates the shared library and loads it dynamically.

Parameters
[in]_filenamethe path to the shared library.
[in]_nameshort name of the plugin
Returns
Shared Pointer to this class type
std::string GetFilename ( ) const
inlineinherited

Get the name of the handler.

std::string GetHandle ( ) const
inlineinherited

Get the short name of the handler.

PluginType GetType ( ) const
inlineinherited

Returns the type of the plugin.

Returns
type of the plugin
virtual void Load ( int  _argc,
char **  _argv 
)
virtual

Plugin Load.

Parameters
[in]_argcArgument count
[in]_argvArgument vector

Implements SystemPlugin.

void OnEventRestPost ( ConstRestPostPtr &  _msg)

Called everytime a REST POST event message is received.

Parameters
[in]_msgThe post message
void OnRestLoginRequest ( ConstRestLoginPtr &  _msg)

Called everytime a login message is received.

Parameters
[in]_msgThe login message
void OnRestLogoutRequest ( ConstRestLogoutPtr &  _msg)

Called everytime a logout message is received.

Parameters
[in]_msgThe login message
void OnSimEvent ( ConstSimEventPtr &  _msg)

Called everytime a SimEvent message is received.

Parameters
[in]TheSimEvent message
virtual void Reset ( )
inlinevirtualinherited

Override this method for custom plugin reset behavior.

Member Data Documentation

std::string filename
protectedinherited

Path to the shared library file.

std::string handleName
protectedinherited

Short name.

PluginType type
protectedinherited

Type of plugin.


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