#include <OperationBalance.h>

Inheritance diagram for Hypertable::OperationBalance:

Collaboration diagram for Hypertable::OperationBalance:

Public Member Functions
	OperationBalance (ContextPtr &context)

	OperationBalance (ContextPtr &context, const MetaLog::EntityHeader &header_)

	OperationBalance (ContextPtr &context, EventPtr &event)

virtual	~OperationBalance ()

void	execute () override
	Executes (carries out) the operation. More...

const String	name () override
	Name of operation used for exclusivity. More...

const String	label () override
	Human readable label for operation. More...

void	display_state (std::ostream &os) override
	Write human readable operation state to output stream. More...

bool	exclusive () override
	Indicates if operation is exclusive. More...

uint8_t	encoding_version_state () const override
	Returns version of encoding format of state. More...

size_t	encoded_length_state () const override
	Encoded length of operation state. More...

void	encode_state (uint8_t **bufp) const override
	Encode operation state. More...

void	decode_state (uint8_t version, const uint8_t *bufp, size_t remainp) override
	Decode operation state. More...

void	decode_state_old (uint8_t version, const uint8_t *bufp, size_t remainp) override

Public Member Functions inherited from Hypertable::Operation
	Operation (ContextPtr &context, int32_t type)
	Constructor with operation type specifier. More...

	Operation (ContextPtr &context, EventPtr &event, int32_t type)
	Constructor with request Event and operation type specifier. More...

	Operation (ContextPtr &context, const MetaLog::EntityHeader &header_)
	Constructor with MetaLog::EntityHeader. More...

virtual	~Operation ()
	Destructor. More...

virtual const String	graphviz_label ()
	Human readable operation label used in graphviz output. More...

virtual size_t	encoded_result_length () const
	Length of encoded operation result. More...

virtual void	encode_result (uint8_t **bufp) const
	Encode operation result. More...

virtual void	decode_result (const uint8_t *bufp, size_t remainp)
	Decode operation result. More...

void	decode (const uint8_t *bufp, size_t remainp, uint16_t definition_version) override
	Decode operation. More...

void	display (std::ostream &os) override
	Write human readable string represenation of operation to output stream. More...

int64_t	id ()
	Operation identifier. More...

ClockT::time_point	expiration_time ()
	Returns operation expiration time. More...

void	set_remove_approval_mask (uint16_t mask)
	Sets the remove approvals bit mask. More...

uint16_t	get_remove_approval_mask ()
	Gets the remove approvals bit mask. More...

bool	remove_approval_add (uint16_t approval)
	Sets remove approval bits. More...

bool	removal_approved ()
	Checks if all remove approvals have been received. More...

void	record_state (std::vector< MetaLog::EntityPtr > &additional)
	Records operation state and additional entities to the MML. More...

void	record_state ()
	Records operation state to the MML. More...

void	complete_error (int error, const String &msg, std::vector< MetaLog::EntityPtr > &additional)
	Completes operation with error. More...

void	complete_error (int error, const String &msg, MetaLog::EntityPtr additional=MetaLog::EntityPtr())
	Completes operation with error. More...

void	complete_error (Exception &e, std::vector< MetaLog::EntityPtr > &additional)
	Completes operation with exception. More...

void	complete_error (Exception &e, MetaLog::EntityPtr additional=MetaLog::EntityPtr())
	Completes operation with exception. More...

void	complete_ok (std::vector< MetaLog::EntityPtr > &additional)

void	complete_ok (MetaLog::EntityPtr additional=MetaLog::EntityPtr())

virtual int64_t	hash_code () const

virtual void	exclusivities (DependencySet &exclusivities)

virtual void	dependencies (DependencySet &dependencies)

virtual void	obstructions (DependencySet &obstructions)

void	add_exclusivity (const String &exclusivity)

void	add_dependency (const String &dependency)

void	add_obstruction (const String &obstruction)

void	add_obstruction_permanent (const String &obstruction)

void	fetch_sub_operations (std::vector< std::shared_ptr< Operation > > &sub_ops)

void	pre_run ()

void	post_run ()

int32_t	get_state ()

void	set_state (int32_t state)

virtual bool	is_perpetual ()

bool	block ()

bool	unblock ()

bool	is_blocked ()

bool	is_complete ()

int32_t	get_original_type ()

void	set_original_type (int32_t original_type)

void	set_ephemeral ()
	Sets the ephemeral flag to true. More...

bool	ephemeral ()
	Gets the ephemeral flag. More...

int32_t	get_error ()
	Get error code. More...

String	get_error_msg ()
	Get error message. More...

