Class Ase::ServerImpl
ClassList > Ase > ServerImpl
Inherits the following classes: Ase::GadgetImpl, Ase::Server
Public Types
| Type | Name |
|---|---|
| typedef FastMemory::Block | Block |
Public Types inherited from Ase::GadgetImpl
See Ase::GadgetImpl
| Type | Name |
|---|---|
| typedef std::function< bool(GadgetImpl *, const Value *, Value *)> | MemberAccessF |
| typedef bool(*)(const SharedBase &) | MemberClassT |
| typedef const StringS &(*)() | MemberInfosP |
Public Types inherited from Ase::Server
See Ase::Server
| Type | Name |
|---|---|
| typedef std::shared_ptr< Server > | ServerP |
Public Attributes inherited from Ase::Gadget
See Ase::Gadget
| Type | Name |
|---|---|
| Member<&Gadget::name_ > | name |
Public Attributes inherited from Ase::Gadget
See Ase::Gadget
| Type | Name |
|---|---|
| Member<&Gadget::name_ > | name |
Public Functions
| Type | Name |
|---|---|
| ServerImpl () |
|
| PropertyP | access_preference (const String & ident) override |
| bool | broadcast_telemetry (const TelemetrySegmentS & plan, int32 interval_ms) override |
| ProjectP | create_project (String projectname) override |
| String | error_blurb (Error error) override const |
| String | get_build_id () override |
| String | get_clap_version () override |
| Value | get_data (const String & key) override const |
| String | get_flac_version () override |
| String | get_opus_version () override |
| String | get_version () override |
| ProjectP | last_project () override |
| StringS | list_preferences () override |
| String | musical_tuning_blurb (MusicalTuning musicaltuning) override const |
| String | musical_tuning_label (MusicalTuning musicaltuning) override const |
| bool | set_data (const String & key, const Value & v) override |
| void | shutdown () override |
| Block | telemem_allocate (uint32 length) const |
| void | telemem_release (Block telememblock) const |
| ptrdiff_t | telemem_start () const |
| uint64 | user_note (const String & text, const String & channel="misc", UserNote::Flags flags=UserNote::TRANSIENT, const String & rest="") override |
| bool | user_reply (uint64 noteid, uint r) override |
| virtual | ~ServerImpl () |
Public Functions inherited from Ase::GadgetImpl
See Ase::GadgetImpl
| Type | Name |
|---|---|
| virtual GadgetImpl * | _parent () override const Retrieve parent container. |
| void | _register_parameter (O * obj, M * memb, const Param::ExtraVals & ev) const |
| virtual void | _set_parent (GadgetImpl * parent) override Assign parent container. |
| virtual PropertyS | access_properties () override Retrieve handles for all properties. |
| virtual Value | get_data (const String & key) override const Retrieve session data. |
| virtual bool | set_data (const String & key, const Value & v) override Assign session data, prefix ephemerals with '_'. |
| virtual String | type_nick () override const |
Public Functions inherited from Ase::EmittableImpl
| Type | Name |
|---|---|
| virtual void | emit_event (const String & type, const String & detail, const ValueR fields={}) override |
| virtual void | emit_notify (const String & detail) override Emit notify:detail , multiple notifications maybe coalesced if a CoalesceNotifies instance exists. |
| virtual ASE_USE_RESULT Connection | on_event (const String & eventselector, const EventHandler & eventhandler) override |
Public Functions inherited from Ase::Emittable
See Ase::Emittable
| Type | Name |
|---|---|
| virtual void | emit_event (const String & type, const String & detail, const ValueR fields={}) = 0 |
| virtual void | emit_notify (const String & detail) = 0 |
| void | js_trigger (const String & eventselector, JsTrigger callback) |
| virtual ASE_USE_RESULT Connection | on_event (const String & eventselector, const EventHandler & eventhandler) = 0 |
Public Functions inherited from Ase::Emittable
See Ase::Emittable
| Type | Name |
|---|---|
| virtual void | emit_event (const String & type, const String & detail, const ValueR fields={}) = 0 |
| virtual void | emit_notify (const String & detail) = 0 |
| void | js_trigger (const String & eventselector, JsTrigger callback) |
| virtual ASE_USE_RESULT Connection | on_event (const String & eventselector, const EventHandler & eventhandler) = 0 |
Public Functions inherited from Ase::CustomDataContainer
| Type | Name |
|---|---|
| bool | del_custom_data (CustomDataKey< T > * key) Delete the current contents of the custom keyed data member, invokes DataKey::destroy. |
| T | get_custom_data (CustomDataKey< T > * key) const Retrieve contents of the custom keyed data member, returns DataKey::fallback if nothing was set. |
| bool | has_custom_data (CustomDataKey< T > * key) const Retrieve wether contents of the custom keyed data member exists. |
| void | set_custom_data (CustomDataKey< T > * key, T data) Assign data to the custom keyed data member, deletes any previously set data. |
Public Functions inherited from Ase::Gadget
See Ase::Gadget
| Type | Name |
|---|---|
| virtual GadgetImpl * | _parent () const = 0 Retrieve parent container. |
| ProjectImpl * | _project () const Find Project in parent ancestry. |
| virtual void | _set_parent (GadgetImpl * parent) = 0 Assign parent container. |
| virtual PropertyS | access_properties () = 0 Retrieve handles for all properties. |
| virtual PropertyP | access_property (String ident) Retrieve handle for a Property . |
| virtual Value | get_data (const String & key) const = 0 Retrieve session data. |
| Value | get_value (String ident) Get native property value. |
| virtual StringS | list_properties () List all property identifiers. |
| virtual bool | set_data (const String & key, const Value & v) = 0 Assign session data, prefix ephemerals with '_'. |
| bool | set_value (String ident, const Value & v) |
| virtual String | type_nick () const = 0 |
Public Functions inherited from Ase::Emittable
See Ase::Emittable
| Type | Name |
|---|---|
| virtual void | emit_event (const String & type, const String & detail, const ValueR fields={}) = 0 |
| virtual void | emit_notify (const String & detail) = 0 |
| void | js_trigger (const String & eventselector, JsTrigger callback) |
| virtual ASE_USE_RESULT Connection | on_event (const String & eventselector, const EventHandler & eventhandler) = 0 |
Public Functions inherited from Ase::Server
See Ase::Server
| Type | Name |
|---|---|
| virtual PropertyP | access_preference (const String & ident) = 0 Retrieve property handle for a Preference identifier. |
| virtual bool | broadcast_telemetry (const TelemetrySegmentS & segments, int32 interval_ms) = 0 Broadcast telemetry memory segments to the current Jsonipc connection. |
| virtual ProjectP | create_project (String projectname) = 0 Create a new project (name is modified to be unique if necessary. |
| ResourceCrawlerP | dir_crawler (const String & cwd="") Create crawler to navigate directories. |
| String | engine_stats () Print engine state. |
| virtual String | error_blurb (Error error) const = 0 |
| virtual String | get_build_id () = 0 Retrieve ASE build id. |
| virtual String | get_clap_version () = 0 Retrieve CLAP support version. |
| virtual String | get_flac_version () = 0 Retrieve FLAC handler version. |
| virtual String | get_opus_version () = 0 Retrieve Opus handler version. |
| virtual String | get_version () = 0 Retrieve ASE version. |
| virtual ProjectP | last_project () = 0 Retrieve the last created project. |
| virtual StringS | list_preferences () = 0 Retrieve a list of all preference identifiers. |
| virtual String | musical_tuning_blurb (MusicalTuning musicaltuning) const = 0 |
| virtual String | musical_tuning_label (MusicalTuning musicaltuning) const = 0 |
| virtual void | shutdown () = 0 Shutdown ASE. |
| ResourceCrawlerP | url_crawler (const String & url="/") Create crawler to navigate URL contents. |
| virtual uint64 | user_note (const String & text, const String & channel="misc", UserNote::Flags flags=UserNote::TRANSIENT, const String & rest="") = 0 |
| virtual bool | user_reply (uint64 noteid, uint r) = 0 |
Public Functions inherited from Ase::Gadget
See Ase::Gadget
| Type | Name |
|---|---|
| virtual GadgetImpl * | _parent () const = 0 Retrieve parent container. |
| ProjectImpl * | _project () const Find Project in parent ancestry. |
| virtual void | _set_parent (GadgetImpl * parent) = 0 Assign parent container. |
| virtual PropertyS | access_properties () = 0 Retrieve handles for all properties. |
| virtual PropertyP | access_property (String ident) Retrieve handle for a Property . |
| virtual Value | get_data (const String & key) const = 0 Retrieve session data. |
| Value | get_value (String ident) Get native property value. |
| virtual StringS | list_properties () List all property identifiers. |
| virtual bool | set_data (const String & key, const Value & v) = 0 Assign session data, prefix ephemerals with '_'. |
| bool | set_value (String ident, const Value & v) |
| virtual String | type_nick () const = 0 |
Public Functions inherited from Ase::Emittable
See Ase::Emittable
| Type | Name |
|---|---|
| virtual void | emit_event (const String & type, const String & detail, const ValueR fields={}) = 0 |
| virtual void | emit_notify (const String & detail) = 0 |
| void | js_trigger (const String & eventselector, JsTrigger callback) |
| virtual ASE_USE_RESULT Connection | on_event (const String & eventselector, const EventHandler & eventhandler) = 0 |
Public Static Functions
| Type | Name |
|---|---|
| ServerImplP | instancep () |
Public Static Functions inherited from Ase::Server
See Ase::Server
| Type | Name |
|---|---|
| Server & | instance () Retrieve global Server instance. |
| ServerP | instancep () Retrieve global Server instance as std::shared_ptr. |
Protected Types inherited from Ase::GadgetImpl
See Ase::GadgetImpl
| Type | Name |
|---|---|
| enum uint64_t | GadgetImpl |
Protected Attributes inherited from Ase::GadgetImpl
See Ase::GadgetImpl
| Type | Name |
|---|---|
| PropertyImplS | props_ |
Protected Functions inherited from Ase::GadgetImpl
See Ase::GadgetImpl
| Type | Name |
|---|---|
| virtual void | create_properties () |
| virtual String | fallback_name () const |
| uint64_t | gadget_flags () const |
| uint64_t | gadget_flags (uint64_t setbits, uint64_t mask=~uint64_t(0)) |
| virtual bool | name_ (const std::string * n, std::string * q) override |
| virtual void | serialize (WritNode & xs) override Serialize members and childern. |
| virtual | ~GadgetImpl () |
Protected Functions inherited from Ase::ObjectImpl
See Ase::ObjectImpl
| Type | Name |
|---|---|
| virtual | ~ObjectImpl () = 0 |
Protected Functions inherited from Ase::EmittableImpl
| Type | Name |
|---|---|
| virtual | ~EmittableImpl () |
Protected Functions inherited from Ase::VirtualBase
See Ase::VirtualBase
| Type | Name |
|---|---|
| virtual | ~VirtualBase () noexcept = 0 |
Protected Functions inherited from Ase::Object
See Ase::Object
| Type | Name |
|---|---|
| virtual | ~Object () = 0 |
Protected Functions inherited from Ase::VirtualBase
See Ase::VirtualBase
| Type | Name |
|---|---|
| virtual | ~VirtualBase () noexcept = 0 |
Protected Functions inherited from Ase::CustomDataContainer
| Type | Name |
|---|---|
| void | custom_data_destroy () |
| ~CustomDataContainer () |
Protected Functions inherited from Ase::Gadget
See Ase::Gadget
| Type | Name |
|---|---|
| Gadget () |
|
| virtual bool | name_ (const std::string * n, std::string * q) = 0 |
Protected Functions inherited from Ase::Object
See Ase::Object
| Type | Name |
|---|---|
| virtual | ~Object () = 0 |
Protected Functions inherited from Ase::VirtualBase
See Ase::VirtualBase
| Type | Name |
|---|---|
| virtual | ~VirtualBase () noexcept = 0 |
Protected Functions inherited from Ase::Serializable
| Type | Name |
|---|---|
| virtual void | serialize (WritNode & xs) = 0 Serialize members and childern. |
Protected Functions inherited from Ase::VirtualBase
See Ase::VirtualBase
| Type | Name |
|---|---|
| virtual | ~VirtualBase () noexcept = 0 |
Protected Functions inherited from Ase::Gadget
See Ase::Gadget
| Type | Name |
|---|---|
| Gadget () |
|
| virtual bool | name_ (const std::string * n, std::string * q) = 0 |
Protected Functions inherited from Ase::Object
See Ase::Object
| Type | Name |
|---|---|
| virtual | ~Object () = 0 |
Protected Functions inherited from Ase::VirtualBase
See Ase::VirtualBase
| Type | Name |
|---|---|
| virtual | ~VirtualBase () noexcept = 0 |
Protected Static Functions inherited from Ase::GadgetImpl
See Ase::GadgetImpl
| Type | Name |
|---|---|
| String | canonify_key (const String & input) |
Public Types Documentation
typedef Block
using Ase::ServerImpl::Block = FastMemory::Block;
Public Functions Documentation
function ServerImpl
explicit Ase::ServerImpl::ServerImpl ()
function access_preference
PropertyP Ase::ServerImpl::access_preference (
const String & ident
) override
function broadcast_telemetry
bool Ase::ServerImpl::broadcast_telemetry (
const TelemetrySegmentS & plan,
int32 interval_ms
) override
function create_project
ProjectP Ase::ServerImpl::create_project (
String projectname
) override
function error_blurb
String Ase::ServerImpl::error_blurb (
Error error
) override const
function get_build_id
String Ase::ServerImpl::get_build_id () override
function get_clap_version
String Ase::ServerImpl::get_clap_version () override
function get_data
Value Ase::ServerImpl::get_data (
const String & key
) override const
function get_flac_version
String Ase::ServerImpl::get_flac_version () override
function get_opus_version
String Ase::ServerImpl::get_opus_version () override
function get_version
String Ase::ServerImpl::get_version () override
function last_project
ProjectP Ase::ServerImpl::last_project () override
function list_preferences
StringS Ase::ServerImpl::list_preferences () override
function musical_tuning_blurb
String Ase::ServerImpl::musical_tuning_blurb (
MusicalTuning musicaltuning
) override const
function musical_tuning_label
String Ase::ServerImpl::musical_tuning_label (
MusicalTuning musicaltuning
) override const
function set_data
bool Ase::ServerImpl::set_data (
const String & key,
const Value & v
) override
function shutdown
void Ase::ServerImpl::shutdown () override
function telemem_allocate
Block Ase::ServerImpl::telemem_allocate (
uint32 length
) const
function telemem_release
void Ase::ServerImpl::telemem_release (
Block telememblock
) const
function telemem_start
ptrdiff_t Ase::ServerImpl::telemem_start () const
function user_note
uint64 Ase::ServerImpl::user_note (
const String & text,
const String & channel="misc",
UserNote::Flags flags=UserNote::TRANSIENT,
const String & rest=""
) override
function user_reply
bool Ase::ServerImpl::user_reply (
uint64 noteid,
uint r
) override
function ~ServerImpl
virtual Ase::ServerImpl::~ServerImpl ()
Public Static Functions Documentation
function instancep
static ServerImplP Ase::ServerImpl::instancep ()
The documentation for this class was generated from the following file /__w/anklang/anklang/ase/server.hh