mirror of
https://github.com/zeek/zeek.git
synced 2025-10-16 05:28:20 +00:00
f5a76c1aed
This largely copies over Spicy's `.clang-format` configuration file. The one place where we deviate is header include order since Zeek depends on headers being included in a certain order.
62 lines
1.6 KiB
C++
62 lines
1.6 KiB
C++
// See the file "COPYING" in the main distribution directory for copyright.
|
|
|
|
#pragma once
|
|
|
|
#include "zeek/zeek-config.h"
|
|
|
|
#include <functional>
|
|
|
|
#include "zeek/Tag.h"
|
|
#include "zeek/plugin/Component.h"
|
|
#include "zeek/util.h"
|
|
|
|
namespace zeek::packet_analysis {
|
|
|
|
class Analyzer;
|
|
using AnalyzerPtr = std::shared_ptr<Analyzer>;
|
|
|
|
class Component : public plugin::Component {
|
|
public:
|
|
using factory_callback = std::function<AnalyzerPtr()>;
|
|
|
|
Component(const std::string& name, factory_callback factory, zeek::Tag::subtype_t subtype = 0);
|
|
~Component() override = default;
|
|
|
|
/**
|
|
* Initialization function. This function has to be called before any
|
|
* plugin component functionality is used; it is used to add the
|
|
* plugin component to the list of components and to initialize tags
|
|
*/
|
|
void Initialize() override;
|
|
|
|
/**
|
|
* Returns the analyzer's factory function.
|
|
*/
|
|
factory_callback Factory() const { return factory; }
|
|
|
|
/**
|
|
* Returns true if the analyzer is currently enabled and hence
|
|
* available for use.
|
|
*/
|
|
bool Enabled() const { return enabled; }
|
|
|
|
/**
|
|
* Enables or disables this analyzer.
|
|
*
|
|
* @param arg_enabled True to enabled, false to disable.
|
|
*
|
|
*/
|
|
void SetEnabled(bool arg_enabled);
|
|
|
|
protected:
|
|
/**
|
|
* Overridden from plugin::Component.
|
|
*/
|
|
void DoDescribe(ODesc* d) const override;
|
|
|
|
private:
|
|
factory_callback factory; // The analyzer's factory callback.
|
|
bool enabled = true; // True if the analyzer is enabled.
|
|
};
|
|
|
|
} // namespace zeek::packet_analysis
|