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

static BayonneSession * startDialing (const char *dial, const char *name, const char *caller, const char *display, BayonneSession *parent=NULL, const char *manager=NULL, const char *secret=NULL)

Start a dialing session. More...

static BayonneSession * getSid (const char *id)

Returns a session pointer for a string identifier. More...

static timeslot_t toTimeslot (const char *id)

Returns a server timeslot number for a string identifier. More...

static timeslot_t getTimeslotsUsed (void)

Return total library timeslots used (highest used). More...

static timeslot_t getTimeslotCount (void)

Return total timeslots allocated for the server. More...

static timeslot_t getAvailTimeslots (void)

Return remaining timeslots available to allocate driver ports into. More...

static Handler getState (const char *name)

Map a state name into a handler. More...

static int getDigit (char dtmf)

Convert a dtmf character into a 0-15 number reference. More...

static char getChar (int dtmf)

Convert a dtmf digit number into it's ascii code. More...

static bool matchDigits (const char *digits, const char *match, bool partial=false)

A function to support pattern matching and templates for digit strings. More...

static ScriptImage * useImage (void)

Use the current compiled script image; mark as in use. More...

static void endImage (ScriptImage *image)

Release a script image in use. More...

static bool loadPlugin (const char *path)

Load a plugin module. More...

static bool loadMonitor (const char *path)

Load a monitoring/management module. More...

static bool loadAudio (const char *path)

Load a bgm/audio processing module for continues audio. More...

static void errlog (const char *level, const char *fmt,...)

static bool getUserdata (void)

static void addTrap4 (const char *addr)

static bool isScript (Name *scr)

static bool isSymbol (const char *id)

static bool use (const char *name)

static unsigned getIndex (const char *id)

static Symbol * deref (Symbol *sym)

static bool commit (Symbol *sym, const char *value)

static bool append (Symbol *sym, const char *value)

static bool symindex (Symbol *sym, short offset)

static const char * extract (Symbol *sym)

static unsigned count (Symbol *sym)

static unsigned storage (Symbol *sym)

static void clear (Symbol *sym)

static void addFunction (const char *name, unsigned count, Function i)

static void addConditional (const char *name, Cond test)

static bool isPrivate (Name *scr)

static bool isFunction (Name *scr)

Data Fields

result_t result

char digits [64]

char query [512]

char position [32]

unsigned exitcode

unsigned reply

class __EXPORT Line

class __EXPORT Name

Static Public Attributes

static char dtmf_keymap [256]

static timeout_t step_timer

static timeout_t reset_timer

static timeout_t exec_timer

static unsigned compile_count

static volatile bool image_loaded

static BayonneTranslator * init_translator

static const char * init_voicelib

static const char * trap_community

static AtomicCounter libexec_count

static statetab states []

Table of states ordered by id. More...

static Mutex serialize

A mutex to serialize any direct console I/O operations. More...

static ThreadLock reloading

A mutex to serialize reload requests. More...

static Traffic total_call_attempts

master traffic counters for call attempts and call completions. More...

static Traffic total_call_complete

static volatile unsigned short total_active_calls

static bool fastStart

static bool useBigmem

static unsigned fastStepping

static unsigned autoStepping

static size_t pagesize

static unsigned symsize

static unsigned symlimit

static char decimal

static bool use_definitions

static bool use_macros

static bool use_prefix

static bool use_merge

static bool use_funcs

static const char * plugins

static const char * altplugins

static const char * access_user

static const char * access_pass

static const char * access_host

static bool exec_funcs

static const char * exec_extensions

static const char * exec_token

static const char * exec_prefix

static const char * exit_token

static const char * apps_extensions

static const char * apps_prefix

static const char * etc_prefix

static const char * var_prefix

static const char * log_prefix

Protected Attributes

Keydata head

Keydata args

const char * tsid

const char * voice

Audio::Level level

Static Protected Attributes

static BayonneSession ** timeslots

static ScriptImage ** localimages

static char * status

static ScriptCommand * server

static unsigned ts_trk

static unsigned ts_ext

static timeslot_t ts_limit

static timeslot_t ts_count

static timeslot_t ts_used

static std::ostream * logging

static const char * path_prompts

static const char * path_tmpfs

static const char * path_tmp

static unsigned idle_count

static unsigned idle_limit

static bool shutdown_flag

static char sla [64]

static time_t start_time

static time_t reload_time

static Test * test

static Fun * ifun

Detailed Description

