Yate
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends

Engine Class Reference

Engine globals. More...

#include <yatengine.h>

List of all members.

Public Types

enum  RunMode {
  Stopped = 0, Console = 1, Server = 2, Client = 3,
  ClientProxy = 4
}
enum  PluginMode { LoadFail = 0, LoadLate, LoadEarly }

Public Member Functions

int run ()
void setHook (MessagePostHook *hook, bool remove=false)
int usedPlugins ()
unsigned int messageCount ()
unsigned int handlerCount ()
bool loadPluginDir (const String &relPath)

Static Public Member Functions

static int main (int argc, const char **argv, const char **env, RunMode mode=Console, bool fail=false)
static void help (bool client, bool errout=false)
static Engineself ()
static RunMode mode ()
static bool clientMode ()
static bool Register (const Plugin *plugin, bool reg=true)
static const StringnodeName ()
static const StringsharedPath ()
static String configFile (const char *name, bool user=false)
static const StringconfigPath (bool user=false)
static const StringconfigSuffix ()
static const StringmodulePath ()
static void extraPath (const String &path)
static void userPath (const String &path)
static const StringmoduleSuffix ()
static const char * pathSeparator ()
static const Configurationconfig ()
static unsigned int runId ()
static const NamedListrunParams ()
static void init ()
static void halt (unsigned int code)
static bool restart (unsigned int code, bool gracefull=false)
static bool exiting ()
static bool install (MessageHandler *handler)
static bool uninstall (MessageHandler *handler)
static bool enqueue (Message *msg)
static bool enqueue (const char *name)
static bool dispatch (Message *msg)
static bool dispatch (Message &msg)
static bool dispatch (const char *name)
static void pluginMode (PluginMode mode)

Protected Member Functions

 ~Engine ()
bool loadPlugin (const char *file, bool local=false, bool nounload=false)
void loadPlugins ()
void initPlugins ()

Friends

class EnginePrivate
class EngineCommand

Detailed Description

Engine globals.

This class holds global information about the engine. Note: this is a singleton class.


Member Enumeration Documentation

enum PluginMode

Plugin load and initialization modes. Default is LoadLate that initailizes the plugin after others. LoadEarly will move the plugin to the front of the init order. LoadFail causes the plugin to be unloaded.

enum RunMode

Running modes - run the engine as Console, Client or Server.


Constructor & Destructor Documentation

~Engine ( ) [protected]

Destroys the engine and everything. You must not call it directly, run() will do it for you.


Member Function Documentation

static bool clientMode ( ) [inline, static]

Check if the engine is running as telephony client

Returns:
True if the engine is running in client mode
static const Configuration& config ( ) [static]

The global configuration of the engine. You must use this resource with caution. Note that sections [general], [modules], [preload] and [postload] are reserved by the engine. Also [telephony] is reserved by the drivers.

Returns:
A reference to the read-only engine configuration
static String configFile ( const char *  name,
bool  user = false 
) [static]

Get the filename for a specific configuration

Parameters:
nameName of the configuration requested
userTrue to build a user settings path
Returns:
A full path configuration file name
static const String& configPath ( bool  user = false) [static]

Get the system or user configuration directory path

Parameters:
userTrue to get the user settings path
Returns:
The directory path for system or user configuration files
static const String& configSuffix ( ) [inline, static]

Get the configuration file suffix

Returns:
The suffix for configuration files
static bool dispatch ( Message msg) [static]

Synchronously dispatch a message to the registered handlers

Parameters:
msgPointer to the message to dispatch
Returns:
True if one handler accepted it, false if all ignored
static bool dispatch ( Message msg) [static]

Synchronously dispatch a message to the registered handlers

Parameters:
msgThe message to dispatch
Returns:
True if one handler accepted it, false if all ignored
static bool dispatch ( const char *  name) [static]

Convenience function. Dispatch a parameterless message to the registered handlers

Parameters:
nameThe name of the message to create and dispatch
Returns:
True if one handler accepted it, false if all ignored
static bool enqueue ( Message msg) [static]

Enqueue a message in the message queue for asynchronous dispatching

Parameters:
msgThe message to enqueue, will be destroyed after dispatching
Returns:
True if enqueued, false on error (already queued)
static bool enqueue ( const char *  name) [inline, static]

Convenience function. Enqueue a new parameterless message in the message queue

Parameters:
nameName of the parameterless message to put in queue
Returns:
True if enqueued, false on error (already queued)

References Engine::enqueue().

Referenced by Engine::enqueue().

static bool exiting ( ) [inline, static]

Check if the engine is currently exiting

