Ingen  0.5.1
Public Member Functions | Protected Member Functions | List of all members
Ingen::Client::SigClientInterface Class Reference

A LibSigC++ signal emitting interface for clients to use. More...

#include <SigClientInterface.hpp>

+ Inheritance diagram for Ingen::Client::SigClientInterface:
+ Collaboration diagram for Ingen::Client::SigClientInterface:

Public Member Functions

Raul::URI uri () const
 
virtual bool emit_signals ()
 Fire pending signals. More...
 
- Public Member Functions inherited from Ingen::Interface
virtual SPtr< Interfacerespondee () const
 
virtual void set_respondee (SPtr< Interface > respondee)
 

Protected Member Functions

void bundle_begin ()
 Begin a transaction. More...
 
void bundle_end ()
 End a transaction. More...
 
void response (int32_t id, Status status, const std::string &subject)
 
void error (const std::string &msg)
 
void put (const Raul::URI &uri, const Resource::Properties &properties, Resource::Graph ctx=Resource::Graph::DEFAULT)
 
void delta (const Raul::URI &uri, const Resource::Properties &remove, const Resource::Properties &add)
 
void connect (const Raul::Path &tail, const Raul::Path &head)
 
void del (const Raul::URI &uri)
 
void copy (const Raul::URI &old_uri, const Raul::URI &new_uri)
 
void move (const Raul::Path &old_path, const Raul::Path &new_path)
 
void disconnect (const Raul::Path &tail, const Raul::Path &head)
 
void disconnect_all (const Raul::Path &graph, const Raul::Path &path)
 
void set_property (const Raul::URI &subject, const Raul::URI &key, const Atom &value)
 
void undo ()
 
void redo ()
 
void set_response_id (int32_t id)
 Set the ID to use to respond to the next message. More...
 
void get (const Raul::URI &uri)
 

Detailed Description

A LibSigC++ signal emitting interface for clients to use.

This simply emits a signal for every event that comes from the engine. For a higher level model based view of the engine, use ClientStore.

The signals here match the calls to ClientInterface exactly. See the documentation for ClientInterface for meanings of signal parameters.

Member Function Documentation

§ emit_signals()

virtual bool Ingen::Client::SigClientInterface::emit_signals ( )
inlinevirtual

Fire pending signals.

Only does anything on derived classes (that may queue)

Reimplemented in Ingen::Client::ThreadedSigClientInterface.

§ bundle_begin()

void Ingen::Client::SigClientInterface::bundle_begin ( )
inlineprotectedvirtual

Begin a transaction.

This does not guarantee strict atomicity, but the events in a bundle will be considered one operation, and they will all be undone at once.

Implements Ingen::Interface.

Reimplemented in Ingen::Client::ThreadedSigClientInterface.

§ bundle_end()

void Ingen::Client::SigClientInterface::bundle_end ( )
inlineprotectedvirtual

End a transaction.

Implements Ingen::Interface.

Reimplemented in Ingen::Client::ThreadedSigClientInterface.

§ set_response_id()

void Ingen::Client::SigClientInterface::set_response_id ( int32_t  id)
inlineprotectedvirtual

Set the ID to use to respond to the next message.

Setting the ID to 0 will disable responses.

Implements Ingen::Interface.


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