#include <extensible.h>
|
| ExtensionItem (const std::string &key, ExtensibleType exttype, Module *owner) |
|
virtual | ~ExtensionItem () |
|
virtual void | FromInternal (Extensible *container, const std::string &value) |
|
virtual void | FromNetwork (Extensible *container, const std::string &value) |
|
virtual std::string | ToHuman (const Extensible *container, void *item) const |
|
virtual std::string | ToInternal (const Extensible *container, void *item) const |
|
virtual std::string | ToNetwork (const Extensible *container, void *item) const |
|
virtual void | free (Extensible *container, void *item)=0 |
|
void | RegisterService () CXX11_OVERRIDE |
|
| DEPRECATED_METHOD (virtual std::string serialize(SerializeFormat format, const Extensible *container, void *item) const) |
|
| DEPRECATED_METHOD (virtual void unserialize(SerializeFormat format, Extensible *container, const std::string &value)) |
|
| ServiceProvider (Module *Creator, const std::string &Name, ServiceType Type) |
|
const char * | GetTypeString () const |
|
void | DisableAutoRegister () |
|
virtual CullResult | cull () |
|
unsigned int | GetUseCount () const |
|
void | refcount_inc () const |
|
bool | refcount_dec () const |
|
Base class for logic that extends an Extensible object.
◆ ExtensibleType
◆ ExtensionItem()
◆ ~ExtensionItem()
ExtensionItem::~ExtensionItem |
( |
| ) |
|
|
virtual |
◆ DEPRECATED_METHOD() [1/2]
ExtensionItem::DEPRECATED_METHOD |
( |
virtual std::string serialize(SerializeFormat format, const Extensible *container, void *item) const |
| ) |
|
DEPRECATED: use To{Human,Internal,Network} instead.
◆ DEPRECATED_METHOD() [2/2]
ExtensionItem::DEPRECATED_METHOD |
( |
virtual void |
unserializeSerializeFormat format, Extensible *container, const std::string &value | ) |
|
DEPRECATED: use From{Internal,Network} instead.
◆ free()
virtual void ExtensionItem::free |
( |
Extensible * |
container, |
|
|
void * |
item |
|
) |
| |
|
pure virtual |
◆ FromInternal()
void ExtensionItem::FromInternal |
( |
Extensible * |
container, |
|
|
const std::string & |
value |
|
) |
| |
|
virtual |
◆ FromNetwork()
void ExtensionItem::FromNetwork |
( |
Extensible * |
container, |
|
|
const std::string & |
value |
|
) |
| |
|
virtual |
◆ get_raw()
void * ExtensionItem::get_raw |
( |
const Extensible * |
container | ) |
const |
|
protected |
Retrieves the value for this ExtensionItem from the internal map.
- Parameters
-
- Returns
- Either the value of this ExtensionItem or NULL if it is not set.
◆ RegisterService()
void ExtensionItem::RegisterService |
( |
| ) |
|
|
virtual |
◆ set_raw()
void * ExtensionItem::set_raw |
( |
Extensible * |
container, |
|
|
void * |
value |
|
) |
| |
|
protected |
Stores a value for this ExtensionItem in the internal map and returns the old value if one was set.
- Parameters
-
container | A container the ExtensionItem should be set on. |
value | The value to set on the specified container. |
- Returns
- Either the old value or NULL if one is not set.
◆ ToHuman()
std::string ExtensionItem::ToHuman |
( |
const Extensible * |
container, |
|
|
void * |
item |
|
) |
| const |
|
virtual |
Gets an ExtensionItem's value in a human-readable format.
- Parameters
-
container | The container the ExtensionItem is set on. |
item | The value to convert to a human-readable format. |
- Returns
- The value specified in
item
in a human readable format.
◆ ToInternal()
std::string ExtensionItem::ToInternal |
( |
const Extensible * |
container, |
|
|
void * |
item |
|
) |
| const |
|
virtual |
Gets an ExtensionItem's value in the internal format.
- Parameters
-
container | The container the ExtensionItem is set on. |
item | The value to convert to the internal format. |
- Returns
- The value specified in
item
in the internal format.
Reimplemented in LocalIntExt, and LocalStringExt.
◆ ToNetwork()
std::string ExtensionItem::ToNetwork |
( |
const Extensible * |
container, |
|
|
void * |
item |
|
) |
| const |
|
virtual |
Gets an ExtensionItem's value in the network format.
- Parameters
-
container | The container the ExtensionItem is set on. |
item | The value to convert to the network format. |
- Returns
- The value specified in
item
in the network format.
Reimplemented in StringExtItem.
◆ unset_raw()
void * ExtensionItem::unset_raw |
( |
Extensible * |
container | ) |
|
|
protected |
Removes the value for this ExtensionItem from the internal map and returns it.
- Parameters
-
- Returns
- Either the old value or NULL if one is not set.
◆ type
The documentation for this class was generated from the following files: