Bayonne2 / Common C++ 2 Framework: ost::ScriptEngine Class Reference

Bayonne2 / Common C++ 2 Framework

[フレーム]

Protected Member Functions | Friends

ost::ScriptEngine Class Referenceabstract

Offers interface bridge for embedded scripting engines through an abstract interface. More...

#include <bayonne.h>

Protected Member Functions

virtual bool signalEngine (Bayonne::signal_t signal)=0

Signal bridge about Bayonne signal event. More...

virtual void releaseEngine (void)=0

Release bridge session because we moved. More...

virtual void disconnectEngine (void)=0

Disconnect bridge session for hangup/stopping of processing. More...

virtual bool stepEngine (void)=0

Step notification, often used to signal completion handler so bridge can change state of Bayonne engine and then wait for completion by notification at running state again. More...

virtual ~ScriptEngine ()=0

If not detached thread we may delete it ourselves. More...

void clearEngine (BayonneSession *s)

void setEngine (BayonneSession *s)

Set vm session. More...

Friends

class __EXPORT BayonneSession

Detailed Description

Offers interface bridge for embedded scripting engines through an abstract interface.

This may be used to support calling of integrated virtual machines, etc.

Author: David Sugar dyfet.nosp@m.@gnu.nosp@m.telep.nosp@m.hony.nosp@m..org vm scripting interface bridge.

Definition at line 3373 of file bayonne.h.

Constructor & Destructor Documentation

virtual ost::ScriptEngine::~ScriptEngine ( )

protectedpure virtual

If not detached thread we may delete it ourselves.

Member Function Documentation

void ost::ScriptEngine::clearEngine ( BayonneSession * s )

inlineprotected

Definition at line 3416 of file bayonne.h.

virtual void ost::ScriptEngine::disconnectEngine ( void )

protectedpure virtual

Disconnect bridge session for hangup/stopping of processing.

If detached thread, then should also NULL the vm pointer.

virtual void ost::ScriptEngine::releaseEngine ( void )

protectedpure virtual

Release bridge session because we moved.

If detached thread then should also NULL the vm pointer.

void ost::ScriptEngine::setEngine ( BayonneSession * s )

inlineprotected

Set vm session.

Definition at line 3422 of file bayonne.h.

virtual bool ost::ScriptEngine::signalEngine ( Bayonne::signal_t signal )

protectedpure virtual

Signal bridge about Bayonne signal event.

Parameters: bayonne signal event

Returns: true if claimed by scripting engine

virtual bool ost::ScriptEngine::stepEngine ( void )

protectedpure virtual

Step notification, often used to signal completion handler so bridge can change state of Bayonne engine and then wait for completion by notification at running state again.

Hence we often use a Common C++ "Event" object for completion notify.

Parameters: true if to continue step counter also.

Friends And Related Function Documentation

friend class __EXPORT BayonneSession

friend

Definition at line 3376 of file bayonne.h.

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

bayonne.h

Generated on Dec 21, 2017 for commoncpp2-1.8.1, ccrtp-1.7.2, libzrtpcpp-2.3.4, ccscript3-1.1.7, ccaudio2-1.0.0 and bayonne2-2.3.2 (after installation in /usr/local/) by doxygen 1.8.6