Returns:
True if exiting, false in normal operation

Referenced by Client::valid().

static void extraPath ( const String path) [static]

Add a relative extra module loading path. The list is empty by default but can be filled by a main program before calling main()

Parameters:
pathRelative path to extra modules to be loaded
static void halt ( unsigned int  code) [static]

Stop the engine and the entire program

Parameters:
codeReturn code of the program
unsigned int handlerCount ( ) [inline]

Get the number of handlers in the dispatcher

Returns:
Count of handlers
static void help ( bool  client,
bool  errout = false 
) [static]

Display the help information on console

Parameters:
clientDisplay help for client running mode
erroutDisplay on stderr intead of stdout
static void init ( ) [static]

Reinitialize the plugins

void initPlugins ( ) [protected]

Initialize all registered plugins

static bool install ( MessageHandler handler) [static]

Installs a handler in the dispatcher.

Parameters:
handlerA pointer to the handler to install
Returns:
True on success, false on failure
bool loadPlugin ( const char *  file,
bool  local = false,
bool  nounload = false 
) [protected]

Loads one plugin from a shared object file

Parameters:
fileName of the plugin file to load
localAttempt to keep symbols local if supported by the system
nounloadNever unload the module from memory, finalize if possible
Returns:
True if success, false on failure
bool loadPluginDir ( const String relPath)

Loads the plugins from an extra plugins directory

Parameters:
relPathPath to the extra directory, relative to the main modules
Returns:
True if the directory could at least be opened
void loadPlugins ( ) [protected]

Loads the plugins from the plugins directory

static int main ( int  argc,
const char **  argv,
const char **  env,
RunMode  mode = Console,
bool  fail = false 
) [static]

Main entry point to be called directly from a wrapper program

Parameters:
argcArgument count
argvArgument array
envEnvironment variables
modeMode the engine must run as - Console, Client or Server
failFail and return after parsing command line arguments
Returns:
Program exit code
unsigned int messageCount ( ) [inline]

Get the number of messages waiting in the queue

Returns:
Count of messages in the queue
static RunMode mode ( ) [inline, static]

Get the running mode of the engine

Returns:
Engine's run mode as enumerated value
static const String& modulePath ( ) [inline, static]

The module loading path

static const String& moduleSuffix ( ) [inline, static]

Get the module filename suffix

Returns:
The suffix for module files
static const String& nodeName ( ) [inline, static]

Get the server node name, should be unique in a cluster

Returns:
Node identifier string, defaults to host name
static const char* pathSeparator ( ) [static]

Get the canonical path element separator for the operating system

Returns:
The operating system specific path element separator
static void pluginMode ( PluginMode  mode) [static]

Set the load and init mode of the currently loading Plugin

Parameters:
modeLoad and init mode, default LoadLate
static bool Register ( const Plugin plugin,
bool  reg = true 
) [static]

Register or unregister a plugin to the engine.

Parameters:
pluginA pointer to the plugin to (un)register
regTrue to register (default), false to unregister
Returns:
True on success, false on failure
static bool restart ( unsigned int  code,
bool  gracefull = false 
) [static]

Stop and restart the engine and the entire program

Parameters:
codeReturn code of the program
gracefullAttempt to wait until no plugin is busy
Returns:
True if restart was initiated, false if exiting or no supervisor
int run ( )

Run the engine.

Returns:
Error code, 0 for success
static unsigned int runId ( ) [static]

Get a - supposedly unique - instance ID

Returns:
Unique ID of the current running instance
static const NamedList& runParams ( ) [inline, static]

Get the engine parameters specific to this run.

Returns:
A reference to the list of run specific parameters
static Engine* self ( ) [static]

Get a pointer to the unique instance.

Returns:
A pointer to the singleton instance of the engine
void setHook ( MessagePostHook hook,
bool  remove = false 
) [inline]

Install or remove a hook to catch messages after being dispatched

Parameters:
hookPointer to a post-dispatching message hook
removeSet to True to remove the hook instead of adding
static const String& sharedPath ( ) [inline, static]

Get the application's shared directory path

Returns:
The base path for shared files and directories
static bool uninstall ( MessageHandler handler) [static]

Uninstalls a handler drom the dispatcher.

Parameters:
handlerA pointer to the handler to uninstall
Returns:
True on success, false on failure
int usedPlugins ( )

Get a count of plugins that are actively in use

Returns:
Count of plugins in use
static void userPath ( const String path) [static]

Set the per user application data path. This method must be called by a main program before calling main() or help() Path separators are not allowed. The default is taken from CFG_DIR.

Parameters:
pathSingle relative path component to write user specific data

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