ost::ScriptEngine Class Reference

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

#include <bayonne.h>

List of all members.

Protected Member Functions
virtual bool	signalEngine (Bayonne::signal_t signal)=0
	Signal bridge about Bayonne signal event.
virtual void	releaseEngine (void)=0
	Release bridge session because we moved.
virtual void	disconnectEngine (void)=0
	Disconnect bridge session for hangup/stopping of processing.
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.
virtual	~ScriptEngine ()=0
	If not detached thread we may delete it ourselves.
void	clearEngine (BayonneSession *s)
void	setEngine (BayonneSession *s)
	Set vm session.
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@gnutelephony.org> vm scripting interface bridge.

---

Constructor & Destructor Documentation

virtual ost::ScriptEngine::~ScriptEngine

(

)

[protected, pure virtual]

If not detached thread we may delete it ourselves.

---

Member Function Documentation

void ost::ScriptEngine::clearEngine

(

BayonneSession *

s

)

[inline, protected]

virtual void ost::ScriptEngine::disconnectEngine

(

void

)

[protected, pure 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

)

[protected, pure virtual]

Release bridge session because we moved.

If detached thread then should also NULL the vm pointer.

void ost::ScriptEngine::setEngine

(

BayonneSession *

s

)

[inline, protected]

Set vm session.

virtual bool ost::ScriptEngine::signalEngine

(

Bayonne::signal_t

signal

)

[protected, pure virtual]

Signal bridge about Bayonne signal event.

Parameters:

bayonne

signal event

Returns:

true if claimed by scripting engine

virtual bool ost::ScriptEngine::stepEngine

(

void

)

[protected, pure 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]

---

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

• bayonne.h