This class provides a distributed knowledge base implementation. More...

#include <KnowledgeBaseImpl.h>

Classes
struct	ModifiedsSender

Public Member Functions
	KnowledgeBaseImpl ()
	Constructor. More...

	KnowledgeBaseImpl (const std::string &host, const madara::transport::TransportSettings &config)
	Constructor. More...

	KnowledgeBaseImpl (const std::string &host, int transport)
	Constructor. More...

	KnowledgeBaseImpl (const std::string &host, int transport, const std::string &domain)
	Constructor. More...

	~KnowledgeBaseImpl ()
	Destructor. More...

void	acquire (void)
	Acquires the recursive lock on the knowledge base. More...

void	activate_transport (void)
	Starts the transport mechanism for dissemination if it is closed. More...

void	add_modifieds (const VariableReferences &modifieds) const
	Adds a list of VariableReferences to the current modified list. More...

int	apply_modified (const EvalSettings &settings=EvalSettings())
	Applies current time and modified to all global variables and tries to send them. More...

void	attach_logger (logger::Logger &logger) const
	Attaches a logger to be used for printing. More...

std::unique_ptr< BaseStreamer >	attach_streamer (std::unique_ptr< BaseStreamer > streamer)
	Attach a streaming provider object, inherited from BaseStreamer, such as CheckpointStreamer. More...

size_t	attach_transport (const std::string &id, transport::TransportSettings &settings)
	Adds a built-in transport with the specified settings. More...

size_t	attach_transport (madara::transport::Base *transport)
	Attaches a transport to the Knowledge Engine. More...

template<typename Callable >
auto	cinvoke (const std::string &key, Callable &&callable, const KnowledgeReferenceSettings &settings=KnowledgeReferenceSettings()) const -> decltype(utility::invoke_(std::forward< Callable >(callable), std::declval< KnowledgeRecord & >()))

template<typename Callable >
auto	cinvoke (const VariableReference &key, Callable &&callable, const KnowledgeReferenceSettings &settings=KnowledgeReferenceSettings()) const -> decltype(utility::invoke_(std::forward< Callable >(callable), std::declval< KnowledgeRecord & >()))

void	clear (bool erase=false)
	Clears the knowledge base. More...

bool	clear (const std::string &key, const KnowledgeReferenceSettings &settings=KnowledgeReferenceSettings())
	Clears a variable. More...

void	clear_map (void)
	Clears the knowledge base. More...

void	clear_modifieds (void)
	Clear all modifications to the knowledge base. More...

void	clear_rules (void)
	Clears the permanent knowledge rules (unimplemented) More...

void	close_transport (void)
	Closes the transport mechanism so no dissemination is possible. More...

CompiledExpression	compile (const std::string &expression)
	Compiles a KaRL expression into an expression tree. More...

void	copy (const KnowledgeBaseImpl &source, const CopySet &copy_set=CopySet(), bool clean_copy=false, const EvalSettings &settings=EvalSettings())
	Copies variables and values from source to this context. More...

void	copy (const KnowledgeBaseImpl &source, const KnowledgeRequirements &reqs, const EvalSettings &settings=EvalSettings())
	Copies variables and values from source to this context. More...

std::string	debug_modifieds (void) const
	Retrieves a stringified list of all modified variables that are ready to send over transport on next send_modifieds call. More...

void	define_function (const std::string &name, boost::python::object callable)
	Defines a named python function. More...

void	define_function (const std::string &name, const CompiledExpression &expression)
	Defines a MADARA KaRL function. More...

void	define_function (const std::string &name, const std::string &expression)
	Defines a MADARA KaRL function. More...

void	define_function (const std::string &name, jobject callable)
	Defines a named python function. More...

void	define_function (const std::string &name, knowledge::KnowledgeRecord(func)(const char , FunctionArguments &, Variables &))
	Defines a named function that can distinguish the name it was called with in MADARA. More...

void	define_function (const std::string &name, knowledge::KnowledgeRecord(*func)(FunctionArguments &, Variables &))
	Defines a function. More...

madara::knowledge::KnowledgeRecord	evaluate (CompiledExpression &expression, const EvalSettings &settings)
	Evaluates an expression. More...

madara::knowledge::KnowledgeRecord	evaluate (const std::string &expression)
	Evaluates an expression. More...

madara::knowledge::KnowledgeRecord	evaluate (const std::string &expression, const EvalSettings &settings)
	Evaluates an expression. More...

madara::knowledge::KnowledgeRecord	evaluate (expression::ComponentNode *root, const EvalSettings &settings=EvalSettings())
	Evaluates a root-based tree (result of compile) More...

KnowledgeRecord	evaluate_file (CheckpointSettings &checkpoint_settings, const KnowledgeUpdateSettings &update_settings=KnowledgeUpdateSettings(true, true, true, false))
	Loads and evaluates a karl script from a file. More...

bool	exists (const std::string &key, const KnowledgeReferenceSettings &settings=KnowledgeReferenceSettings()) const
	Checks if a knowledge location exists in the context. More...

bool	exists (const VariableReference &variable, const KnowledgeReferenceSettings &settings=KnowledgeReferenceSettings(false)) const
	Checks if a knowledge variable exists in the context. More...

std::string	expand_statement (const std::string &statement) const
	Expands a statement using variable expansion. More...

std::string	file_to_string (CheckpointSettings &checkpoint_settings)
	Loads and returns a karl script from a file with encode/decode. More...

template<typename Func >
void	for_each (Func &&func) const
	Call given Callable on each element in this KB. More...

madara::knowledge::KnowledgeRecord	get (const std::string &key, const KnowledgeReferenceSettings &settings=KnowledgeReferenceSettings())
	Retrieves a knowledge value. More...

madara::knowledge::KnowledgeRecord	get (const VariableReference &variable, const KnowledgeReferenceSettings &settings=KnowledgeReferenceSettings())
	Atomically returns the value of a variable. More...

ThreadSafeContext &	get_context (void)
	Returns the ThreadSafeContext associated with this Knowledge Base. More...

std::string	get_id (void)
	Returns the unique host and ephemeral binding for this Knowlede Base. More...

int	get_log_level (void)
	Gets the log level. More...

logger::Logger &	get_logger (void) const
	Gets the logger used for information printing. More...

void	get_matches (const std::string &prefix, const std::string &suffix, VariableReferences &matches)
	Creates an iteration of VariableReferences to all keys matching the prefix and suffix. More...

size_t	get_num_transports (void)
	Gets the number of transports. More...

VariableReference	get_ref (const std::string &key, const KnowledgeReferenceSettings &settings=KnowledgeReferenceSettings())
	Atomically returns a reference to the variable. More...

template<typename Callable >
auto	invoke (const std::string &key, Callable &&callable, const EvalSettings &settings=EvalSettings()) -> decltype(utility::invoke_(std::forward< Callable >(callable), std::declval< KnowledgeRecord & >()))

template<typename Callable >
auto	invoke (const std::string &key, Callable &&callable, const KnowledgeReferenceSettings &settings=KnowledgeReferenceSettings()) const -> decltype(utility::invoke_(std::forward< Callable >(callable), std::declval< KnowledgeRecord & >()))

template<typename Callable >
auto	invoke (const VariableReference &key, Callable &&callable, const EvalSettings &settings=EvalSettings()) -> decltype(utility::invoke_(std::forward< Callable >(callable), std::declval< KnowledgeRecord & >()))

template<typename Callable >
auto	invoke (const VariableReference &key, Callable &&callable, const KnowledgeReferenceSettings &settings=KnowledgeReferenceSettings()) const -> decltype(utility::invoke_(std::forward< Callable >(callable), std::declval< KnowledgeRecord & >()))

int64_t	load_context (CheckpointSettings &checkpoint_settings, const KnowledgeUpdateSettings &update_settings=KnowledgeUpdateSettings(true, true, true, false))
	Loads the context from a file. More...

int64_t	load_context (const std::string &filename, bool use_id, const KnowledgeUpdateSettings &settings=KnowledgeUpdateSettings(true, true, true, false))
	Loads the context from a file. More...

int64_t	load_context (const std::string &filename, FileHeader &meta, bool use_id=true, const KnowledgeUpdateSettings &settings=KnowledgeUpdateSettings(true, true, true, false))
	Loads the context from a file. More...

void	lock (void)
	Locks the context to prevent updates over the network. More...

