This class is used for registering scripts with an external registry.
More...
#include <script3.h>
Inheritance diagram for ost::ScriptRegistry:
Collaboration diagram for ost::ScriptRegistry:
Public Types
enum
symType {
symNORMAL = 0,
symCONST,
symDYNAMIC,
symFIFO,
symSEQUENCE,
symSTACK,
symCOUNTER,
symPOINTER,
symREF,
symARRAY,
symASSOC,
symINITIAL,
symNUMBER,
symLOCK,
symPROPERTY,
symORIGINAL,
symMODIFIED,
symTIMER,
symBOOL
}
typedef bool(ScriptInterp::*
Method )(void)
typedef long(*
Function )(long *args, unsigned prec)
typedef void(*
Init )(void)
Public Member Functions
Set a new start time for the object based on when this call is made and optionally activate the timer for a specified number of milliseconds.
More...
Set a timeout based on the current time reference value either from object creation or the last
setTimer().
More...
Adjust a timeout based on the current time reference value either from object creation or the last
setTimer().
More...
Sleep until the current timer expires.
More...
This is used to "disable" the service thread from expiring the timer object.
More...
This is used by service threads to determine how much time remains before the timer expires based on a timeout specified in
setTimer() or
incTimer().
More...
This is used to determine how much time has elapsed since a timer port setTimer benchmark time was initially set.
More...
Static Public Member Functions
static bool
use (const char *name)
static unsigned
getIndex (const char *id)
Data Fields
Static Public Attributes
Static Protected Attributes
Detailed Description
This class is used for registering scripts with an external registry.
Sometimes this is used as a base class for a more complete one.
- Author
- David Sugar dyfet.nosp@m.@ost.nosp@m.el.co.nosp@m.m Registry for script objects.
Definition at line 1676 of file script3.h.
Member Typedef Documentation
typedef bool(* ost::Script::Cond)(
ScriptInterp *interp, const char *v)
inherited |
typedef long(* ost::Script::Function)(long *args, unsigned prec)
inherited |
typedef void(* ost::Script::Init)(void)
inherited |
typedef const char*(* ost::Script::Meta)(
ScriptInterp *interp, const char *token)
inherited |
typedef bool(ScriptInterp::* ost::Script::Method)(void)
inherited |
typedef const char*(* ost::Script::Parse)(
ScriptCompiler *img, const char *token)
inherited |
Member Enumeration Documentation
| Enumerator |
|---|
| scrPUBLIC |
| scrPROTECTED |
| scrPRIVATE |
| scrFUNCTION |
| scrLOCAL |
Definition at line 113 of file script3.h.
| Enumerator |
|---|
| symNORMAL |
| symCONST |
| symDYNAMIC |
| symFIFO |
| symSEQUENCE |
| symSTACK |
| symCOUNTER |
| symPOINTER |
| symREF |
| symARRAY |
| symASSOC |
| symINITIAL |
| symNUMBER |
| symLOCK |
| symPROPERTY |
| symORIGINAL |
| symMODIFIED |
| symTIMER |
| symBOOL |
Definition at line 123 of file script3.h.
Member Function Documentation
static void ost::Script::addConditional
(
const char *
name,
)
staticinherited |
static void ost::Script::addFunction
(
const char *
name,
unsigned
count,
)
staticinherited |
static bool ost::Script::append
(
Symbol *
sym,
const char *
value
)
staticinherited |
static void ost::Script::clear
(
Symbol *
sym )
staticinherited |
static bool ost::Script::commit
(
Symbol *
sym,
const char *
value
)
staticinherited |
static unsigned ost::Script::count
(
Symbol *
sym )
staticinherited |
void TimerPort::decTimer
(
timeout_t
timeout )
inherited |
Adjust a timeout based on the current time reference value either from object creation or the last setTimer().
This reference can be used to time synchronize realtime data over specified intervals and force expiration when a new frame should be released in a synchronized manner.
- Parameters
-
timeout delay in milliseconds from reference.
void TimerPort::endTimer
(
void
)
inherited |
This is used to "disable" the service thread from expiring the timer object.
It does not effect the reference time from either creation or a setTimer().
static const char* ost::Script::extract
(
Symbol *
sym )
staticinherited |
timeout_t TimerPort::getElapsed
(
void
)
const
inherited |
This is used to determine how much time has elapsed since a timer port setTimer benchmark time was initially set.
This allows one to use setTimer() to set the timer to the current time and then measure elapsed time from that point forward.
return time elapsed in milliseconds, or TIMEOUT_INF if inactive.
static unsigned ost::Script::getIndex
(
const char *
id )
staticinherited |
This is used by service threads to determine how much time remains before the timer expires based on a timeout specified in setTimer() or incTimer().
It can also be called after setting a timeout with incTimer() to see if the current timeout has already expired and hence that the application is already delayed and should skip frame(s).
return time remaining in milliseconds, or TIMEOUT_INF if inactive.
void TimerPort::incTimer
(
timeout_t
timeout )
inherited |
Set a timeout based on the current time reference value either from object creation or the last setTimer().
This reference can be used to time synchronize realtime data over specified intervals and force expiration when a new frame should be released in a synchronized manner.
- Parameters
-
timeout delay in milliseconds from reference.
static bool ost::Script::isFunction
(
Name *
scr )
staticinherited |
static bool ost::Script::isPrivate
(
Name *
scr )
staticinherited |
static bool ost::Script::isScript
(
Name *
scr )
staticinherited |
static bool ost::Script::isSymbol
(
const char *
id )
staticinherited |
void TimerPort::setTimer
(
timeout_t
timeout =
0 )
inherited |
Set a new start time for the object based on when this call is made and optionally activate the timer for a specified number of milliseconds.
This can be used to set the starting time of a realtime session.
- Parameters
-
timeout delay in milliseconds from "now"
void TimerPort::sleepTimer
(
void
)
inherited |
Sleep until the current timer expires.
This is useful in time syncing realtime periodic tasks.
static unsigned ost::Script::storage
(
Symbol *
sym )
staticinherited |
static bool ost::Script::symindex
(
Symbol *
sym,
short
offset
)
staticinherited |
static bool ost::Script::use
(
const char *
name )
staticinherited |
Field Documentation
const char* ost::Script::access_host
staticinherited |
const char* ost::Script::access_pass
staticinherited |
const char* ost::Script::access_user
staticinherited |
const char* ost::Script::altplugins
staticinherited |
const char* ost::Script::apps_extensions
staticinherited |
const char* ost::Script::apps_prefix
staticinherited |
unsigned ost::Script::autoStepping
staticinherited |
char ost::Script::decimal
staticinherited |
const char* ost::Script::etc_prefix
staticinherited |
const char* ost::Script::exec_extensions
staticinherited |
bool ost::Script::exec_funcs
staticinherited |
const char* ost::Script::exec_prefix
staticinherited |
const char* ost::Script::exec_token
staticinherited |
const char* ost::Script::exit_token
staticinherited |
bool ost::Script::fastStart
staticinherited |
unsigned ost::Script::fastStepping
staticinherited |
Line* ost::ScriptRegistry::line
const char* ost::Script::log_prefix
staticinherited |
size_t ost::Script::pagesize
staticinherited |
const char* ost::Script::plugins
staticinherited |
const char* ost::ScriptRegistry::protocol
Name* ost::ScriptRegistry::scr
unsigned ost::Script::symlimit
staticinherited |
unsigned ost::Script::symsize
staticinherited |
bool ost::Script::use_definitions
staticinherited |
bool ost::Script::use_funcs
staticinherited |
bool ost::Script::use_macros
staticinherited |
bool ost::Script::use_merge
staticinherited |
bool ost::Script::use_prefix
staticinherited |
bool ost::Script::useBigmem
staticinherited |
const char* ost::Script::var_prefix
staticinherited |
The documentation for this class was generated from the following file:
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