Container class for applications implimenting the libexec process method of Bayonne interfacing.

This is intended for writing external apps and is neatly tucked away into libbayonne as well.

Author: David Sugar dyfet.nosp@m.@gnu.nosp@m.telep.nosp@m.hony.nosp@m..org Libexec process interface class.

Definition at line 63 of file libexec.h.

Member Typedef Documentation

typedef struct ost::Script::_array ost::Script::Array

inherited

typedef const char*(ScriptCommand::* ost::Script::Check)(Line *line, ScriptImage *img)

inherited

Definition at line 106 of file script3.h.

typedef bool(* ost::Script::Cond)(ScriptInterp *interp, const char *v)

inherited

Definition at line 107 of file script3.h.

typedef long(* ost::Script::Function)(long *args, unsigned prec)

inherited

Definition at line 108 of file script3.h.

typedef bool(BayonneSession::* ost::Bayonne::Handler)(Event *event)

inherited

The current state handler in effect for a given channel to receive events.

This is done by a direct method pointer for fast processing.

Definition at line 909 of file bayonne.h.

typedef void(* ost::Script::Init)(void)

inherited

Definition at line 111 of file script3.h.

typedef const char*(* ost::Script::Meta)(ScriptInterp *interp, const char *token)

inherited

Definition at line 109 of file script3.h.

typedef bool(ScriptInterp::* ost::Script::Method)(void)

inherited

Definition at line 105 of file script3.h.

typedef const char*(* ost::Script::Parse)(ScriptCompiler *img, const char *token)

inherited

Definition at line 110 of file script3.h.

typedef rpcint_t ost::Bayonne::rpcbool_t

inherited

Definition at line 276 of file bayonne.h.

typedef int32_t ost::Bayonne::rpcint_t

inherited

Definition at line 274 of file bayonne.h.

typedef void(* ost::Bayonne::rpcmethod_t)(BayonneRPC *rpc)

inherited

A rpc method handler.

Definition at line 858 of file bayonne.h.

typedef enum scrAccess ost::Script::scrAccess

inherited

Definition at line 121 of file script3.h.

typedef struct ost::Script::_symbol ost::Script::Symbol

inherited

typedef enum symType ost::Script::symType

inherited

Definition at line 145 of file script3.h.

typedef uint16_t ost::Bayonne::timeslot_t

inherited

Definition at line 273 of file bayonne.h.

Member Enumeration Documentation

enum ost::Bayonne::bridge_t

inherited

Type of bridge used for joining ports.

Enumerator
BR_TDM
BR_INET
BR_SOFT
BR_GATE
BR_NONE

Definition at line 344 of file bayonne.h.

enum ost::Bayonne::calltype_t

inherited

Type of call session being processed.

Enumerator
NONE
INCOMING
OUTGOING
PICKUP
FORWARDED
RECALL
DIRECT
RINGING
VIRTUAL

Definition at line 328 of file bayonne.h.

enum ost::Bayonne::event_t

inherited

Primary event identifiers.

These are the events that can be passed into the Bayonne state machine. They are broken into categories.