Public Member Functions inherited from Hypertable::MetaLog::Entity
	Entity (int32_t type)
	Constructor from entity type. More...

	Entity (const EntityHeader &header_)
	Constructor from entity header. More...

virtual	~Entity ()
	Destructor. More...

void	lock ()
	Locks the entity's mutex. More...

void	unlock ()
	Unlocks the entity's mutex. More...

void	mark_for_removal ()
	Marks entity for removal. More...

bool	marked_for_removal ()
	Checks if entity is marked for removal. More...

int64_t	id () const
	Returns the entity ID. More...

Public Member Functions inherited from Hypertable::Serializable
virtual size_t	encoded_length () const
	Returns serialized object length. More...

virtual void	encode (uint8_t **bufp) const
	Writes serialized representation of object to a buffer. More...

virtual void	decode (const uint8_t *bufp, size_t remainp)
	Reads serialized representation of object from a buffer. More...

Private Member Functions
void	initialize_dependencies ()

Private Attributes
Lib::Master::Request::Parameters::Balance	m_params
	Request parmaeters. More...

BalancePlanPtr	m_plan
	Balance plan. More...

Additional Inherited Members
Protected Member Functions inherited from Hypertable::Operation
uint8_t	encoding_version () const override
	Returns encoding version. More...

size_t	encoded_length_internal () const override
	Returns internal serialized length. More...

void	encode_internal (uint8_t **bufp) const override
	Writes serialized representation of object to a buffer. More...

void	decode_internal (uint8_t version, const uint8_t *bufp, size_t remainp) override
	Reads serialized representation of object from a buffer. More...

void	decode_old (const uint8_t *bufp, size_t remainp, uint16_t definition_version)

bool	validate_subops ()
	Handles the results of sub operations. More...

void	stage_subop (std::shared_ptr< Operation > operation)
	Stages a sub operation for execution. More...

Protected Member Functions inherited from Hypertable::MetaLog::Entity
void	encode_entry (uint8_t **bufp)
	Encodes entity header plus serialized state. More...

Protected Attributes inherited from Hypertable::Operation
ContextPtr	m_context
	Pointer to Master context. More...

EventPtr	m_event
	Pointer to client event (if any) that originated the operation. More...

uint16_t	m_remove_approvals {}
	Remove approvals received. More...

uint16_t	m_remove_approval_mask {}
	Remove approval mask. More...

int32_t	m_original_type {}
	Original entity type read from MML (prior to conversion) More...

int32_t	m_error {}
	Result error code. More...

String	m_error_msg
	Result error message. More...

bool	m_unblock_on_exit {}
	Flag to signal operation to be unblocked on exit (post_run()) More...

bool	m_blocked {}
	Flag indicating if operation is blocked. More...

bool	m_ephemeral {}
	Indicates if operation is ephemeral and does not get persisted to MML. More...

ClockT::time_point	m_expiration_time
	Expiration time (used by ResponseManager) More...

int64_t	m_hash_code
	Hash code uniqely identifying operation. More...

DependencySet	m_exclusivities
	Set of exclusivities. More...

DependencySet	m_dependencies
	Set of dependencies. More...

DependencySet	m_obstructions
	Set of obstructions. More...

DependencySet	m_obstructions_permanent
	Set of permanent obstructions. More...

std::vector< int64_t >	m_sub_ops
	Vector of sub operations IDs. More...

Protected Attributes inherited from Hypertable::MetaLog::Entity
std::mutex	m_mutex
	Mutex for serializing access to members More...

EntityHeader	header
	Entity header More...

Detailed Description

Definition at line 32 of file OperationBalance.h.

Constructor & Destructor Documentation

OperationBalance::OperationBalance ( ContextPtr & context )

Definition at line 52 of file OperationBalance.cc.

OperationBalance::OperationBalance	(	ContextPtr &	context,
		const MetaLog::EntityHeader &	header_
	)

Definition at line 58 of file OperationBalance.cc.

OperationBalance::OperationBalance	(	ContextPtr &	context,
		EventPtr &	event
	)

Definition at line 64 of file OperationBalance.cc.

virtual Hypertable::OperationBalance::~OperationBalance ( )

inlinevirtual

Definition at line 37 of file OperationBalance.h.

Member Function Documentation

void OperationBalance::decode_state	(	uint8_t	version,
		const uint8_t **	bufp,
		size_t *	remainp
	)

overridevirtual

Decode operation state.

This method is called by decode() to decode state that is specific to the operation. The encoded state should start at the memory location pointed to by *bufp, and if successfully decoded, will be modified to point to the first byte past the encoded state. The remainp parameter is a pointer to an integer holding the number of valid/readable bytes pointed to by *bufp and if decoding is sucessful, will be decremented by the length of the encoded state.

