SHORE API
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Types | Public Member Functions | List of all members
shore::plugin< T > Class Template Referenceabstract

Plugin interface for use with data source objects that manage internal buffers by inheriting from buffer_chain, e.g. monolithic. More...

Inheritance diagram for shore::plugin< T >:
shore::sorting_check< T, Cmp >

Public Types

enum  PluginResult { PLUGIN_SUCCESS =0, PLUGIN_STARVED =1, PLUGIN_END =2 }
 Result of plugin application. More...
 

Public Member Functions

virtual int apply (std::deque< T * > &buffers, std::vector< T * > &unused, const bool flush)=0
 Plugin function that operates on a buffer_chain's buffers. More...
 

Detailed Description

template<typename T>
class shore::plugin< T >

Plugin interface for use with data source objects that manage internal buffers by inheriting from buffer_chain, e.g. monolithic.

Member Enumeration Documentation

template<typename T>
enum shore::plugin::PluginResult

Result of plugin application.

PLUGIN_SUCCESS: proceed to next plugin PLUGIN_STARVED: get more data and re-apply PLUGIN_END: re-start with the first plugin

Member Function Documentation

template<typename T>
virtual int shore::plugin< T >::apply ( std::deque< T * > &  buffers,
std::vector< T * > &  unused,
const bool  flush 
)
pure virtual

Plugin function that operates on a buffer_chain's buffers.

Buffers are passed to all plugins before the first in 'buffers' is emitted.

Implemented in shore::sorting_check< T, Cmp >, and shore::sorting_check< typename source_traits< basic_line_reader >::current_type, bool(*)(const typename source_traits< basic_line_reader >::current_type &, const typename source_traits< basic_line_reader >::current_type &) >.

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