Enumerator
MSGPORT_WAKEUP
MSGPORT_SHUTDOWN
MSGPORT_LOGGING
MSGPORT_REGISTER
ENTER_STATE
EXIT_STATE
EXIT_THREAD
EXIT_TIMER
EXIT_PARTING
NULL_EVENT
ERROR_STATE
ENTER_HUNTING
EXIT_HUNTING
ENTER_RECONNECT
EXIT_RECONNECT
RECALL_RECONNECT
EXIT_SCRIPT
STEP_SCRIPT
START_DIRECT
START_INCOMING
START_OUTGOING
START_RECALL
START_FORWARDED
START_RINGING
START_HUNTING
START_REFER
STOP_SCRIPT
STOP_DISCONNECT
STOP_PARENT
CANCEL_CHILD
DETACH_CHILD
CHILD_RUNNING
CHILD_FAILED
CHILD_INVALID
CHILD_EXPIRED
CHILD_BUSY
CHILD_FAX
CHILD_DND
CHILD_AWAY
CHILD_NOCODEC
CHILD_OFFLINE
START_SCRIPT
START_SELECTED
START_TRANSFER
ENTER_LIBEXEC
EXIT_LIBEXEC
HEAD_LIBEXEC
ARGS_LIBEXEC
GOT_LIBEXEC
READ_LIBEXEC
DROP_LIBEXEC
STAT_LIBEXEC
PROMPT_LIBEXEC
CLEAR_LIBEXEC
WAIT_LIBEXEC
RECORD_LIBEXEC
REPLAY_LIBEXEC
RESTART_LIBEXEC
TONE_LIBEXEC
XFER_LIBEXEC
POST_LIBEXEC
ERROR_LIBEXEC
TIMER_EXPIRED
LINE_WINK
LINE_PICKUP
LINE_HANGUP
LINE_DISCONNECT
LINE_ON_HOOK
LINE_OFF_HOOK
RING_ON
RING_OFF
RING_STOP
LINE_CALLER_ID
RINGING_DID
DEVICE_BLOCKED
DEVICE_UNBLOCKED
DEVICE_OPEN
DEVICE_CLOSE
DSP_READY
RING_SYNC
CALL_DETECT
CALL_CONNECTED
CALL_RELEASED
CALL_ACCEPTED
CALL_ANSWERED
CALL_HOLD
CALL_HOLDING
CALL_NOHOLD
CALL_DIGITS
CALL_OFFERED
CALL_ANI
CALL_ACTIVE
CALL_NOACTIVE
CALL_BILLING
CALL_RESTART
CALL_SETSTATE
CALL_FAILURE
CALL_ALERTING
CALL_INFO
CALL_BUSY
CALL_DIVERT
CALL_FACILITY
CALL_FRAME
CALL_NOTIFY
CALL_NSI
CALL_RINGING
CALL_DISCONNECT
CALL_CLEARED
CALL_PROCEEDING
RESTART_FAILED
RELEASE_FAILED
START_RING
STOP_RING
CLEAR_TIMESLOT
START_FLASH
STOP_FLASH
DIAL_CONNECT
DIAL_TIMEOUT
DIAL_FAILED
DIAL_INVALID
DIAL_BUSY
DIAL_FAX
DIAL_PAM
DIAL_DND
DIAL_AWAY
DIAL_OFFLINE
DIAL_NOCODEC
DIAL_MACHINE
AUDIO_IDLE
AUDIO_ACTIVE
AUDIO_EXPIRED
INPUT_PENDING
OUTPUT_PENDING
AUDIO_BUFFER
TONE_IDLE
DTMF_KEYDOWN
DTMF_KEYSYNC
DTMF_KEYUP
TONE_START
TONE_STOP
AUDIO_START
AUDIO_STOP
DTMF_GENDOWN
DTMF_GENUP
AUDIO_SYNC
AUDIO_RECONNECT
AUDIO_DISCONNECT
PEER_RECONNECT
PEER_DISCONNECT
PEER_REFER
DTMF_GENTONE
MAKE_TEST
MAKE_BUSY
MAKE_IDLE
MAKE_DOWN
MAKE_UP
MAKE_EXPIRED
ENABLE_LOGGING
DISABLE_LOGGING
PART_EXPIRED
PART_EXITING
PART_DISCONNECT
JOIN_PEER
PEER_WAITING
RELOCATE_REQUEST
RELOCATE_ACCEPT
RELOCATE_REJECT
START_RELOCATE
STREAM_ACTIVE
STREAM_PASSIVE
JOIN_RECALL
DROP_RECALL
DROP_REFER
ENTER_RESUME
ENTER_SUSPEND
SYSTEM_DOWN
DRIVER_SPECIFIC

Definition at line 464 of file bayonne.h.

enum ost::Bayonne::interface_t

inherited

Telephony endpoint interface identifiers.

Enumerator
IF_PSTN
IF_SPAN
IF_ISDN
IF_SS7
IF_INET
IF_NONE
IF_POTS

Definition at line 314 of file bayonne.h.

enum ost::Bayonne::result_t

inherited

Enumerator
RESULT_SUCCESS
RESULT_TIMEOUT
RESULT_INVALID
RESULT_PENDING
RESULT_COMPLETE
RESULT_FAILED
RESULT_BADPATH
RESULT_OFFLINE

Definition at line 683 of file bayonne.h.

enum ost::Script::scrAccess

inherited

Enumerator
scrPUBLIC
scrPROTECTED
scrPRIVATE
scrFUNCTION
scrLOCAL

Definition at line 113 of file script3.h.

enum ost::Bayonne::signal_t

inherited

Signaled interpreter events.

These can be masked and accessed through ^xxx handlers in the scripting language.