void	mark_modified (const std::string &name, const KnowledgeUpdateSettings &settings=KnowledgeUpdateSettings())
	Marks the variable as updated. More...

void	mark_modified (const VariableReference &variable, const KnowledgeUpdateSettings &settings=KnowledgeUpdateSettings())
	Marks the variable reference as updated. More...

void	print (const std::string &statement, unsigned int level) const
	Expands and prints a user provided statement at a logging level. More...

void	print (unsigned int level) const
	Prints all knowledge variables and values in the context. More...

int	read_file (const std::string &knowledge_key, const std::string &filename, const EvalSettings &settings=EvalSettings())
	Read a file into the knowledge base. More...

int	read_file (const VariableReference &variable, const std::string &filename, const EvalSettings &settings=EvalSettings())
	Atomically reads a file into a variable. More...

void	release (void)
	Releases a recursive lock on the knowledge base. More...

size_t	remove_transport (size_t index)
	Removes a transport. More...

void	reset_checkpoint (void) const
	Resets the local changed map, which tracks checkpointing modifieds. More...

madara::knowledge::KnowledgeRecord	retrieve_index (const std::string &key, size_t index, const KnowledgeReferenceSettings &settings=KnowledgeReferenceSettings())
	Retrieves a value at a specified index within a knowledge array. More...

madara::knowledge::KnowledgeRecord	retrieve_index (const VariableReference &variable, size_t index, const KnowledgeReferenceSettings &settings=KnowledgeReferenceSettings())
	Retrieves a value at a specified index within a knowledge array. More...

int64_t	save_as_json (const CheckpointSettings &settings) const
	Saves the context to a file as JSON. More...

int64_t	save_as_json (const std::string &filename) const
	Saves the context to a file as JSON. More...

int64_t	save_as_karl (const CheckpointSettings &settings) const
	Saves the context to a file as karl assignments, rather than binary. More...

int64_t	save_as_karl (const std::string &filename) const
	Saves the context to a file as karl assignments, rather than binary. More...

int64_t	save_checkpoint (CheckpointSettings &settings) const
	Saves a checkpoint of a list of changes to a file. More...

int64_t	save_checkpoint (const std::string &filename, bool reset_modifieds=true)
	Saves a checkpoint of a list of changes to a file. More...

int64_t	save_context (CheckpointSettings &settings) const
	Saves the context to a file. More...

int64_t	save_context (const std::string &filename) const
	Saves the context to a file. More...

VariableReferences	save_modifieds (void) const
	Saves the list of modified records to use later for resending. More...

MADARA_EXPORT int	send_modifieds (const std::string &prefix, const EvalSettings &settings=EvalSettings::SEND)
	Sends all modified variables through the attached transports. More...

template<typename K , typename V >
int	set (K &&key, const V *arr, size_t size, const EvalSettings &settings)

template<typename K , typename V >
int	set (K &&key, V &&val, const EvalSettings &settings)

int	set_file (const VariableReference &variable, const unsigned char *value, size_t size, const EvalSettings &settings=EvalSettings())
	Atomically sets the value of a variable to the contents of a file. More...

template<typename K , typename V >
int	set_index (K &&key, size_t i, V &&val, const EvalSettings &settings)

int	set_jpeg (const VariableReference &variable, const unsigned char *value, size_t size, const EvalSettings &settings=EvalSettings())
	Atomically sets the value of a variable to a JPEG image. More...

void	set_log_level (int level)
	Sets the log level. More...

void	set_quality (const std::string &key, uint32_t quality, const KnowledgeReferenceSettings &settings=KnowledgeReferenceSettings())
	Sets the quality of writing to a certain variable from this entity. More...

int	set_text (const VariableReference &variable, const char *value, size_t size, const EvalSettings &settings=EvalSettings())
	Atomically sets the value of a variable to a text file's contents. More...

int	set_xml (const VariableReference &variable, const char *value, size_t size, const EvalSettings &settings=EvalSettings())
	Atomically sets the value of a variable to an XML string. More...

std::string	setup_unique_hostport (std::string host="")
	Creates a random UUID for unique tie breakers in global ordering. More...

template<typename K >
std::shared_ptr< const std::vector< unsigned char > >	share_binary (K &&key, const KnowledgeReferenceSettings &settings=KnowledgeReferenceSettings()) const
	Returns a shared_ptr, sharing with the internal one. More...

template<typename K >
std::shared_ptr< const std::vector< double > >	share_doubles (K &&key, const KnowledgeReferenceSettings &settings=KnowledgeReferenceSettings()) const
	Returns a shared_ptr, sharing with the internal one. More...

template<typename K >
std::shared_ptr< const std::vector< KnowledgeRecord::Integer > >	share_integers (K &&key, const KnowledgeReferenceSettings &settings=KnowledgeReferenceSettings()) const
	Returns a shared_ptr, sharing with the internal one. More...

template<typename K >
std::shared_ptr< const std::string >	share_string (K &&key, const KnowledgeReferenceSettings &settings=KnowledgeReferenceSettings()) const
	Returns a shared_ptr, sharing with the internal one. More...

knowledge::KnowledgeMap	to_map (const std::string &prefix) const
	Creates a variable map with Knowledge Records that begin with the given prefix. More...

size_t	to_map (const std::string &prefix, const std::string &delimiter, const std::string &suffix, std::vector< std::string > &next_keys, std::map< std::string, knowledge::KnowledgeRecord > &result, bool just_keys)
	Fills a variable map with list of keys according to a matching prefix, suffix, and delimiter hierarchy. More...

size_t	to_map (const std::string &subject, std::map< std::string, knowledge::KnowledgeRecord > &target)
	Fills a variable map with Knowledge Records that match an expression. More...

knowledge::KnowledgeMap	to_map_stripped (const std::string &prefix) const
	Creates a map with Knowledge Records that begin with the given prefix. More...

void	to_string (std::string &target, const std::string &array_delimiter=",", const std::string &record_delimiter=";\n", const std::string &key_val_delimiter="=") const
	Saves all keys and values into a string, using the underlying knowledge::KnowledgeRecord::to_string function. More...

size_t	to_vector (const std::string &subject, unsigned int start, unsigned int end, std::vector< KnowledgeRecord > &target)
	Fills a vector with Knowledge Records that begin with a common subject and have a finite range of integer values. More...

madara::transport::TransportSettings &	transport_settings (void)
	Returns a non-const reference to the Transport Settings. More...

void	unlock (void)
	Unlocks the context to allow updates over the network (is only necessary if the context has been explicitly locked) More...

madara::knowledge::KnowledgeRecord	wait (CompiledExpression &expression, const WaitSettings &settings)
	Waits for an expression to be non-zero. More...

madara::knowledge::KnowledgeRecord	wait (const std::string &expression)
	Waits for an expression to be non-zero. More...

madara::knowledge::KnowledgeRecord	wait (const std::string &expression, const WaitSettings &settings)
	Waits for an expression to be non-zero. More...

void	wait_for_change (void)
	Wait for a change to happen to the context (e.g., from transports) More...

ssize_t	write_file (const std::string &knowledge_key, const std::string &filename)
	Write a file from the knowledge base to a specified location. More...

Private Member Functions
std::vector< std::shared_ptr< transport::Base > >	get_transports ()
	Atomically retrieve the set of transports. More...

Private Attributes
bool	done_sending_ = false

MADARA_LOCK_TYPE	done_sending_mutex_

std::string	id_

ThreadSafeContext	map_

MADARA_LOCK_TYPE	send_mutex_

transport::QoSTransportSettings	settings_

MADARA_LOCK_TYPE	transport_mutex_

std::vector< std::shared_ptr< transport::Base > >	transports_

Detailed Description

This class provides a distributed knowledge base implementation.

Definition at line 37 of file KnowledgeBaseImpl.h.

Constructor & Destructor Documentation

◆ KnowledgeBaseImpl() [1/4]

madara::knowledge::KnowledgeBaseImpl::KnowledgeBaseImpl ( )

inline

Constructor.

Definition at line 21 of file KnowledgeBaseImpl.inl.

◆ KnowledgeBaseImpl() [2/4]

madara::knowledge::KnowledgeBaseImpl::KnowledgeBaseImpl	(	const std::string &	host,
		int	transport
	)

inline

Constructor.

Parameters

host	hostname/ip of this machine
transport	transport to use for knowledge dissemination

