glass3 broker input class More...

#include <brokerInput.h>

Inheritance diagram for glass3::brokerInput:

Collaboration diagram for glass3::brokerInput:

Public Member Functions
	brokerInput ()
	brokerInput constructor More...

	brokerInput (const std::shared_ptr< const json::Object > &config)
	brokerInput advanced constructor More...

	~brokerInput ()
	brokerInput destructor More...

bool	setup (std::shared_ptr< const json::Object > config) override
	brokerInput configuration function More...

void	clear () override
	output clear function More...

Public Member Functions inherited from glass3::input::Input
	Input ()
	Input default constructor. More...

	Input (std::shared_ptr< const json::Object > config)
	Input advanced constructor. More...

	~Input ()
	Input destructor. More...

std::shared_ptr< json::Object >	getInputData () override
	Input data getting function. More...

int	getInputDataCount () override
	Input data count function. More...

void	setInputDataMaxSize (int size)
	Function to set the maximum queue size. More...

int	getInputDataMaxSize ()
	Function to retrieve the maximum queue size. More...

Public Member Functions inherited from glass3::util::ThreadBaseClass
	ThreadBaseClass ()
	ThreadBaseClass constructor. More...

	ThreadBaseClass (std::string threadName, int sleepTimeMS=100, int numThreads=1, int checkInterval=300)
	An advanced constructor that sets up the ThreadBaseClass with a provided thread name, sleep between work time duration, number of threads, and statsus check interval. More...

	~ThreadBaseClass ()
	ThreadBaseClass destructor. More...

virtual bool	start ()
	work thread start function More...

virtual bool	stop ()
	work thread stop function More...

int	getNumThreads ()
	Retrieves the number of work threads. More...

void	setNumThreads (int numThreads)
	Sets the number of work threads. More...

void	setThreadHealth (bool health=true)
	Function to set thread health. More...

virtual bool	healthCheck ()
	work threads check function More...

void	setSleepTime (int sleepTimeMS)
	Sets the time to sleep between work() calls. More...

int	getSleepTime ()
	Retrieves the time to sleep between work() calls. More...

glass3::util::ThreadState	getWorkThreadsState ()
	Function to get the work threads state. More...

void	setHealthCheckInterval (int interval)
	Function to set work threads health check interval. More...

int	getHealthCheckInterval ()
	Function to retrieve the work threads health check interval. More...

bool	getTerminate ()
	Function to retrieve whether the thread should terminate. More...

const std::string &	getThreadName ()
	Function to retrieve the name of the work threads. More...

std::time_t	getAllLastHealthy (size_t *pThreadId)
	Function to retrieve the oldest time any of the work threads last updated their health status as healthy. More...

Public Member Functions inherited from glass3::util::BaseClass
	BaseClass ()
	BaseClass constructor. More...

virtual	~BaseClass ()
	BaseClass destructor. More...

const std::shared_ptr< const json::Object >	getConfig ()

bool	getSetup ()
	Retrieves the class member boolean flag indicating whether the class has been setup, set to true if setup was successful. More...

const std::string &	getDefaultAgencyId ()
	Function to retrieve the name of the default agency id. More...

void	setDefaultAgencyId (const std::string &id)
	Function to set the name of the default agency id. More...

const std::string &	getDefaultAuthor ()
	Function to retrieve the name of the default author. More...

void	setDefaultAuthor (const std::string &author)
	Function to set the name of the default author. More...

Protected Member Functions
std::string	fetchRawData (std::string *pOutType) override
	get input data string and type More...

void	logConsumer (const std::string &message)
	the function for consumer logging More...

Protected Member Functions inherited from glass3::input::Input
glass3::util::WorkState	work () override
	Input work function. More...

virtual std::shared_ptr< json::Object >	parse (std::string inputType, std::string inputMessage)
	parse line function More...

Protected Member Functions inherited from glass3::util::ThreadBaseClass
void	setWorkThreadsState (glass3::util::ThreadState state)
	Function to set threads state. More...

void	workLoop ()
	ThreadBaseClass work loop function. More...

void	setLastHealthy (std::time_t now)
	Function to set the last time the work thread was healthy. More...

Additional Inherited Members
Protected Attributes inherited from glass3::util::ThreadBaseClass
std::vector< std::thread >	m_WorkThreads
	the std::vector that contains the work std::thread objects More...

std::map< std::thread::id, std::atomic< int > >	m_ThreadHealthMap
	A std::map containing the epoch times as std::atomic<double>> that each work thread was last marked as healthy, identified by the thread id. More...

Protected Attributes inherited from glass3::util::BaseClass
std::shared_ptr< const json::Object >	m_Config
	A shared pointer to the json::Object that holds the configuration. More...

std::atomic< bool >	m_bIsSetup
	the boolean flag indicating whether the class has been setup, set to true if setup was successful. More...

std::string	m_DefaultAgencyID
	A std::string containing the default agency id to use in parsing if one is not provided. More...

std::string	m_DefaultAuthor
	A std::string containing the default author to use in parsing if one is not provided. More...

Detailed Description

glass3 broker input class

The glass3 broker input class is a class encapsulating the broker input logic. The output class handles setting up a hazdevbroker consumer, configuring input topic(s) and getting messages from kafka via the hazdevbroker consumer to glasscore via the associator class.

brokerInput inherits from the glass3::input::Input class.

Constructor & Destructor Documentation

glass3::brokerInput::brokerInput ( )

brokerInput constructor

The constructor for the brokerInput class. Initializes members to default values.

glass3::brokerInput::brokerInput ( const std::shared_ptr< const json::Object > & config )

explicit

brokerInput advanced constructor

The advanced constructor for the brokerInput class. Initializes members to default values. Calls setup to configure the class Starts the work thread

Parameters

config - A json::Object pointer to the configuration to use

glass3::brokerInput::~brokerInput ( )

brokerInput destructor

The destructor for the brokerInput class. Stops the work thread

Member Function Documentation

void glass3::brokerInput::clear ( )

overridevirtual

output clear function

The clear function for the output class. Clears all configuration

Reimplemented from glass3::input::Input.

std::string glass3::brokerInput::fetchRawData ( std::string * pOutType )

overrideprotectedvirtual

get input data string and type

A function (overridden from glass3::input) that that retrieves the next data message and type from an input source

Parameters

pOutType - A pointer to a std::string used to pass out the type of the data

Returns: returns a std::string containing the input data message

Implements glass3::input::Input.

void glass3::brokerInput::logConsumer ( const std::string & message )

protected

the function for consumer logging

Parameters

message - A string containing the logging message

bool glass3::brokerInput::setup ( std::shared_ptr< const json::Object > config )

overridevirtual

brokerInput configuration function

This function configures the brokerInput class.

Parameters

config - A pointer to a json::Object containing to the configuration to use

Returns: returns true if successful.

Reimplemented from glass3::input::Input.

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

glass-broker-app/brokerInput/brokerInput.h
glass-broker-app/brokerInput/brokerInput.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation