Server

#include "api.hh"

Inheritance diagram for Server:

Public Types
using	ServerP = std::shared_ptr< Server >

Public Member Functions
virtual PropertyP	access_preference (const String &ident)=0
virtual bool	broadcast_telemetry (const TelemetrySegmentS &segments, int32 interval_ms)=0
virtual ProjectP	create_project (String projectname)=0
ResourceCrawlerP	dir_crawler (const String &cwd="")
String	engine_stats ()
virtual String	error_blurb (Error error) const =0
virtual String	get_build_id ()=0
virtual String	get_clap_version ()=0
virtual String	get_flac_version ()=0
virtual String	get_opus_version ()=0
virtual String	get_version ()=0
virtual ProjectP	last_project ()=0
virtual StringS	list_preferences ()=0
virtual String	musical_tuning_blurb (MusicalTuning musicaltuning) const =0
virtual String	musical_tuning_label (MusicalTuning musicaltuning) const =0
virtual void	shutdown ()=0
ResourceCrawlerP	url_crawler (const String &url="/")
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 Member Functions inherited from Gadget
virtual GadgetImpl *	_parent () const =0
ProjectImpl *	_project () const
virtual void	_set_parent (GadgetImpl *parent)=0
virtual PropertyS	access_properties ()=0
virtual PropertyP	access_property (String ident)
virtual Value	get_data (const String &key) const =0
Value	get_value (String ident)
virtual StringS	list_properties ()
virtual bool	set_data (const String &key, const Value &v)=0
bool	set_value (String ident, const Value &v)
virtual String	type_nick () const =0
Public Member Functions inherited from Emittable
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

Static Public Member Functions
static Server &	instance ()
static ServerP	instancep ()

Additional Inherited Members
Public Attributes inherited from Gadget
Member<&Gadget::name_ >	name
Protected Member Functions inherited from Gadget
	Gadget ()
virtual bool	name_ (const std::string *n, std::string *q)=0
Protected Member Functions inherited from Object
virtual	~Object ()=0
Protected Member Functions inherited from VirtualBase
virtual	~VirtualBase () noexcept=0

Detailed Description

Central singleton, serves as API entry point.

Member Typedef Documentation

ServerP

using ServerP = std::shared_ptr<Server>

Member Function Documentation

instance()

Server & instance ( )

static

Retrieve global Server instance.

instancep()

ServerP instancep ( )

static

Retrieve global Server instance as std::shared_ptr.

shutdown()

virtual void shutdown ( )

pure virtual

Shutdown ASE.

Implemented in ServerImpl.

get_version()

virtual String get_version ( )

pure virtual

Retrieve ASE version.

Implemented in ServerImpl.

get_build_id()

virtual String get_build_id ( )

pure virtual

Retrieve ASE build id.

Implemented in ServerImpl.

get_opus_version()

virtual String get_opus_version ( )

pure virtual

Retrieve Opus handler version.

Implemented in ServerImpl.

get_flac_version()

virtual String get_flac_version ( )

pure virtual

Retrieve FLAC handler version.

Implemented in ServerImpl.

get_clap_version()

virtual String get_clap_version ( )

pure virtual

Retrieve CLAP support version.

Implemented in ServerImpl.

error_blurb()

virtual String error_blurb ( Error error ) const

pure virtual

Implemented in ServerImpl.

musical_tuning_label()

virtual String musical_tuning_label ( MusicalTuning musicaltuning ) const

pure virtual

Implemented in ServerImpl.

musical_tuning_blurb()

virtual String musical_tuning_blurb ( MusicalTuning musicaltuning ) const

pure virtual

Implemented in ServerImpl.

user_note()

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

pure virtual

Implemented in ServerImpl.

user_reply()

virtual bool user_reply ( uint64 noteid, uint r )

pure virtual

Implemented in ServerImpl.

broadcast_telemetry()

virtual bool broadcast_telemetry ( const TelemetrySegmentS & segments, int32 interval_ms )

pure virtual

Broadcast telemetry memory segments to the current Jsonipc connection.

Implemented in ServerImpl.

list_preferences()

virtual StringS list_preferences ( )

pure virtual

Retrieve a list of all preference identifiers.

Implemented in ServerImpl.

access_preference()

virtual PropertyP access_preference ( const String & ident )

pure virtual

Retrieve property handle for a Preference identifier.

Implemented in ServerImpl.

engine_stats()

String engine_stats

(

)

Print engine state.

last_project()

virtual ProjectP last_project ( )

pure virtual

Retrieve the last created project.

Implemented in ServerImpl.

create_project()

virtual ProjectP create_project ( String projectname )

pure virtual

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

Implemented in ServerImpl.

dir_crawler()

ResourceCrawlerP dir_crawler

(

const String &

cwd = ""

)

Create crawler to navigate directories.

url_crawler()

ResourceCrawlerP url_crawler

(

const String &

url = "/"

)

Create crawler to navigate URL contents.