Parameters

version	Encoding version
bufp	Address of pointer to destination buffer
remainp	Address of integer holding amount of remaining buffer

Implements Hypertable::Operation.

Definition at line 194 of file OperationBalance.cc.

void OperationBalance::decode_state_old	(	uint8_t	version,
		const uint8_t **	bufp,
		size_t *	remainp
	)

overridevirtual

Implements Hypertable::Operation.

Definition at line 202 of file OperationBalance.cc.

void OperationBalance::display_state ( std::ostream & os )

overridevirtual

Write human readable operation state to output stream.

This method is called by display() to write a human readable string representation of the operation state to os

Parameters

os	Output stream to which state string is to be written

Implements Hypertable::Operation.

Definition at line 165 of file OperationBalance.cc.

void OperationBalance::encode_state ( uint8_t ** bufp ) const

overridevirtual

Encode operation state.

This method is called by encode() to encode state that is specific to the operation. The encoded state is written to the memory location pointed to by *bufp, which is modified to point to the first byte after the encoded state.

Parameters

bufp	Address of pointer to destination buffer (modified by call)

Implements Hypertable::Operation.

Definition at line 189 of file OperationBalance.cc.

size_t OperationBalance::encoded_length_state ( ) const

overridevirtual

Encoded length of operation state.

Returns: Length of encoded operation state.

Implements Hypertable::Operation.

Definition at line 185 of file OperationBalance.cc.

uint8_t OperationBalance::encoding_version_state ( ) const

overridevirtual

Returns version of encoding format of state.

This is method returns the version of the encoding format of the state.

Returns: Version of encoding format of state.

Implements Hypertable::Operation.

Definition at line 181 of file OperationBalance.cc.

bool Hypertable::OperationBalance::exclusive ( )

inlineoverridevirtual

Indicates if operation is exclusive.

An operation can be designated as exclusive which means that only one operation of this type may be added to the OperationProcessor at any given time. This method is used in conjunction with the name() method to determine if the operation can be added to the OperationProcessor. If this method returns true and another exclusive operation exists in the OperationProcessor with the same name as returned by name(), then the attempt to add the operation will throw an Exception with error code Error::MASTER_OPERATION_IN_PROGRESS.

Returns: true if operation is exclusive, false otherwise.

Reimplemented from Hypertable::Operation.

Definition at line 43 of file OperationBalance.h.

void OperationBalance::execute ( )

overridevirtual

Executes (carries out) the operation.

This method is called by the OperationProcessor to carry out the operation. After calling this method, the OperationProcessor will check the state of the operation with a call to get_state(). If the state is OperationState::COMPLETE, then it assumes that the operation is complete and will destory it. Otherwise, it will remain in the operation dependency graph and will get re-executed at a later time. After the call to this method, the OperationProcessor will re-compute the operation dependency graph (which may have changed due to the removal of this operation or if there were modifications to m_exclusivities, m_dependencies, or m_obstructions) and will continue operation execution in the approprate order.

Implements Hypertable::Operation.

Definition at line 85 of file OperationBalance.cc.

void OperationBalance::initialize_dependencies ( )

private

Definition at line 73 of file OperationBalance.cc.

const String OperationBalance::label ( )

overridevirtual

Human readable label for operation.

This method is used to generate a human readable string describing the operation and is typically used for generating log messages.

Returns: Human readable string describing operation

Implements Hypertable::Operation.

Definition at line 173 of file OperationBalance.cc.

const String OperationBalance::name ( )

overridevirtual

Name of operation used for exclusivity.

An operation can be marked exclusive (see exclusvive()) which tells the Operation processor that only one operation of this name may be added to the dependency graph. If an attempt to add an an exclusive operation is made and the OperationProcessor already contains an exclusive operation with the same name, the attempt will fail and will result in an Exception with error code Error::MASTER_OPERATION_IN_PROGRESS.

Returns: Name of operation used to enforce exclusivity constraint

Implements Hypertable::Operation.

Definition at line 169 of file OperationBalance.cc.

Member Data Documentation

Lib::Master::Request::Parameters::Balance Hypertable::OperationBalance::m_params

private

Request parmaeters.

Definition at line 56 of file OperationBalance.h.

BalancePlanPtr Hypertable::OperationBalance::m_plan

private

Balance plan.

Definition at line 59 of file OperationBalance.h.

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

/home/doug/src/hypertable/src/cc/Hypertable/Master/OperationBalance.h
/home/doug/src/hypertable/src/cc/Hypertable/Master/OperationBalance.cc

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation