Boost C++ Libraries

PrevUpHomeNext

Class template basic_filter_factory

boost::log::basic_filter_factory — The base class for filter factories.

Synopsis

// In header: <boost/log/utility/init/filter_parser.hpp>

template<typename CharT, typename AttributeValueT> 
class basic_filter_factory : public boost::log::filter_factory< CharT > {
public:
  // types
  typedef AttributeValueT        attribute_value_type;  // The type(s) of the attribute value expected. 
  typedef base_type::string_type string_type;           // String type. 
  typedef base_type::filter_type filter_type;           // Filter function type. 

  // public member functions
  filter_type on_exists_test(string_type const &);
  filter_type on_equality_relation(string_type const &, string_type const &);
  filter_type on_inequality_relation(string_type const &, string_type const &);
  filter_type on_less_relation(string_type const &, string_type const &);
  filter_type on_greater_relation(string_type const &, string_type const &);
  filter_type on_less_or_equal_relation(string_type const &, 
                                        string_type const &);
  filter_type on_greater_or_equal_relation(string_type const &, 
                                           string_type const &);
  filter_type on_custom_relation(string_type const &, string_type const &, 
                                 string_type const &);
  attribute_value_type parse_argument(string_type const &);
};

Description

basic_filter_factory public member functions

  1. filter_type on_exists_test(string_type const & name);
    The callback for filter for the attribute existence test.
  2. filter_type on_equality_relation(string_type const & name, 
                                     string_type const & arg);
    The callback for equality relation filter.
  3. filter_type on_inequality_relation(string_type const & name, 
                                       string_type const & arg);
    The callback for inequality relation filter.
  4. filter_type on_less_relation(string_type const & name, 
                                 string_type const & arg);
    The callback for less relation filter.
  5. filter_type on_greater_relation(string_type const & name, 
                                    string_type const & arg);
    The callback for greater relation filter.
  6. filter_type on_less_or_equal_relation(string_type const & name, 
                                          string_type const & arg);
    The callback for less or equal relation filter.
  7. filter_type on_greater_or_equal_relation(string_type const & name, 
                                             string_type const & arg);
    The callback for greater or equal relation filter.
  8. filter_type on_custom_relation(string_type const & name, 
                                   string_type const & rel, 
                                   string_type const & arg);
    The callback for custom relation filter.
  9. attribute_value_type parse_argument(string_type const & arg);
    The function parses the argument value for a binary relation.

PrevUpHomeNext