Definition at line 26 of file KnowledgeBaseImpl.inl.

◆ KnowledgeBaseImpl() [3/4]

madara::knowledge::KnowledgeBaseImpl::KnowledgeBaseImpl	(	const std::string &	host,
		int	transport,
		const std::string &	domain
	)

inline

Constructor.

Parameters

host	hostname/ip of this machine
transport	transport to use for knowledge dissemination
domain	knowledge realm we want to join

Definition at line 37 of file KnowledgeBaseImpl.inl.

◆ KnowledgeBaseImpl() [4/4]

madara::knowledge::KnowledgeBaseImpl::KnowledgeBaseImpl	(	const std::string &	host,
		const madara::transport::TransportSettings &	config
	)

inline

Constructor.

Parameters

host	hostname/ip of this machine
config	transport settings to use for dissemination

Definition at line 49 of file KnowledgeBaseImpl.inl.

◆ ~KnowledgeBaseImpl()

madara::knowledge::KnowledgeBaseImpl::~KnowledgeBaseImpl ( )

inline

Destructor.

Definition at line 58 of file KnowledgeBaseImpl.inl.

Member Function Documentation

◆ acquire()

void madara::knowledge::KnowledgeBaseImpl::acquire ( void )

inline

Acquires the recursive lock on the knowledge base.

lock the underlying knowledge base against any updates until we release

This will block any other thread from updating or using the knowledge base until you call @ release.

Definition at line 310 of file KnowledgeBaseImpl.inl.

◆ activate_transport()

void madara::knowledge::KnowledgeBaseImpl::activate_transport ( void )

inline

Starts the transport mechanism for dissemination if it is closed.

Definition at line 205 of file KnowledgeBaseImpl.inl.

◆ add_modifieds()

void madara::knowledge::KnowledgeBaseImpl::add_modifieds ( const VariableReferences & modifieds ) const

inline

Adds a list of VariableReferences to the current modified list.

Parameters

modifieds a list of variables to add to modified list

Definition at line 650 of file KnowledgeBaseImpl.inl.

◆ apply_modified()

int madara::knowledge::KnowledgeBaseImpl::apply_modified ( const EvalSettings & settings = EvalSettings() )

inline

Applies current time and modified to all global variables and tries to send them.

Updates all global variables to current clock and then sends them if a transport is available.

Parameters

settings Settings for evaluating and printing

Returns: 0 if there was not a problem.