Enumerator
SIGNAL_EXIT
SIGNAL_ERROR
SIGNAL_TIMEOUT
SIGNAL_DTMF
SIGNAL_0
SIGNAL_1
SIGNAL_2
SIGNAL_3
SIGNAL_4
SIGNAL_5
SIGNAL_6
SIGNAL_7
SIGNAL_8
SIGNAL_9
SIGNAL_STAR
SIGNAL_POUND
SIGNAL_A
SIGNAL_OVERRIDE
SIGNAL_B
SIGNAL_FLASH
SIGNAL_C
SIGNAL_IMMEDIATE
SIGNAL_D
SIGNAL_PRIORITY
SIGNAL_RING
SIGNAL_TONE
SIGNAL_EVENT
SIGNAL_WINK
SIGNAL_CHILD
SIGNAL_FAIL
SIGNAL_PICKUP
SIGNAL_PART
SIGNAL_INVALID
SIGNAL_PARENT
SIGNAL_WAIT
SIGNAL_HANGUP

Definition at line 414 of file bayonne.h.

enum ost::Bayonne::state_t

inherited

Call processing states offered in core library.

This list must be ordered to match the entries in the state table (statetab).

Enumerator
STATE_INITIAL
STATE_IDLE
STATE_RESET
STATE_RELEASE
STATE_BUSY
STATE_DOWN
STATE_RING
STATE_PICKUP
STATE_SEIZE
STATE_ANSWER
STATE_STEP
STATE_EXEC
STATE_THREAD
STATE_CLEAR
STATE_INKEY
STATE_INPUT
STATE_READ
STATE_COLLECT
STATE_DIAL
STATE_XFER
STATE_REFER
STATE_HOLD
STATE_RECALL
STATE_TONE
STATE_DTMF
STATE_PLAY
STATE_RECORD
STATE_JOIN
STATE_WAIT
STATE_CALLING
STATE_CONNECT
STATE_RECONNECT
STATE_HUNTING
STATE_SLEEP
STATE_START
STATE_HANGUP
STATE_LIBRESET
STATE_WAITKEY
STATE_LIBWAIT
STATE_IRESET
STATE_FINAL
STATE_SUSPEND
STATE_STANDBY
STATE_LIBEXEC
STATE_RINGING
STATE_RUNNING
STATE_THREADING

Definition at line 358 of file bayonne.h.

enum ost::Script::symType

inherited

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.

Constructor & Destructor Documentation

ost::Libexec::Libexec ( )

Initialize libexec.

Member Function Documentation

static void ost::Script::addConditional ( const char * name,

Cond test

)

staticinherited

static void ost::Bayonne::addConfig ( const char * cfgfile )

staticinherited

Add config file entry.

static void ost::Script::addFunction ( const char * name,

unsigned count,

Function i

)

staticinherited

result_t ost::Libexec::addSym ( const char * id,

const char * value

)

static void ost::Bayonne::addTrap4 ( const char * addr )

staticinherited

static void ost::Bayonne::allocate ( timeslot_t timeslots,

ScriptCommand * pointer = NULL,

timeslot_t overdraft = 0

)

staticinherited

Allocates the maximum number of timeslots the server will use as a whole and attaches a given server to the library.

Parameters: timeslots to allocate.

pointer to server shell.

static void ost::Bayonne::allocateLocal ( void )

staticinherited

Allocate local script engine sessions, if needed.

static bool ost::Script::append ( Symbol * sym,

const char * value

)

staticinherited

static void ost::Script::clear ( Symbol * sym )

staticinherited

result_t ost::Libexec::clearInput ( void )

Flush input.

static bool ost::Script::commit ( Symbol * sym,

const char * value

)

staticinherited

static unsigned ost::Script::count ( Symbol * sym )

staticinherited

static Symbol* ost::Script::deref ( Symbol * sym )

staticinherited

void ost::Libexec::detachSession ( unsigned code )

Resume server session, libexec continues detached.

static void ost::Bayonne::down ( void )

staticinherited

Used to down the server from the library.

static void ost::Bayonne::endImage ( ScriptImage * image )

staticinherited

Release a script image in use.

If no active calls are using it and it's no longer the top active image, purge from memory.

Parameters: image to compiled script from useImage.

result_t ost::Libexec::eraseFile ( const char * file )

Erase an audio file.

Returns: result code.

Parameters: name of file to erase.

static void ost::Bayonne::errlog ( const char * level,

const char * fmt,

...

)

staticinherited

static const char* ost::Script::extract ( Symbol * sym )

