blockfilter.h File Reference

#include <cstddef>
#include <cstdint>
#include <ios>
#include <set>
#include <string>
#include <string_view>
#include <unordered_set>
#include <utility>
#include <vector>
#include <attributes.h>
#include <uint256.h>
#include <util/bytevectorhash.h>

Include dependency graph for blockfilter.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	GCSFilter
	This implements a Golomb-coded set as defined in BIP 158. More...
struct	GCSFilter::Params
class	BlockFilter
	Complete block filter struct as defined in BIP 157. More...

Enumerations
enum class	BlockFilterType : uint8_t { BASIC = 0 , INVALID = 255 }

Functions
const std::string &	BlockFilterTypeName (BlockFilterType filter_type)
	Get the human-readable name for a filter type.
bool	BlockFilterTypeByName (std::string_view name, BlockFilterType &filter_type)
	Find a filter type by its human-readable name.
const std::set< BlockFilterType > &	AllBlockFilterTypes ()
	Get a list of known filter types.
const std::string &	ListBlockFilterTypes ()
	Get a comma-separated list of known filter type names.

Variables
constexpr uint8_t	BASIC_FILTER_P = 19
constexpr uint32_t	BASIC_FILTER_M = 784931

Enumeration Type Documentation

BlockFilterType

enum class BlockFilterType : uint8_t

strong

Enumerator
BASIC
INVALID

Definition at line 93 of file blockfilter.h.

Function Documentation

AllBlockFilterTypes()

const std::set< BlockFilterType > & AllBlockFilterTypes

(

)

Get a list of known filter types.

Definition at line 166 of file blockfilter.cpp.

Here is the caller graph for this function:

BlockFilterTypeByName()

bool BlockFilterTypeByName	(	std::string_view	name,
		BlockFilterType &	filter_type )

Find a filter type by its human-readable name.

Definition at line 155 of file blockfilter.cpp.

Here is the caller graph for this function:

BlockFilterTypeName()

const std::string & BlockFilterTypeName

(

BlockFilterType

filter_type

)

Get the human-readable name for a filter type.

Returns empty string for unknown types.

Definition at line 148 of file blockfilter.cpp.

Here is the caller graph for this function:

ListBlockFilterTypes()

const std::string & ListBlockFilterTypes

(

)

Get a comma-separated list of known filter type names.

Definition at line 180 of file blockfilter.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

BASIC_FILTER_M

uint32_t BASIC_FILTER_M = 784931

constexpr

Definition at line 91 of file blockfilter.h.

BASIC_FILTER_P

uint8_t BASIC_FILTER_P = 19

constexpr

Definition at line 90 of file blockfilter.h.