0.9.8.10
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | List of all members
Hypertable::MetaLog::EntityTask Class Referenceabstract

#include <MetaLogEntityTask.h>

Inheritance diagram for Hypertable::MetaLog::EntityTask:
Inheritance graph
[legend]
Collaboration diagram for Hypertable::MetaLog::EntityTask:
Collaboration graph
[legend]

Public Member Functions

 EntityTask (const EntityHeader &header_)
 
 EntityTask (int32_t type)
 
virtual ~EntityTask ()
 
virtual const String name ()=0
 Returns the name of the entity. More...
 
virtual bool execute ()=0
 
virtual void work_queue_add_hook ()
 
- 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...
 
virtual void decode (const uint8_t **bufp, size_t *remainp, uint16_t definition_version)
 Decodes serialized entity state. 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...
 
virtual void display (std::ostream &os)
 Prints a textual representation of the entity state to an ostream. 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...
 

Additional Inherited Members

- Protected Member Functions inherited from Hypertable::MetaLog::Entity
void encode_entry (uint8_t **bufp)
 Encodes entity header plus serialized state. More...
 
- Protected Member Functions inherited from Hypertable::Serializable
virtual uint8_t encoding_version () const =0
 Returns encoding version. More...
 
virtual size_t encoded_length_internal () const =0
 Returns internal serialized length. More...
 
virtual void encode_internal (uint8_t **bufp) const =0
 Writes serialized representation of object to a buffer. More...
 
virtual void decode_internal (uint8_t version, const uint8_t **bufp, size_t *remainp)=0
 Reads serialized representation of object from a buffer. 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 33 of file MetaLogEntityTask.h.

Constructor & Destructor Documentation

Hypertable::MetaLog::EntityTask::EntityTask ( const EntityHeader header_)
inline

Definition at line 35 of file MetaLogEntityTask.h.

Hypertable::MetaLog::EntityTask::EntityTask ( int32_t  type)
inline

Definition at line 36 of file MetaLogEntityTask.h.

virtual Hypertable::MetaLog::EntityTask::~EntityTask ( )
inlinevirtual

Definition at line 37 of file MetaLogEntityTask.h.

Member Function Documentation

virtual bool Hypertable::MetaLog::EntityTask::execute ( )
pure virtual
virtual const String Hypertable::MetaLog::EntityTask::name ( )
pure virtual

Returns the name of the entity.

This method returns the name of the entity which is used by tools that convert a MetaLog into a human readable representation

Returns
Name of the entity

Implements Hypertable::MetaLog::Entity.

Implemented in Hypertable::MetaLog::EntityTaskAcknowledgeRelinquish.

virtual void Hypertable::MetaLog::EntityTask::work_queue_add_hook ( )
inlinevirtual

Reimplemented in Hypertable::MetaLog::EntityTaskAcknowledgeRelinquish.

Definition at line 40 of file MetaLogEntityTask.h.


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