staticinherited

const char* ost::Libexec::getArg ( const char * id )

Get a named libexec command line argument.

Parameters: id of libexec argument.

Returns: string value of requested argument or NULL.

static timeslot_t ost::Bayonne::getAvailTimeslots ( void )

inlinestaticinherited

Return remaining timeslots available to allocate driver ports into.

Returns: remaining timeslots.

Definition at line 1209 of file bayonne.h.

static char ost::Bayonne::getChar ( int dtmf )

staticinherited

Convert a dtmf digit number into it's ascii code.

Parameters: dtmf digit number.

Returns: dtmf character code.

static int ost::Bayonne::getDigit ( char dtmf )

staticinherited

Convert a dtmf character into a 0-15 number reference.

Parameters: dtmf digit as ascii

Returns: dtmf digit number.

static BayonneDriver* ost::Bayonne::getDriverTag ( const char * id )

staticinherited

static Audio::Encoding ost::Bayonne::getEncoding ( const char * cp )

staticinherited

const char* ost::Libexec::getEnv ( const char * id )

Get a header record item.

Parameters: id of header or sys env item.

Returns: string value of requested item or NULL.

const char* ost::Libexec::getFile ( const char * filename )

Get and verify partial pathname for file oriented libexec commands.

Returns: pointer to buffer or NULL if invalid.

Parameters: filename path to evaluate.

static unsigned ost::Script::getIndex ( const char * id )

staticinherited

static ScriptImage** ost::Bayonne::getLocalImage ( timeslot_t timeslot )

staticinherited

Returns a local image pointer for a server timeslot.

Parameters: timeslot number in server.

Returns: pointer to image pointer or NULL if empty/invalid.

const char* ost::Libexec::getPath ( const char * filename,

char * buffer,

unsigned size

)

Get a fully qualified and resolved pathname.

Returns: pointer to buffer or NULL if invalid.

Parameters: filename path to evaluate.

buffer to save into.

size of buffer.

static const char* ost::Bayonne::getRegistryId ( const char * id )

staticinherited

static const char* ost::Bayonne::getRunLevel ( void )

staticinherited

Get service level.

Parameters: return service level

static BayonneSession* ost::Bayonne::getSession ( timeslot_t timeslot )

staticinherited

Returns a session pointer for a server timeslot.

Each server timeslot can map to a single session object.

Parameters: timeslot number in server.

Returns: session object or NULL if timeslot empty/invalid.

static BayonneSession* ost::Bayonne::getSid ( const char * id )

staticinherited

Returns a session pointer for a string identifier.

This can be for a transaction id, a call id, or other unique identifiers which can be mapped into a single timeslot.

Parameters: id session identifier string.

Returns: session object or NULL if not found.

static Handler ost::Bayonne::getState ( const char * name )

staticinherited

Map a state name into a handler.

Used for logging requests. Uses the statetab.

Parameters: name of state to lookup.

Returns: handler method for state if found.

result_t ost::Libexec::getSym ( const char * id,

char * buf,

unsigned size

)

static timeslot_t ost::Bayonne::getTimeslotCount ( void )

inlinestaticinherited

Return total timeslots allocated for the server.

Returns: total number of timeslots, max + 1.

Definition at line 1200 of file bayonne.h.

static timeslot_t ost::Bayonne::getTimeslotsUsed ( void )

inlinestaticinherited

Return total library timeslots used (highest used).

Returns: highest server timeslot in use.

Definition at line 1192 of file bayonne.h.

static bool ost::Bayonne::getUserdata ( void )

staticinherited

void ost::Libexec::hangupSession ( void )

Hangup running session...

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

static bool ost::Bayonne::loadAudio ( const char * path )

staticinherited

Load a bgm/audio processing module for continues audio.

Parameters: path id of plugin.

Returns: true if successful.

static bool ost::Bayonne::loadMonitor ( const char * path )

staticinherited

Load a monitoring/management module.

Parameters: path id of plugin.

Returns: true if successful.

static bool ost::Bayonne::loadPlugin ( const char * path )

staticinherited

Load a plugin module.

Parameters: path id of plugin.

Returns: true if successful.

static bool ost::Bayonne::matchDigits ( const char * digits,

const char * match,

bool partial = false

)

staticinherited

A function to support pattern matching and templates for digit strings.

This is used for digit @xxx:... entries and the route command.

Parameters: digits to use.

match digit pattern to match against.

partial accept match if true.

Returns: true if digits match to pattern.

void ost::Bayonne::md5_hash ( char * out,

const char * source

)

inherited

Compute md5 hashes...

Parameters: md5 output string

string to hash

result_t ost::Libexec::moveFile ( const char * file1,

const char * file2

)

Move an audio file.

Returns: result code.

Parameters: name of file to move.

destination of move.

result_t ost::Libexec::playDualTone ( short f1,

short f2,

timeout_t duration,

unsigned level = 0

)

result_t ost::Libexec::playSingleTone ( short f1,

timeout_t duration,

unsigned level = 0

)

result_t ost::Libexec::playTone ( const char * name,

timeout_t duration = 0,

unsigned level = 0

)

Play a tone.

Returns: result code.

Parameters: name of tone to play.

duration for tone.

audio level of tone.

void ost::Libexec::postSym ( const char * id,

const char * value

)

Post a symbol asychrononous event to server.

This sets the symbol value, and also generates a :symname event.

Parameters: id of symbol to post.

value of symbol.

result_t ost::Libexec::readInput ( char * buffer,

unsigned size,

timeout_t timeout

)

Read a line of input.

Returns: result code.

Parameters: input buffer.

size of input buffer.

timeout for input.

char ost::Libexec::readKey ( timeout_t timeout )

Read a single key of input.

Returns: key input or 0.

Parameters: timeout for read.

result_t ost::Libexec::recordFile ( const char * file,

timeout_t duration,

timeout_t silence = 0

)

Record an audio file.

Returns: result code.

Parameters: name of file to record.

total duration of file.

optional silence detect.

result_t ost::Libexec::recordOffset ( const char * file,

const char * offset,

timeout_t duration,

timeout_t silence = 0

)

Record an audio file to a specified offset.

Returns: result code.

Parameters: name of file to record.

offset to record info.

total duration of file.

optional silence detect.

static ScriptCompiler* ost::Bayonne::reload ( void )

staticinherited

Request active scripts to be recompiled from the library.

Returns: script image that was created, or NULL.

result_t ost::Libexec::replayFile ( const char * file )

Replay an audio file.

Returns: result code.

Parameters: name of file to play.

result_t ost::Libexec::replayOffset ( const char * file,

const char * offset

)

Replay an audio file from a specified offset.

Returns: result code.

Parameters: name of file to play.

offset to play from.

result_t ost::Libexec::sendCommand ( const char * text,

char * buffer = NULL,

unsigned size = 0

)

Send a command through to server and capture result.

Returns: result code.

Parameters: command to send.

optional query buffer.

optional query size.

void ost::Libexec::sendError ( const char * msg )

Send an error to the server.

Parameters: error msg to send.

result_t ost::Libexec::sendResult ( const char * text )

Send a result to the server.

Returns: result code from server.

Parameters: result to send.

static bool ost::Bayonne::service ( const char * service )

staticinherited

Sets server service level from the library.

Parameters: service level or NULL to clear.

Returns: true if set.

void ost::Libexec::setLevel ( Audio::Level level )

inline

Set the effective audio level for tones...

Parameters: level to set.

Definition at line 130 of file libexec.h.

result_t ost::Libexec::setSym ( const char * id,

const char * value

)

void ost::Libexec::setVoice ( const char * voice )

inline

Set the effective voice library to use.

Parameters: voice to set or NULL for default.

Definition at line 122 of file libexec.h.

result_t ost::Libexec::sizeSym ( const char * id,

unsigned size

)

static void ost::Bayonne::snmptrap ( unsigned id,

const char * descr = NULL

)

staticinherited

result_t ost::Libexec::speak ( const char * format,

...

)

Play a phrase.

Returns: result code.

Parameters: text of phrase to play.

static BayonneSession* ost::Bayonne::startDialing ( const char * dial,

const char * name,

const char * caller,

const char * display,

BayonneSession * parent = NULL,

const char * manager = NULL,

const char * secret = NULL

)

staticinherited

Start a dialing session.

WARNING: this function leaves the channel locked so it can be examined by the returning task.

Parameters: dialing string or uri.

script to run or start.

caller id for this call.

display name for this call.

parent to join to.

static unsigned ost::Script::storage ( Symbol * sym )

staticinherited

static bool ost::Script::symindex ( Symbol * sym,

short offset

)

staticinherited

static timeslot_t ost::Bayonne::toTimeslot ( const char * id )

staticinherited

Returns a server timeslot number for a string identifier.

