Inheritance diagram for Ase::ServerImpl:

[legend]

Public Types
using	Block = FastMemory::Block

Public Types inherited from Ase::GadgetImpl
using	MemberAccessF = std::function< bool(GadgetImpl , const Value , Value *)>

using	MemberInfosP = const StringS &(*)()

using	MemberClassT = bool(*)(const SharedBase &)

Public Types inherited from Ase::Server
using	ServerP = std::shared_ptr< Server >

Public Member Functions
bool	set_data (const String &key, const Value &v) override
	Assign session data, prefix ephemerals with '_'.

Value	get_data (const String &key) const override
	Retrieve session data.

String	get_version () override
	Retrieve ASE version.

String	get_build_id () override
	Retrieve ASE build id.

String	get_opus_version () override
	Retrieve Opus handler version.

String	get_flac_version () override
	Retrieve FLAC handler version.

String	get_clap_version () override
	Retrieve CLAP support version.

String	get_sndfile_version () override
	Retrieve libsndfile support version.

String	error_blurb (Error error) const override

String	musical_tuning_label (MusicalTuning musicaltuning) const override

String	musical_tuning_blurb (MusicalTuning musicaltuning) const override

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

bool	broadcast_telemetry (const TelemetrySegmentS &plan, int32 interval_ms) override
	Broadcast telemetry memory segments to the current Jsonipc connection.

void	shutdown () override
	Shutdown ASE.

ProjectP	last_project () override
	Retrieve the last created project.