This is useful when trying to synchronize to late joiners (this process will resend all global variables.

Definition at line 137 of file KnowledgeBaseImpl.inl.

◆ attach_logger()

void madara::knowledge::KnowledgeBaseImpl::attach_logger ( logger::Logger & logger ) const

inline

Attaches a logger to be used for printing.

Parameters

logger the logger the context should lose

Definition at line 95 of file KnowledgeBaseImpl.inl.

◆ attach_streamer()

std::unique_ptr<BaseStreamer> madara::knowledge::KnowledgeBaseImpl::attach_streamer ( std::unique_ptr< BaseStreamer > streamer )

inline

Attach a streaming provider object, inherited from BaseStreamer, such as CheckpointStreamer.

Once attached, all updates to records in this ThreadSafeContext will be provided to the streamer. May pass nullptr to stop streaming.

Parameters

streamer the new streamer to attach

Returns: the old streamer, or nullptr if there wasn't any.

Definition at line 892 of file KnowledgeBaseImpl.h.

◆ attach_transport() [1/2]

size_t madara::knowledge::KnowledgeBaseImpl::attach_transport	(	const std::string &	id,
		transport::TransportSettings &	settings
	)

Adds a built-in transport with the specified settings.

Parameters

id	unique identifier for this agent (empty string will use default generated id)
settings	settings for the new transport

Returns: the number of transports now attached

Definition at line 73 of file KnowledgeBaseImpl.cpp.

◆ attach_transport() [2/2]

size_t madara::knowledge::KnowledgeBaseImpl::attach_transport ( madara::transport::Base * transport )

inline

Attaches a transport to the Knowledge Engine.

Note that the transport should use the same ThreadSafeContext as the Knowledge Engine.

Parameters

transport a new transport to attach to the Knowledge Base This class takes ownership of this pointer and will close and delete the transport as needed.

Returns: the number of transports now attached

Definition at line 387 of file KnowledgeBaseImpl.inl.

◆ cinvoke() [1/2]

template<typename Callable >

auto madara::knowledge::KnowledgeBaseImpl::cinvoke	(	const std::string &	key,
		Callable &&	callable,
		const KnowledgeReferenceSettings &	settings = `KnowledgeReferenceSettings()`
	)		const -> decltype(utility::invoke_( std::forward<Callable>(callable), std::declval<KnowledgeRecord&>()))

inline

Definition at line 1071 of file KnowledgeBaseImpl.h.

◆ cinvoke() [2/2]

template<typename Callable >

auto madara::knowledge::KnowledgeBaseImpl::cinvoke	(	const VariableReference &	key,
		Callable &&	callable,
		const KnowledgeReferenceSettings &	settings = `KnowledgeReferenceSettings()`
	)		const -> decltype(utility::invoke_( std::forward<Callable>(callable), std::declval<KnowledgeRecord&>()))

inline

Definition at line 1080 of file KnowledgeBaseImpl.h.

◆ clear() [1/2]

void madara::knowledge::KnowledgeBaseImpl::clear ( bool erase = false )

inline

Clears the knowledge base.

This is a very unsafe operation if erase is set to true. Setting erase to true could cause operations that were using the variable in CompiledExpression or VariableReference to fail catastrophically (e.g., illegal operation and segfaults) due to accessing memory that is no longer initialized. The absolute only reason you should ever set erase to true would be if you have absolutely no intention of using a CompiledExpression or VariableReference that had been previously accessing the memory, and that includes all of the knowledge::containers classes also!

Parameters

erase If true, completely erase keys. If false, reset knowledge

Definition at line 298 of file KnowledgeBaseImpl.inl.

◆ clear() [2/2]

bool madara::knowledge::KnowledgeBaseImpl::clear	(	const std::string &	key,
		const KnowledgeReferenceSettings &	settings = `KnowledgeReferenceSettings()`
	)

inline

Clears a variable.

This is safer than erasing the variable. It clears the memory used in the variable and marks it as UNCREATED, meaning that it is effectively deleted, will not show up in

See also: print statements or; save_checkpoint.

Parameters

key	unique identifier of the variable
settings	settings for referring to variables

Returns: true if variable exists

Definition at line 292 of file KnowledgeBaseImpl.inl.

◆ clear_map()

void madara::knowledge::KnowledgeBaseImpl::clear_map ( void )

inline

Clears the knowledge base.

Definition at line 303 of file KnowledgeBaseImpl.inl.

◆ clear_modifieds()

void madara::knowledge::KnowledgeBaseImpl::clear_modifieds ( void )

inline

Clear all modifications to the knowledge base.

This action may be useful if you are wanting to keep local changes but not inform other agents (possibly due to a need to further process and verify the information). The knowledge stays in its current form (i.e., this does not roll back state or anything like that)

Definition at line 540 of file KnowledgeBaseImpl.inl.

◆ clear_rules()

void madara::knowledge::KnowledgeBaseImpl::clear_rules ( void )

Clears the permanent knowledge rules (unimplemented)

◆ close_transport()

void madara::knowledge::KnowledgeBaseImpl::close_transport ( void )

Closes the transport mechanism so no dissemination is possible.

Definition at line 195 of file KnowledgeBaseImpl.cpp.

◆ compile()

CompiledExpression madara::knowledge::KnowledgeBaseImpl::compile ( const std::string & expression )

Compiles a KaRL expression into an expression tree.

Parameters

expression expression to compile

Returns: compiled, optimized expression tree

Exceptions

exceptions::KarlException failure during compile/evaluate

Definition at line 216 of file KnowledgeBaseImpl.cpp.

◆ copy() [1/2]

void madara::knowledge::KnowledgeBaseImpl::copy	(	const KnowledgeBaseImpl &	source,
		const CopySet &	copy_set = `CopySet()`,
		bool	clean_copy = `false`,
		const EvalSettings &	settings = `EvalSettings()`
	)

inline

Copies variables and values from source to this context.

PERFORMANCE NOTES: worst case depends on size of copy_set. If empty, performance is always O (n), where n is number of variables in the source context. If copy_set is not empty, then performance is O (m log n) where m is the number of variables in copy_set and n is number of variables in the source context.

Note that this is a deep copy due to the fact that source and destination are expected to have their own thread management (ref-counted variables can be problematic if shallow copy).

Parameters

source	the source knowledge base to copy from
copy_set	a map of variables that should be copied. If empty, then everything is copied. If not empty, only the supplied variables will be copied.
clean_copy	if true, clear the destination context (this) before copying.
settings	settings for appplying updates to context

Definition at line 229 of file KnowledgeBaseImpl.inl.

◆ copy() [2/2]

void madara::knowledge::KnowledgeBaseImpl::copy	(	const KnowledgeBaseImpl &	source,
		const KnowledgeRequirements &	reqs,
		const EvalSettings &	settings = `EvalSettings()`
	)

inline

Copies variables and values from source to this context.

PERFORMANCE NOTES: predicates with prefixes can limit copying to O(log n). predices with suffixes and no prefix force O(n) copy cost since all records could fit requirements

Parameters

source	the source context to copy from
reqs	requirements that must be met
settings	settings for appplying updates to context

Definition at line 222 of file KnowledgeBaseImpl.inl.

◆ debug_modifieds()

std::string madara::knowledge::KnowledgeBaseImpl::debug_modifieds ( void ) const

inline

Retrieves a stringified list of all modified variables that are ready to send over transport on next send_modifieds call.

Returns: stringified list of the modified knowledge records

Definition at line 85 of file KnowledgeBaseImpl.inl.

◆ define_function() [1/6]

void madara::knowledge::KnowledgeBaseImpl::define_function	(	const std::string &	name,
		boost::python::object	callable
	)

inline

Defines a named python function.

Parameters

name	name of the function
callable	external python function to call with this name

Definition at line 347 of file KnowledgeBaseImpl.inl.

◆ define_function() [2/6]

void madara::knowledge::KnowledgeBaseImpl::define_function	(	const std::string &	name,
		const CompiledExpression &	expression
	)

inline

Defines a MADARA KaRL function.

Parameters

name	name of the function
expression	KaRL function body

Definition at line 364 of file KnowledgeBaseImpl.inl.

◆ define_function() [3/6]

void madara::knowledge::KnowledgeBaseImpl::define_function	(	const std::string &	name,
		const std::string &	expression
	)

inline

Defines a MADARA KaRL function.

Parameters

name	name of the function
expression	KaRL function body

Definition at line 358 of file KnowledgeBaseImpl.inl.

◆ define_function() [4/6]

void madara::knowledge::KnowledgeBaseImpl::define_function	(	const std::string &	name,
		jobject	callable
	)

inline

Defines a named python function.

Parameters

name	name of the function
callable	external java object to call with this name

Definition at line 338 of file KnowledgeBaseImpl.inl.

◆ define_function() [5/6]

void madara::knowledge::KnowledgeBaseImpl::define_function	(	const std::string &	name,
		knowledge::KnowledgeRecord()(const char , FunctionArguments &, Variables &)	func
	)

inline

Defines a named function that can distinguish the name it was called with in MADARA.

Parameters

name	name of the function
func	external function to call with this name

Definition at line 331 of file KnowledgeBaseImpl.inl.

◆ define_function() [6/6]

void madara::knowledge::KnowledgeBaseImpl::define_function	(	const std::string &	name,
		knowledge::KnowledgeRecord(*)(FunctionArguments &, Variables &)	func
	)

inline

Defines a function.

Parameters

name	name of the function
func	external function to call with this name

Definition at line 324 of file KnowledgeBaseImpl.inl.

◆ evaluate() [1/4]

KnowledgeRecord madara::knowledge::KnowledgeBaseImpl::evaluate	(	CompiledExpression &	expression,
		const EvalSettings &	settings
	)

Evaluates an expression.

Parameters

expression	KaRL expression to evaluate (result of compile)
settings	Settings for evaluating and printing

Returns: value of expression

Exceptions

exceptions::KarlException failure during compile/evaluate

Definition at line 321 of file KnowledgeBaseImpl.cpp.

◆ evaluate() [2/4]

KnowledgeRecord madara::knowledge::KnowledgeBaseImpl::evaluate ( const std::string & expression )

inline

Evaluates an expression.

Always disseminates modifications.

Parameters

expression KaRL expression to evaluate

Returns: value of expression

Exceptions

exceptions::KarlException failure during compile/evaluate

Definition at line 377 of file KnowledgeBaseImpl.inl.

◆ evaluate() [3/4]

KnowledgeRecord madara::knowledge::KnowledgeBaseImpl::evaluate	(	const std::string &	expression,
		const EvalSettings &	settings
	)

inline

Evaluates an expression.

Parameters

expression	KaRL expression to evaluate
settings	Settings for evaluating and printing

Returns: value of expression

Exceptions

exceptions::KarlException failure during compile/evaluate

Definition at line 668 of file KnowledgeBaseImpl.inl.

◆ evaluate() [4/4]

KnowledgeRecord madara::knowledge::KnowledgeBaseImpl::evaluate	(	expression::ComponentNode *	root,
		const EvalSettings &	settings = `EvalSettings()`
	)

Evaluates a root-based tree (result of compile)

Parameters

root	root-based tree
settings	Settings for evaluating and printing

Returns: value of expression

Exceptions

exceptions::KarlException failure during compile/evaluate

Definition at line 358 of file KnowledgeBaseImpl.cpp.

◆ evaluate_file()

madara::knowledge::KnowledgeRecord madara::knowledge::KnowledgeBaseImpl::evaluate_file	(	CheckpointSettings &	checkpoint_settings,
		const KnowledgeUpdateSettings &	update_settings = `KnowledgeUpdateSettings( true, true, true, false)`
	)

inline

Loads and evaluates a karl script from a file.

Parameters

checkpoint_settings	checkpoint settings to load
update_settings	settings for applying the updates

Returns: result of evaluation

Exceptions

exceptions::MemoryException not enough buffer to encode

Definition at line 623 of file KnowledgeBaseImpl.inl.

◆ exists() [1/2]

bool madara::knowledge::KnowledgeBaseImpl::exists	(	const std::string &	key,
		const KnowledgeReferenceSettings &	settings = `KnowledgeReferenceSettings()`
	)		const

inline

Checks if a knowledge location exists in the context.

Parameters

key	knowledge variable location
settings	settings for referring to knowledge variables

Returns: true if location has been set

Definition at line 119 of file KnowledgeBaseImpl.inl.

◆ exists() [2/2]

bool madara::knowledge::KnowledgeBaseImpl::exists	(	const VariableReference &	variable,
		const KnowledgeReferenceSettings &	settings = `KnowledgeReferenceSettings( false)`
	)		const

inline

Checks if a knowledge variable exists in the context.

Parameters

variable	knowledge variable reference
settings	settings for referring to knowledge variables

Returns: true if location has been set

Definition at line 125 of file KnowledgeBaseImpl.inl.

◆ expand_statement()

std::string madara::knowledge::KnowledgeBaseImpl::expand_statement ( const std::string & statement ) const

inline

Expands a statement using variable expansion.

For example, if the statement were MyKnowledge.{.id}, and .id==1, then the statement would be expanded to MyKnowledge.1

Parameters

statement statement to expand

Returns: expanded statement

Definition at line 246 of file KnowledgeBaseImpl.inl.

◆ file_to_string()

std::string madara::knowledge::KnowledgeBaseImpl::file_to_string ( CheckpointSettings & checkpoint_settings )

inline

Loads and returns a karl script from a file with encode/decode.

Parameters

checkpoint_settings checkpoint settings to load

Exceptions

exceptions::MemoryException not enough buffer to encode

Definition at line 644 of file KnowledgeBaseImpl.inl.

◆ for_each()

template<typename Func >

void madara::knowledge::KnowledgeBaseImpl::for_each ( Func && func ) const

inline

Call given Callable on each element in this KB.

Note that the context will be locked for the entire duration of this iteration. The Callable must accept one argument, a const std::pair<const std::string, KnowledgeRecord>&, and it's return value is ignored.

Template Parameters

Func	a callable type as described above

Parameters

func	the callable object; either function pointer or functor

Definition at line 1098 of file KnowledgeBaseImpl.h.

◆ get() [1/2]

KnowledgeRecord madara::knowledge::KnowledgeBaseImpl::get	(	const std::string &	key,
		const KnowledgeReferenceSettings &	settings = `KnowledgeReferenceSettings()`
	)

inline

Retrieves a knowledge value.

Parameters

key	knowledge location
settings	settings for referring to knowledge variables

Returns: value at knowledge location

Definition at line 62 of file KnowledgeBaseImpl.inl.

◆ get() [2/2]

KnowledgeRecord madara::knowledge::KnowledgeBaseImpl::get	(	const VariableReference &	variable,
		const KnowledgeReferenceSettings &	settings = `KnowledgeReferenceSettings()`
	)

inline

Atomically returns the value of a variable.

Parameters

variable reference to a variable (

See also: get_ref)

Parameters

settings the settings for referring to variables

Returns: the madara::knowledge::KnowledgeRecord::Integer value for the variable

Definition at line 68 of file KnowledgeBaseImpl.inl.

◆ get_context()

ThreadSafeContext & madara::knowledge::KnowledgeBaseImpl::get_context ( void )

inline

Returns the ThreadSafeContext associated with this Knowledge Base.

This is necessary for creating custom transports.

Returns: the context used by the knowledge base

Definition at line 433 of file KnowledgeBaseImpl.inl.

◆ get_id()

std::string madara::knowledge::KnowledgeBaseImpl::get_id ( void )

inline

Returns the unique host and ephemeral binding for this Knowlede Base.

Returns: host:port identifier for this knowledge base

Definition at line 442 of file KnowledgeBaseImpl.inl.

◆ get_log_level()

int madara::knowledge::KnowledgeBaseImpl::get_log_level ( void )

inline

Gets the log level.

Returns: the maximum detail level to print

Definition at line 80 of file KnowledgeBaseImpl.inl.

◆ get_logger()

madara::logger::Logger & madara::knowledge::KnowledgeBaseImpl::get_logger ( void ) const

inline

Gets the logger used for information printing.

Returns: the context's logger

Definition at line 90 of file KnowledgeBaseImpl.inl.

◆ get_matches()

void madara::knowledge::KnowledgeBaseImpl::get_matches	(	const std::string &	prefix,
		const std::string &	suffix,
		VariableReferences &	matches
	)

inline

Creates an iteration of VariableReferences to all keys matching the prefix and suffix.

Parameters

prefix	string that the key must start with
suffix	string that the key must end with
matches	all VariableReferences matching the prefix and suffix

Definition at line 472 of file KnowledgeBaseImpl.inl.

◆ get_num_transports()

size_t madara::knowledge::KnowledgeBaseImpl::get_num_transports ( void )

inline

Gets the number of transports.

Returns: the number of transports

Definition at line 395 of file KnowledgeBaseImpl.inl.

◆ get_ref()

VariableReference madara::knowledge::KnowledgeBaseImpl::get_ref	(	const std::string &	key,
		const KnowledgeReferenceSettings &	settings = `KnowledgeReferenceSettings()`
	)

inline

Atomically returns a reference to the variable.

Variable references are efficient mechanisms for reference variables individually–similar to speedups seen from CompiledExpression.

Parameters

key	unique identifier of the variable
settings	settings for referring to knowledge variables

Returns: reference to the variable in the context

Definition at line 74 of file KnowledgeBaseImpl.inl.

◆ get_transports()

std::vector<std::shared_ptr<transport::Base> > madara::knowledge::KnowledgeBaseImpl::get_transports ( )

inlineprivate

Atomically retrieve the set of transports.

Definition at line 1117 of file KnowledgeBaseImpl.h.

◆ invoke() [1/4]

template<typename Callable >

auto madara::knowledge::KnowledgeBaseImpl::invoke	(	const std::string &	key,
		Callable &&	callable,
		const EvalSettings &	settings = `EvalSettings()`
	)		-> decltype(utility::invoke_( std::forward<Callable>(callable), std::declval<KnowledgeRecord&>()))

inline

Definition at line 1033 of file KnowledgeBaseImpl.h.

◆ invoke() [2/4]

template<typename Callable >

auto madara::knowledge::KnowledgeBaseImpl::invoke	(	const std::string &	key,
		Callable &&	callable,
		const KnowledgeReferenceSettings &	settings = `KnowledgeReferenceSettings()`
	)		const -> decltype(utility::invoke_( std::forward<Callable>(callable), std::declval<KnowledgeRecord&>()))

inline

Definition at line 1053 of file KnowledgeBaseImpl.h.

◆ invoke() [3/4]

template<typename Callable >

auto madara::knowledge::KnowledgeBaseImpl::invoke	(	const VariableReference &	key,
		Callable &&	callable,
		const EvalSettings &	settings = `EvalSettings()`
	)		-> decltype(utility::invoke_( std::forward<Callable>(callable), std::declval<KnowledgeRecord&>()))

inline

Definition at line 1043 of file KnowledgeBaseImpl.h.

◆ invoke() [4/4]

template<typename Callable >

auto madara::knowledge::KnowledgeBaseImpl::invoke	(	const VariableReference &	key,
		Callable &&	callable,
		const KnowledgeReferenceSettings &	settings = `KnowledgeReferenceSettings()`
	)		const -> decltype(utility::invoke_( std::forward<Callable>(callable), std::declval<KnowledgeRecord&>()))

inline

Definition at line 1062 of file KnowledgeBaseImpl.h.

◆ load_context() [1/3]

int64_t madara::knowledge::KnowledgeBaseImpl::load_context	(	CheckpointSettings &	checkpoint_settings,
		const KnowledgeUpdateSettings &	update_settings = `KnowledgeUpdateSettings( true, true, true, false)`
	)

inline

Loads the context from a file.

Parameters

checkpoint_settings	checkpoint settings to load
update_settings	settings for applying the updates

Returns: -1 if file open failed
-2 if file read failed
>0 if successful (number of bytes written)

Exceptions

exceptions::MemoryException not enough buffer to encode

Definition at line 602 of file KnowledgeBaseImpl.inl.

◆ load_context() [2/3]

int64_t madara::knowledge::KnowledgeBaseImpl::load_context	(	const std::string &	filename,
		bool	use_id,
		const KnowledgeUpdateSettings &	settings = `KnowledgeUpdateSettings( true, true, true, false)`
	)

inline

Loads the context from a file.

Parameters

filename	name of the file to open
use_id	if true, sets the unique identifier to the one found in the saved context. If false, keeps the default identifier.
settings	settings for modifying context

Exceptions

exceptions::MemoryException not enough buffer to encode

Returns: total bytes read

Definition at line 568 of file KnowledgeBaseImpl.inl.

◆ load_context() [3/3]

int64_t madara::knowledge::KnowledgeBaseImpl::load_context	(	const std::string &	filename,
		FileHeader &	meta,
		bool	use_id = `true`,
		const KnowledgeUpdateSettings &	settings = `KnowledgeUpdateSettings( true, true, true, false)`
	)

inline

Loads the context from a file.

Parameters

filename	name of the file to open
meta	a file header that will contain metadata such as originator, timestamp, lamport clock, etc.
use_id	if true, sets the unique identifier to the one found in the saved context. If false, keeps the default identifier.
settings	settings for applying the update

Returns: -1 if file open failed
-2 if file read failed
>0 if successful (number of bytes written)

Exceptions

exceptions::MemoryException not enough buffer to encode

Definition at line 584 of file KnowledgeBaseImpl.inl.

◆ lock()

void madara::knowledge::KnowledgeBaseImpl::lock ( void )

inline

Locks the context to prevent updates over the network.

Definition at line 236 of file KnowledgeBaseImpl.inl.

◆ mark_modified() [1/2]

void madara::knowledge::KnowledgeBaseImpl::mark_modified	(	const std::string &	name,
		const KnowledgeUpdateSettings &	settings = `KnowledgeUpdateSettings()`
	)

inline

Marks the variable as updated.

Parameters

name	name of the variable
settings	settings for applying the update

Definition at line 152 of file KnowledgeBaseImpl.inl.

◆ mark_modified() [2/2]

void madara::knowledge::KnowledgeBaseImpl::mark_modified	(	const VariableReference &	variable,
		const KnowledgeUpdateSettings &	settings = `KnowledgeUpdateSettings()`
	)

inline

Marks the variable reference as updated.

Parameters

variable reference to a variable (

See also: get_ref)

Parameters

settings settings for applying the update

Definition at line 146 of file KnowledgeBaseImpl.inl.

◆ print() [1/2]

void madara::knowledge::KnowledgeBaseImpl::print	(	const std::string &	statement,
		unsigned int	level
	)		const

inline

Expands and prints a user provided statement at a logging level.

For example, if the statement were MyKnowledge.{.id}, and .id==1, then the statement would be expanded to MyKnowledge.1

Parameters

statement	statement to expand with variable values
level	level to log the knowledge at

Definition at line 286 of file KnowledgeBaseImpl.inl.

◆ print() [2/2]

void madara::knowledge::KnowledgeBaseImpl::print ( unsigned int level ) const

inline

Prints all knowledge variables and values in the context.

Parameters

level level to log the knowledge at

Definition at line 272 of file KnowledgeBaseImpl.inl.

◆ read_file() [1/2]

int madara::knowledge::KnowledgeBaseImpl::read_file	(	const std::string &	knowledge_key,
		const std::string &	filename,
		const EvalSettings &	settings = `EvalSettings()`
	)

inline

Read a file into the knowledge base.

Parameters

filename	file to read
knowledge_key	key to store the file into
settings	settings for updating/evaluating

Returns: -1 if unsuccessful, 0 otherwise

Definition at line 159 of file KnowledgeBaseImpl.inl.

◆ read_file() [2/2]

int madara::knowledge::KnowledgeBaseImpl::read_file	(	const VariableReference &	variable,
		const std::string &	filename,
		const EvalSettings &	settings = `EvalSettings()`
	)

inline

Atomically reads a file into a variable.

Read a file into the knowledge base.

Parameters

variable reference to a variable (

See also: get_ref)

Parameters

filename	file to read
settings	settings for applying the update

Returns: 0 if the value was set. -1 if unsuccessful

Definition at line 195 of file KnowledgeBaseImpl.inl.

◆ release()

void madara::knowledge::KnowledgeBaseImpl::release ( void )

inline

Releases a recursive lock on the knowledge base.

release the lock on the underlying knowledge base

This will allow other thread to access the knowledge base if you had previously called @ acquire.

Definition at line 316 of file KnowledgeBaseImpl.inl.

◆ remove_transport()

size_t madara::knowledge::KnowledgeBaseImpl::remove_transport ( size_t index )

inline

Removes a transport.

Parameters

index index of the transport to remove. If invalid, nothing is removed.

Returns: the size of transports now attached

Definition at line 402 of file KnowledgeBaseImpl.inl.

◆ reset_checkpoint()

void madara::knowledge::KnowledgeBaseImpl::reset_checkpoint ( void ) const

inline

Resets the local changed map, which tracks checkpointing modifieds.

Definition at line 545 of file KnowledgeBaseImpl.inl.

◆ retrieve_index() [1/2]

KnowledgeRecord madara::knowledge::KnowledgeBaseImpl::retrieve_index	(	const std::string &	key,
		size_t	index,
		const KnowledgeReferenceSettings &	settings = `KnowledgeReferenceSettings()`
	)

inline

Retrieves a value at a specified index within a knowledge array.

Parameters

key	knowledge location
index	index within the array
settings	settings for referring to knowledge variables

Returns: value at knowledge location

Definition at line 105 of file KnowledgeBaseImpl.inl.

◆ retrieve_index() [2/2]

KnowledgeRecord madara::knowledge::KnowledgeBaseImpl::retrieve_index	(	const VariableReference &	variable,
		size_t	index,
		const KnowledgeReferenceSettings &	settings = `KnowledgeReferenceSettings()`
	)

inline

Retrieves a value at a specified index within a knowledge array.

Parameters

variable reference to a variable (

See also: get_ref)

Parameters

index	index within the array
settings	settings for referring to knowledge variables

Returns: value at knowledge location

Definition at line 112 of file KnowledgeBaseImpl.inl.

◆ save_as_json() [1/2]

int64_t madara::knowledge::KnowledgeBaseImpl::save_as_json ( const CheckpointSettings & settings ) const

inline

Saves the context to a file as JSON.

Parameters

settings the settings to save

Returns: total bytes written

Definition at line 522 of file KnowledgeBaseImpl.inl.

◆ save_as_json() [2/2]

int64_t madara::knowledge::KnowledgeBaseImpl::save_as_json ( const std::string & filename ) const

inline

Saves the context to a file as JSON.

Parameters

filename name of the file to save to

Returns: total bytes written

Definition at line 516 of file KnowledgeBaseImpl.inl.

◆ save_as_karl() [1/2]

int64_t madara::knowledge::KnowledgeBaseImpl::save_as_karl ( const CheckpointSettings & settings ) const

inline

Saves the context to a file as karl assignments, rather than binary.

Parameters

settings the settings to save

Returns: total bytes written

Definition at line 534 of file KnowledgeBaseImpl.inl.

◆ save_as_karl() [2/2]

int64_t madara::knowledge::KnowledgeBaseImpl::save_as_karl ( const std::string & filename ) const

inline

Saves the context to a file as karl assignments, rather than binary.

Parameters

filename name of the file to save to

Returns: total bytes written

Definition at line 528 of file KnowledgeBaseImpl.inl.

◆ save_checkpoint() [1/2]

int64_t madara::knowledge::KnowledgeBaseImpl::save_checkpoint ( CheckpointSettings & settings ) const

inline

Saves a checkpoint of a list of changes to a file.

Parameters

settings checkpoint settings to load

Returns: -1 if file open failed
-2 if file write failed
>0 if successful (number of bytes written)

Exceptions

exceptions::MemoryException not enough buffer to encode

Definition at line 561 of file KnowledgeBaseImpl.inl.

◆ save_checkpoint() [2/2]

int64_t madara::knowledge::KnowledgeBaseImpl::save_checkpoint	(	const std::string &	filename,
		bool	reset_modifieds = `true`
	)

inline

Saves a checkpoint of a list of changes to a file.

Parameters

filename	name of the file to open
reset_modifieds	if true, resets the modified list to empty.

Returns: total bytes written

Exceptions

exceptions::MemoryException not enough buffer to encode

Definition at line 550 of file KnowledgeBaseImpl.inl.

◆ save_context() [1/2]

int64_t madara::knowledge::KnowledgeBaseImpl::save_context ( CheckpointSettings & settings ) const

inline

Saves the context to a file.

Parameters

settings the settings to save

Returns: -1 if file open failed
-2 if file write failed
>0 if successful (number of bytes written)

Exceptions

exceptions::MemoryException not enough buffer to encode

Definition at line 509 of file KnowledgeBaseImpl.inl.

◆ save_context() [2/2]

int64_t madara::knowledge::KnowledgeBaseImpl::save_context ( const std::string & filename ) const

inline

Saves the context to a file.

Parameters

filename name of the file to open

Returns: total bytes written

Exceptions

exceptions::MemoryException not enough buffer to encode

Definition at line 503 of file KnowledgeBaseImpl.inl.

◆ save_modifieds()

VariableReferences madara::knowledge::KnowledgeBaseImpl::save_modifieds ( void ) const

inline

Saves the list of modified records to use later for resending.

This does not clear the modified list. This feature is useful if you want to remember what has been modified and then resend later, e.g., if you believe packets may be dropped and want to resend information. Use this function in conjunction with

See also: add_modifieds to remodify

Returns: a vector of VariableReferences to the current modified list

Definition at line 656 of file KnowledgeBaseImpl.inl.

◆ send_modifieds()

int madara::knowledge::KnowledgeBaseImpl::send_modifieds	(	const std::string &	prefix,
		const EvalSettings &	settings = `EvalSettings::SEND`
	)

Sends all modified variables through the attached transports.

Parameters

prefix	for logging purposes, the descriptor prefix for calling method
settings	settings for sending modifications

Returns: number of transports the modifications were sent to

Definition at line 396 of file KnowledgeBaseImpl.cpp.

◆ set() [1/2]

template<typename K , typename V >

int madara::knowledge::KnowledgeBaseImpl::set	(	K &&	key,
		const V *	arr,
		size_t	size,
		const EvalSettings &	settings
	)

inline

Definition at line 483 of file KnowledgeBaseImpl.h.

◆ set() [2/2]

template<typename K , typename V >

int madara::knowledge::KnowledgeBaseImpl::set	(	K &&	key,
		V &&	val,
		const EvalSettings &	settings
	)

inline

Definition at line 462 of file KnowledgeBaseImpl.h.

◆ set_file()

int madara::knowledge::KnowledgeBaseImpl::set_file	(	const VariableReference &	variable,
		const unsigned char *	value,
		size_t	size,
		const EvalSettings &	settings = `EvalSettings()`
	)

inline

Atomically sets the value of a variable to the contents of a file.

Read a file into the knowledge base.

Parameters

variable reference to a variable (

See also: get_ref)

Parameters

value	new value of the variable
size	indicates the size of the value buffer
settings	settings for applying the update

Returns: 0 if the value was set. -1 if null key

Definition at line 173 of file KnowledgeBaseImpl.inl.

◆ set_index()

template<typename K , typename V >

int madara::knowledge::KnowledgeBaseImpl::set_index	(	K &&	key,
		size_t	i,
		V &&	val,
		const EvalSettings &	settings
	)

inline

Definition at line 472 of file KnowledgeBaseImpl.h.

◆ set_jpeg()

int madara::knowledge::KnowledgeBaseImpl::set_jpeg	(	const VariableReference &	variable,
		const unsigned char *	value,
		size_t	size,
		const EvalSettings &	settings = `EvalSettings()`
	)

inline

Atomically sets the value of a variable to a JPEG image.

Read a file into the knowledge base.

Parameters

variable reference to a variable (

See also: get_ref)

Parameters

value	new value of the variable
size	indicates the size of the value buffer
settings	settings for applying the update

Returns: 0 if the value was set. -1 if null key

Definition at line 184 of file KnowledgeBaseImpl.inl.

◆ set_log_level()

void madara::knowledge::KnowledgeBaseImpl::set_log_level ( int level )

inline

Sets the log level.

Parameters

level the maximum detail level to print

Definition at line 100 of file KnowledgeBaseImpl.inl.

◆ set_quality()

void madara::knowledge::KnowledgeBaseImpl::set_quality	(	const std::string &	key,
		uint32_t	quality,
		const KnowledgeReferenceSettings &	settings = `KnowledgeReferenceSettings()`
	)

inline

Sets the quality of writing to a certain variable from this entity.

Set quality of writing to a variable.

Parameters

key	knowledge variable location
quality	quality of writing to this location
settings	settings for referring to knowledge variables

Definition at line 260 of file KnowledgeBaseImpl.inl.

◆ set_text()

int madara::knowledge::KnowledgeBaseImpl::set_text	(	const VariableReference &	variable,
		const char *	value,
		size_t	size,
		const EvalSettings &	settings = `EvalSettings()`
	)

Atomically sets the value of a variable to a text file's contents.

Parameters

variable reference to a variable (

See also: get_ref)

Parameters

value	new value of the variable
size	indicates the size of the value buffer
settings	settings for applying the update

Returns: 0 if the value was set. -1 if null key

◆ set_xml()

int madara::knowledge::KnowledgeBaseImpl::set_xml	(	const VariableReference &	variable,
		const char *	value,
		size_t	size,
		const EvalSettings &	settings = `EvalSettings()`
	)

Atomically sets the value of a variable to an XML string.

Parameters

variable reference to a variable (

See also: get_ref)

Parameters

value	new value of the variable
size	indicates the size of the value buffer
settings	settings for applying the update

Returns: 0 if the value was set. -1 if null key

◆ setup_unique_hostport()

std::string madara::knowledge::KnowledgeBaseImpl::setup_unique_hostport ( std::string host = "" )

Creates a random UUID for unique tie breakers in global ordering.

Call this function if you want to generate a unique id for a custom transport to use (or a built-in transport if you are creating one outside of the KnowledgeBase.

Parameters

host	host identifier string (defaults to local hostname if "")

Returns: unique host id

Definition at line 38 of file KnowledgeBaseImpl.cpp.

◆ share_binary()

template<typename K >

std::shared_ptr<const std::vector<unsigned char> > madara::knowledge::KnowledgeBaseImpl::share_binary	(	K &&	key,
		const KnowledgeReferenceSettings &	settings = `KnowledgeReferenceSettings()`
	)		const

inline

Returns a shared_ptr, sharing with the internal one.

If this record is not a binary files, returns NULL shared_ptr

Definition at line 212 of file KnowledgeBaseImpl.h.

◆ share_doubles()

template<typename K >

std::shared_ptr<const std::vector<double> > madara::knowledge::KnowledgeBaseImpl::share_doubles	(	K &&	key,
		const KnowledgeReferenceSettings &	settings = `KnowledgeReferenceSettings()`
	)		const

inline

Returns a shared_ptr, sharing with the internal one.

If this record is not a doubles array, returns NULL shared_ptr

Definition at line 200 of file KnowledgeBaseImpl.h.

◆ share_integers()

template<typename K >

std::shared_ptr<const std::vector<KnowledgeRecord::Integer> > madara::knowledge::KnowledgeBaseImpl::share_integers	(	K &&	key,
		const KnowledgeReferenceSettings &	settings = `KnowledgeReferenceSettings()`
	)		const

inline

Returns a shared_ptr, sharing with the internal one.

If this record is not an integer array, returns NULL shared_ptr

Definition at line 188 of file KnowledgeBaseImpl.h.

◆ share_string()

template<typename K >

std::shared_ptr<const std::string> madara::knowledge::KnowledgeBaseImpl::share_string	(	K &&	key,
		const KnowledgeReferenceSettings &	settings = `KnowledgeReferenceSettings()`
	)		const

inline

Returns a shared_ptr, sharing with the internal one.

If this record is not a string, returns NULL shared_ptr

Definition at line 176 of file KnowledgeBaseImpl.h.

◆ to_map() [1/3]

KnowledgeMap madara::knowledge::KnowledgeBaseImpl::to_map ( const std::string & prefix ) const

inline

Creates a variable map with Knowledge Records that begin with the given prefix.

Runs in O(log n + m) time, where n is the size of the KnowledgeBase, and m is the number of matching records

Parameters

prefix Prefix string to match with

Returns: A new map with just entries starting with prefix

Definition at line 492 of file KnowledgeBaseImpl.inl.

◆ to_map() [2/3]

size_t madara::knowledge::KnowledgeBaseImpl::to_map	(	const std::string &	prefix,
		const std::string &	delimiter,
		const std::string &	suffix,
		std::vector< std::string > &	next_keys,
		std::map< std::string, knowledge::KnowledgeRecord > &	result,
		bool	just_keys
	)

inline

Fills a variable map with list of keys according to a matching prefix, suffix, and delimiter hierarchy.

This is useful for understanding the logical hierarchy of your variables (and also a key utility of containers like

See also: containers::FlexMap).

Parameters

prefix	Text that must be present at the front of the key
delimiter	Text that signifies a logical boundary in hierarchy If empty, no check is performed.
suffix	Text that must be present at the end of the key. If empty, no check is performed.
next_keys	The immediate keys in the hierarchy after prefix
result	The map that will be filled with full variable names and the Knowledge Records that correspond to
just_keys	if true, do not fill result, only next_keys.

Returns: entries in the resulting map

Definition at line 484 of file KnowledgeBaseImpl.inl.

◆ to_map() [3/3]

size_t madara::knowledge::KnowledgeBaseImpl::to_map	(	const std::string &	subject,
		std::map< std::string, knowledge::KnowledgeRecord > &	target
	)

inline

Fills a variable map with Knowledge Records that match an expression.

At the moment, this expression must be of the form "subject*"

Parameters

subject	An expression that matches the variable names that are of interest. Wildcards may only be at the end.
target	The map that will be filled with variable names and the Knowledge Records they correspond to

Returns: entries in the resulting map

Definition at line 478 of file KnowledgeBaseImpl.inl.

◆ to_map_stripped()

KnowledgeMap madara::knowledge::KnowledgeBaseImpl::to_map_stripped ( const std::string & prefix ) const

inline

Creates a map with Knowledge Records that begin with the given prefix.

Runs in O(log n + m) time, where n is the size of the KnowledgeBase, and m is the number of matching records

All key names have the "prefix" portion stripped off their front in the returned map.

Parameters

prefix Prefix string to match with

Returns: A new map with just entries starting with prefix

Definition at line 497 of file KnowledgeBaseImpl.inl.

◆ to_string()

void madara::knowledge::KnowledgeBaseImpl::to_string	(	std::string &	target,
		const std::string &	array_delimiter = `","`,
		const std::string &	record_delimiter = `";\n"`,
		const std::string &	key_val_delimiter = `"="`
	)		const

inline

Saves all keys and values into a string, using the underlying knowledge::KnowledgeRecord::to_string function.

This is an optimized version that allows the specification of a target string to avoid string copying (which can be expensive with longer strings across multiple function boundaries). This function differs from knowledge::KnowledgeRecord to_string in that it is intended to save the database in a format that can be easily parseable. Consequently, strings are delineated in this function by being included in single quotes. Arrays are delineated with array indices [].

This is not appropriate for saving the context if it has binary data inside of it, as only the size of the data entry would be saved.

Parameters

target	where to store the resulting string operation.
array_delimiter	for any arrays, the characters in between data elements.
record_delimiter	the characters to place between individual key/value pairs
key_val_delimiter	the characters to place between keys and values.

Definition at line 279 of file KnowledgeBaseImpl.inl.

◆ to_vector()

size_t madara::knowledge::KnowledgeBaseImpl::to_vector	(	const std::string &	subject,
		unsigned int	start,
		unsigned int	end,
		std::vector< KnowledgeRecord > &	target
	)

inline

Fills a vector with Knowledge Records that begin with a common subject and have a finite range of integer values.

Parameters

subject	The common subject of the variable names. For instance, if we are looking for a range of vars like "var0", "var1", "var2", then the common subject would be "var".
start	An inclusive start index
end	An inclusive end index
target	The vector that will be filled with Knowledge Record instances within the subject range.

Returns: entries in the resulting vector

Definition at line 466 of file KnowledgeBaseImpl.inl.

◆ transport_settings()

madara::transport::TransportSettings & madara::knowledge::KnowledgeBaseImpl::transport_settings ( void )

inline

Returns a non-const reference to the Transport Settings.

Returns: settings reference

Definition at line 267 of file KnowledgeBaseImpl.inl.

◆ unlock()

void madara::knowledge::KnowledgeBaseImpl::unlock ( void )

inline

Unlocks the context to allow updates over the network (is only necessary if the context has been explicitly locked)

Definition at line 241 of file KnowledgeBaseImpl.inl.

◆ wait() [1/3]

KnowledgeRecord madara::knowledge::KnowledgeBaseImpl::wait	(	CompiledExpression &	expression,
		const WaitSettings &	settings
	)

Waits for an expression to be non-zero.

Provides additional settings for fine-tuning the time to wait and atomic print statements.

Parameters

expression	KaRL expression to wait on (result of compile)
settings	Settings for the underlying expression evaluation and printing

Returns: value of expression

Exceptions

exceptions::KarlException failure during compile/evaluate

Definition at line 233 of file KnowledgeBaseImpl.cpp.

◆ wait() [2/3]

KnowledgeRecord madara::knowledge::KnowledgeBaseImpl::wait ( const std::string & expression )

inline

Waits for an expression to be non-zero.

Always disseminates modifications.

Parameters

expression KaRL expression to wait on

Returns: value of expression

Exceptions

exceptions::KarlException failure during compile/evaluate

Definition at line 370 of file KnowledgeBaseImpl.inl.

◆ wait() [3/3]

KnowledgeRecord madara::knowledge::KnowledgeBaseImpl::wait	(	const std::string &	expression,
		const WaitSettings &	settings
	)

Waits for an expression to be non-zero.

Provides additional settings for fine-tuning the time to wait and atomic print statements.

Parameters

expression	KaRL expression to wait on
settings	Settings for the underlying expression evaluation and printing

Returns: value of expression

Exceptions

exceptions::KarlException failure during compile/evaluate

Definition at line 226 of file KnowledgeBaseImpl.cpp.

◆ wait_for_change()

void madara::knowledge::KnowledgeBaseImpl::wait_for_change ( void )

inline

Wait for a change to happen to the context (e.g., from transports)

Definition at line 661 of file KnowledgeBaseImpl.inl.

◆ write_file()

ssize_t madara::knowledge::KnowledgeBaseImpl::write_file	(	const std::string &	knowledge_key,
		const std::string &	filename
	)

inline

Write a file from the knowledge base to a specified location.

Write file from the knowledge base to a specified file.

Parameters

filename	file to write to
knowledge_key	key to read the file from

Returns: -1 if unsuccessful, 0 otherwise

Definition at line 253 of file KnowledgeBaseImpl.inl.

Member Data Documentation

◆ done_sending_

bool madara::knowledge::KnowledgeBaseImpl::done_sending_ = false

private

Definition at line 1123 of file KnowledgeBaseImpl.h.

◆ done_sending_mutex_

MADARA_LOCK_TYPE madara::knowledge::KnowledgeBaseImpl::done_sending_mutex_

mutableprivate

Definition at line 1110 of file KnowledgeBaseImpl.h.

◆ id_

std::string madara::knowledge::KnowledgeBaseImpl::id_

private

Definition at line 1105 of file KnowledgeBaseImpl.h.

◆ map_

ThreadSafeContext madara::knowledge::KnowledgeBaseImpl::map_

private

Definition at line 1104 of file KnowledgeBaseImpl.h.

◆ send_mutex_

MADARA_LOCK_TYPE madara::knowledge::KnowledgeBaseImpl::send_mutex_

mutableprivate

Definition at line 1109 of file KnowledgeBaseImpl.h.

◆ settings_

transport::QoSTransportSettings madara::knowledge::KnowledgeBaseImpl::settings_

private

Definition at line 1106 of file KnowledgeBaseImpl.h.

◆ transport_mutex_

MADARA_LOCK_TYPE madara::knowledge::KnowledgeBaseImpl::transport_mutex_

mutableprivate

Definition at line 1108 of file KnowledgeBaseImpl.h.

◆ transports_

std::vector<std::shared_ptr<transport::Base> > madara::knowledge::KnowledgeBaseImpl::transports_

private

Definition at line 1112 of file KnowledgeBaseImpl.h.

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

include/madara/knowledge/KnowledgeBaseImpl.h
include/madara/knowledge/KnowledgeBaseImpl.cpp
include/madara/knowledge/KnowledgeBaseImpl.inl

Classes

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ KnowledgeBaseImpl() [1/4]

◆ KnowledgeBaseImpl() [2/4]

◆ KnowledgeBaseImpl() [3/4]

◆ KnowledgeBaseImpl() [4/4]

◆ ~KnowledgeBaseImpl()

Member Function Documentation

◆ acquire()

◆ activate_transport()

◆ add_modifieds()

◆ apply_modified()

◆ attach_logger()

◆ attach_streamer()

◆ attach_transport() [1/2]

◆ attach_transport() [2/2]

◆ cinvoke() [1/2]

◆ cinvoke() [2/2]

◆ clear() [1/2]

◆ clear() [2/2]

◆ clear_map()

◆ clear_modifieds()

◆ clear_rules()

◆ close_transport()

◆ compile()

◆ copy() [1/2]

◆ copy() [2/2]

◆ debug_modifieds()

◆ define_function() [1/6]

◆ define_function() [2/6]

◆ define_function() [3/6]

◆ define_function() [4/6]

◆ define_function() [5/6]

◆ define_function() [6/6]

◆ evaluate() [1/4]

◆ evaluate() [2/4]

◆ evaluate() [3/4]

◆ evaluate() [4/4]

◆ evaluate_file()

◆ exists() [1/2]

◆ exists() [2/2]

◆ expand_statement()

◆ file_to_string()

◆ for_each()

◆ get() [1/2]

◆ get() [2/2]

◆ get_context()

◆ get_id()

◆ get_log_level()

◆ get_logger()

◆ get_matches()

◆ get_num_transports()

◆ get_ref()

◆ get_transports()

◆ invoke() [1/4]

◆ invoke() [2/4]

◆ invoke() [3/4]

◆ invoke() [4/4]

◆ load_context() [1/3]

◆ load_context() [2/3]

◆ load_context() [3/3]

◆ lock()

◆ mark_modified() [1/2]

◆ mark_modified() [2/2]

◆ print() [1/2]

◆ print() [2/2]

◆ read_file() [1/2]

◆ read_file() [2/2]

◆ release()

◆ remove_transport()

◆ reset_checkpoint()

◆ retrieve_index() [1/2]

◆ retrieve_index() [2/2]

◆ save_as_json() [1/2]

◆ save_as_json() [2/2]

◆ save_as_karl() [1/2]