Returns: timeslot number or invalid value.

Parameters: id for a session.

See Also: getSid

static unsigned long ost::Bayonne::uptime ( void )

staticinherited

Get server uptime.

Returns: uptime in seconds.

static bool ost::Script::use ( const char * name )

staticinherited

static ScriptImage* ost::Bayonne::useImage ( void )

staticinherited

Use the current compiled script image; mark as in use.

Returns: current script image to pass to new calls.

bool ost::Libexec::waitInput ( timeout_t timeout )

Wait for input.

Returns: true if input waiting.

static void ost::Bayonne::waitLoaded ( void )

staticinherited

Wait for live flag...

result_t ost::Libexec::xferCall ( const char * dest )

Transfer a call.

Returns: result code from server.

Parameters: destination to transfer.

Field Documentation

const char* ost::Script::access_host

staticinherited

Definition at line 285 of file script3.h.

const char* ost::Script::access_pass

staticinherited

Definition at line 284 of file script3.h.

const char* ost::Script::access_user

staticinherited

Definition at line 283 of file script3.h.

const char* ost::Script::altplugins

staticinherited

Definition at line 282 of file script3.h.

const char* ost::Script::apps_extensions

staticinherited

Definition at line 291 of file script3.h.

const char* ost::Script::apps_prefix

staticinherited

Definition at line 292 of file script3.h.

Keydata ost::Libexec::args

protected

Definition at line 66 of file libexec.h.

unsigned ost::Script::autoStepping

staticinherited

Definition at line 258 of file script3.h.

unsigned ost::Bayonne::compile_count

staticinherited

Definition at line 303 of file bayonne.h.

char ost::Script::decimal

staticinherited

Definition at line 275 of file script3.h.

char ost::Libexec::digits[64]

Definition at line 73 of file libexec.h.

char ost::Bayonne::dtmf_keymap[256]

staticinherited

Definition at line 265 of file bayonne.h.

const char* ost::Script::etc_prefix

staticinherited

Definition at line 294 of file script3.h.

const char* ost::Script::exec_extensions

staticinherited

Definition at line 287 of file script3.h.

bool ost::Script::exec_funcs

staticinherited

Definition at line 286 of file script3.h.

const char* ost::Script::exec_prefix

staticinherited

Definition at line 289 of file script3.h.

timeout_t ost::Bayonne::exec_timer

staticinherited

Definition at line 302 of file bayonne.h.

const char* ost::Script::exec_token

staticinherited

Definition at line 288 of file script3.h.

const char* ost::Script::exit_token

staticinherited

Definition at line 290 of file script3.h.

unsigned ost::Libexec::exitcode

Definition at line 76 of file libexec.h.

bool ost::Script::fastStart

staticinherited

Definition at line 255 of file script3.h.

unsigned ost::Script::fastStepping

staticinherited

Definition at line 257 of file script3.h.

Keydata ost::Libexec::head

protected

Definition at line 66 of file libexec.h.

unsigned ost::Bayonne::idle_count

staticprotectedinherited

Definition at line 292 of file bayonne.h.

unsigned ost::Bayonne::idle_limit

staticprotectedinherited

Definition at line 293 of file bayonne.h.

Fun* ost::Script::ifun

staticprotectedinherited

Definition at line 306 of file script3.h.

volatile bool ost::Bayonne::image_loaded

staticinherited

Definition at line 304 of file bayonne.h.

BayonneTranslator* ost::Bayonne::init_translator

staticinherited

Definition at line 306 of file bayonne.h.

const char* ost::Bayonne::init_voicelib

staticinherited

Definition at line 307 of file bayonne.h.

Audio::Level ost::Libexec::level

protected

Definition at line 69 of file libexec.h.

AtomicCounter ost::Bayonne::libexec_count

staticinherited

Definition at line 309 of file bayonne.h.

class __EXPORT ost::Script::Line

inherited

Definition at line 102 of file script3.h.

ScriptImage** ost::Bayonne::localimages

staticprotectedinherited

Definition at line 280 of file bayonne.h.

const char* ost::Script::log_prefix

staticinherited

Definition at line 296 of file script3.h.

std::ostream* ost::Bayonne::logging

staticprotectedinherited

Definition at line 288 of file bayonne.h.

class __EXPORT ost::Script::Name

inherited

Definition at line 103 of file script3.h.

size_t ost::Script::pagesize

staticinherited

Definition at line 259 of file script3.h.

const char* ost::Bayonne::path_prompts