ProjectP	create_project (String projectname) override
	Create a new project (name is modified to be unique if necessary.

PropertyP	access_preference (const String &ident) override
	Retrieve property handle for a Preference identifier.

StringS	list_preferences () override
	Retrieve a list of all preference identifiers.

Block	telemem_allocate (uint32 length) const

void	telemem_release (Block telememblock) const

ptrdiff_t	telemem_start () const

Public Member Functions inherited from Ase::GadgetImpl
String	get_name () const override

void	set_name (const std::string &n) override

void	_set_parent (GadgetImpl *parent) override
	Assign parent container.

GadgetImpl *	_parent () const override
	Retrieve parent container.

String	type_nick () const override

PropertyS	access_properties () override
	Retrieve handles for all properties.

template<class O , class M >
void	_register_parameter (O , M , const Param::ExtraVals &) const

Public Member Functions inherited from Ase::EmittableImpl
ASE_USE_RESULT Connection	on_event (const String &eventselector, const EventHandler &eventhandler) override

void	emit_event (const String &type, const String &detail, const ValueR fields={}) override

void	emit_notify (const String &detail) override
	Emit `notify:detail`, multiple notifications maybe coalesced if a CoalesceNotifies instance exists.

Public Member Functions inherited from Ase::Emittable
void	js_trigger (const String &eventselector, JsTrigger callback)

Public Member Functions inherited from std::enable_shared_from_this< SharedBase >
T	enable_shared_from_this (T... args)

T	operator= (T... args)

T	shared_from_this (T... args)

T	weak_from_this (T... args)

T	~enable_shared_from_this (T... args)

Public Member Functions inherited from Ase::CustomDataContainer
template<class T >
void	set_custom_data (CustomDataKey< T > *key, T data)
	Assign data to the custom keyed data member, deletes any previously set data.

template<class T >
T	get_custom_data (CustomDataKey< T > *key) const
	Retrieve contents of the custom keyed data member, returns DataKey::fallback if nothing was set.

template<class T >
bool	has_custom_data (CustomDataKey< T > *key) const
	Retrieve wether contents of the custom keyed data member exists.

template<class T >
bool	del_custom_data (CustomDataKey< T > *key)
	Delete the current contents of the custom keyed data member, invokes DataKey::destroy.

Public Member Functions inherited from Ase::Gadget
ProjectImpl *	_project () const
	Find Project in parent ancestry.

virtual StringS	list_properties ()
	List all property identifiers.

virtual PropertyP	access_property (String ident)
	Retrieve handle for a Property.

Value	get_value (String ident)
	Get native property value.

bool	set_value (String ident, const Value &v)

Public Member Functions inherited from Ase::Server
String	engine_stats ()
	Print engine state.

void	exit_program (int status=0)
	End program (without saving).

ResourceCrawlerP	dir_crawler (const String &cwd)
	Create crawler to navigate directories.

ResourceCrawlerP	url_crawler (const String &url)
	Create crawler to navigate URL contents.

Static Public Member Functions
static ServerImplP	instancep ()

Static Public Member Functions inherited from Ase::Server
static Server &	instance ()
	Retrieve global Server instance.

static ServerP	instancep ()
	Retrieve global Server instance as std::shared_ptr.

Additional Inherited Members
Public Attributes inherited from Ase::Emittable
const EventHandler &	eventhandler

Public Attributes inherited from Ase::Gadget
Member<&Gadget::get_name,&Gadget::set_name >	name

Protected Types inherited from Ase::GadgetImpl
enum	: uint64_t { GADGET_DESTROYED , DEVICE_ACTIVE , MASTER_TRACK }

Protected Member Functions inherited from Ase::GadgetImpl
uint64_t	gadget_flags () const

uint64_t	gadget_flags (uint64_t setbits, uint64_t mask=~uint64_t(0))

virtual String	fallback_name () const

void	serialize (WritNode &xs) override
	Serialize members and childern.

virtual void	create_properties ()

Protected Member Functions inherited from Ase::CustomDataContainer
void	custom_data_destroy ()

Static Protected Member Functions inherited from Ase::GadgetImpl
static String	canonify_key (const String &input)

Protected Attributes inherited from Ase::GadgetImpl
PropertyImplS	props_

Detailed Description

Definition at line 10 of file server.hh.

Member Typedef Documentation

◆ Block

using Ase::ServerImpl::Block = FastMemory::Block

Definition at line 35 of file server.hh.

Constructor & Destructor Documentation

◆ ServerImpl()

Ase::ServerImpl::ServerImpl ( )

explicit

Definition at line 26 of file server.cc.

◆ ~ServerImpl()

Ase::ServerImpl::~ServerImpl ( )

virtual

Definition at line 44 of file server.cc.

Member Function Documentation

◆ access_preference()

PropertyP Ase::ServerImpl::access_preference ( const String & ident )

overridevirtual

Retrieve property handle for a Preference identifier.

Implements Ase::Server.

Definition at line 114 of file server.cc.

◆ broadcast_telemetry()

bool Ase::ServerImpl::broadcast_telemetry	(	const TelemetrySegmentS &	segments,
		int32	interval_ms
	)

overridevirtual

Broadcast telemetry memory segments to the current Jsonipc connection.

Implements Ase::Server.

Definition at line 481 of file server.cc.

References Ase::CustomDataContainer::get_custom_data(), Ase::FastMemory::Arena::location(), and Ase::CustomDataContainer::set_custom_data().

◆ create_project()

ProjectP Ase::ServerImpl::create_project ( String projectname )

overridevirtual

Create a new project (name is modified to be unique if necessary.

Implements Ase::Server.

Definition at line 101 of file server.cc.

◆ error_blurb()

String Ase::ServerImpl::error_blurb ( Error error ) const

overridevirtual

Implements Ase::Server.

Definition at line 287 of file server.cc.

◆ get_build_id()

String Ase::ServerImpl::get_build_id ( )

overridevirtual

Retrieve ASE build id.

Implements Ase::Server.

Definition at line 58 of file server.cc.

References Ase::ase_build_id().

◆ get_clap_version()

String Ase::ServerImpl::get_clap_version ( )

overridevirtual

Retrieve CLAP support version.

Implements Ase::Server.

Definition at line 76 of file server.cc.

◆ get_data()

Value Ase::ServerImpl::get_data ( const String & key ) const

overridevirtual

Retrieve session data.

Reimplemented from Ase::GadgetImpl.

Definition at line 141 of file server.cc.

References std::string::size().

◆ get_flac_version()

String Ase::ServerImpl::get_flac_version ( )

overridevirtual

Retrieve FLAC handler version.

Implements Ase::Server.

Definition at line 70 of file server.cc.

◆ get_opus_version()

String Ase::ServerImpl::get_opus_version ( )

overridevirtual

Retrieve Opus handler version.

Implements Ase::Server.

Definition at line 64 of file server.cc.

◆ get_sndfile_version()

String Ase::ServerImpl::get_sndfile_version ( )

overridevirtual

Retrieve libsndfile support version.

Implements Ase::Server.

Definition at line 82 of file server.cc.

◆ get_version()

String Ase::ServerImpl::get_version ( )

overridevirtual

Retrieve ASE version.

Implements Ase::Server.

Definition at line 52 of file server.cc.

References Ase::ase_version().

◆ instancep()

ServerImplP Ase::ServerImpl::instancep ( )

static

Definition at line 120 of file server.cc.

◆ last_project()

ProjectP Ase::ServerImpl::last_project ( )

overridevirtual

Retrieve the last created project.

Implements Ase::Server.

Definition at line 95 of file server.cc.

◆ list_preferences()

StringS Ase::ServerImpl::list_preferences ( )

overridevirtual

Retrieve a list of all preference identifiers.

Implements Ase::Server.

Definition at line 107 of file server.cc.

References std::begin(), and std::end().

◆ musical_tuning_blurb()

String Ase::ServerImpl::musical_tuning_blurb ( MusicalTuning musicaltuning ) const

overridevirtual

Implements Ase::Server.

Definition at line 395 of file server.cc.

◆ musical_tuning_label()

String Ase::ServerImpl::musical_tuning_label ( MusicalTuning musicaltuning ) const

overridevirtual

Implements Ase::Server.

Definition at line 401 of file server.cc.

◆ set_data()

bool Ase::ServerImpl::set_data	(	const String &	key,
		const Value &	v
	)

overridevirtual

Assign session data, prefix ephemerals with '_'.

Reimplemented from Ase::GadgetImpl.

Definition at line 127 of file server.cc.

References Ase::Value::as_string(), and std::string::size().

◆ shutdown()

void Ase::ServerImpl::shutdown ( )

overridevirtual

Shutdown ASE.

Implements Ase::Server.

Definition at line 88 of file server.cc.

◆ telemem_allocate()

ServerImpl::Block Ase::ServerImpl::telemem_allocate ( uint32 length ) const

Definition at line 430 of file server.cc.

◆ telemem_release()

void Ase::ServerImpl::telemem_release ( Block telememblock ) const

Definition at line 436 of file server.cc.

◆ telemem_start()

ptrdiff_t Ase::ServerImpl::telemem_start ( ) const

Definition at line 442 of file server.cc.

◆ user_note()

uint64 Ase::ServerImpl::user_note	(	const String &	text,
		const String &	channel = `"misc"`,
		UserNote::Flags	flags = `UserNote::TRANSIENT`,
		const String &	rest = `""`
	)

overridevirtual

Implements Ase::Server.

Definition at line 409 of file server.cc.

◆ user_reply()

bool Ase::ServerImpl::user_reply	(	uint64	noteid,
		uint	r
	)

overridevirtual

Implements Ase::Server.

Definition at line 424 of file server.cc.

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

ase/server.hh
ase/server.cc

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Block

Constructor & Destructor Documentation

◆ ServerImpl()

◆ ~ServerImpl()

Member Function Documentation

◆ access_preference()

◆ broadcast_telemetry()

◆ create_project()

◆ error_blurb()

◆ get_build_id()

◆ get_clap_version()

◆ get_data()

◆ get_flac_version()

◆ get_opus_version()

◆ get_sndfile_version()

◆ get_version()

◆ instancep()

◆ last_project()

◆ list_preferences()

◆ musical_tuning_blurb()

◆ musical_tuning_label()

◆ set_data()

◆ shutdown()

◆ telemem_allocate()

◆ telemem_release()

◆ telemem_start()

◆ user_note()

◆ user_reply()