staticprotectedinherited

Definition at line 289 of file bayonne.h.

const char* ost::Bayonne::path_tmp

staticprotectedinherited

Definition at line 291 of file bayonne.h.

const char* ost::Bayonne::path_tmpfs

staticprotectedinherited

Definition at line 290 of file bayonne.h.

const char* ost::Script::plugins

staticinherited

Definition at line 281 of file script3.h.

char ost::Libexec::position[32]

Definition at line 75 of file libexec.h.

char ost::Libexec::query[512]

Definition at line 74 of file libexec.h.

time_t ost::Bayonne::reload_time

staticprotectedinherited

Definition at line 297 of file bayonne.h.

ThreadLock ost::Bayonne::reloading

staticinherited

A mutex to serialize reload requests.

Definition at line 1054 of file bayonne.h.

unsigned ost::Libexec::reply

Definition at line 76 of file libexec.h.

timeout_t ost::Bayonne::reset_timer

staticinherited

Definition at line 301 of file bayonne.h.

result_t ost::Libexec::result

Definition at line 72 of file libexec.h.

Mutex ost::Bayonne::serialize

staticinherited

A mutex to serialize any direct console I/O operations.

Sometimes used to serialize other kinds of time insensitive requests.

Definition at line 1049 of file bayonne.h.

ScriptCommand* ost::Bayonne::server

staticprotectedinherited

Definition at line 282 of file bayonne.h.

bool ost::Bayonne::shutdown_flag

staticprotectedinherited

Definition at line 294 of file bayonne.h.

char ost::Bayonne::sla[64]

staticprotectedinherited

Definition at line 295 of file bayonne.h.

time_t ost::Bayonne::start_time

staticprotectedinherited

Definition at line 296 of file bayonne.h.

statetab ost::Bayonne::states[]

staticinherited

Table of states ordered by id.

Definition at line 1043 of file bayonne.h.

char* ost::Bayonne::status

staticprotectedinherited

Definition at line 281 of file bayonne.h.

timeout_t ost::Bayonne::step_timer

staticinherited

Definition at line 300 of file bayonne.h.

unsigned ost::Script::symlimit

staticinherited

Definition at line 261 of file script3.h.

unsigned ost::Script::symsize

staticinherited

Definition at line 260 of file script3.h.

Test* ost::Script::test

staticprotectedinherited

Definition at line 305 of file script3.h.

BayonneSession** ost::Bayonne::timeslots

staticprotectedinherited

Definition at line 279 of file bayonne.h.

volatile unsigned short ost::Bayonne::total_active_calls

staticinherited

Definition at line 1061 of file bayonne.h.

Traffic ost::Bayonne::total_call_attempts

staticinherited

master traffic counters for call attempts and call completions.

Definition at line 1059 of file bayonne.h.

Traffic ost::Bayonne::total_call_complete

staticinherited

Definition at line 1060 of file bayonne.h.

const char* ost::Bayonne::trap_community

staticinherited

Definition at line 308 of file bayonne.h.

timeslot_t ost::Bayonne::ts_count

staticprotectedinherited

Definition at line 286 of file bayonne.h.

unsigned ost::Bayonne::ts_ext

staticprotectedinherited

Definition at line 284 of file bayonne.h.

timeslot_t ost::Bayonne::ts_limit

staticprotectedinherited

Definition at line 285 of file bayonne.h.

unsigned ost::Bayonne::ts_trk

staticprotectedinherited

Definition at line 283 of file bayonne.h.

timeslot_t ost::Bayonne::ts_used

staticprotectedinherited

Definition at line 287 of file bayonne.h.

const char* ost::Libexec::tsid

protected

Definition at line 67 of file libexec.h.

bool ost::Script::use_definitions

staticinherited

Definition at line 276 of file script3.h.

bool ost::Script::use_funcs

staticinherited

Definition at line 280 of file script3.h.

bool ost::Script::use_macros

staticinherited

Definition at line 277 of file script3.h.

bool ost::Script::use_merge

staticinherited

Definition at line 279 of file script3.h.

bool ost::Script::use_prefix

staticinherited

Definition at line 278 of file script3.h.

bool ost::Script::useBigmem

staticinherited

Definition at line 256 of file script3.h.

const char* ost::Script::var_prefix

staticinherited

Definition at line 295 of file script3.h.

const char* ost::Libexec::voice

protected

Definition at line 68 of file libexec.h.

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

libexec.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