General

Description

General functions of the Home2L package.

Collaboration diagram for General:

Functions
def	Home2lInit (instance=None, server=False, args=True)
def	Home2lDone ()
def	Home2lStart ()
	End the elaboration and start the background activities of the Home2L package. More...
def	Home2lIterate (maxTime=0)
	Iterate Home2L and run all pending callback functions. More...
def	Home2lRun ()
	Run the Home2L main loop indefinitely (or until stopped). More...
def	Home2lStop ()
	Let 'Home2lRun()' stop at next occasion. More...

Function Documentation

Home2lInit()

def Home2lInit	(		instance = None,
			server = False,
			args = True
	)

    Home2lInit(char const * instance=None, bool server=False, bool args=True)
    Initialize the Home2L package.

    The following optional arguments may be set:
      instance : The instance name [default: name of the script/executable]
                 A leading 'home2l-' is stripped off.
      server   : Enable the server
      args     : Parse the command line arguments for standard Home2L arguments

Home2lDone()

def Home2lDone

(

)

Home2lDone()
Shutdown the Home2L package.

It is not necessary to call this as the last command in a script, since it
is executed automatically on exit.

Home2lStart()

def Home2lStart

(

)

End the elaboration and start the background activities of the Home2L package.

Start the background activities of the Home2L package.

This primarily ends the elaboration phase of the Resources library and starts
the server (if enabled). New drivers and resources must be defined before this.

Home2lIterate()

def Home2lIterate

(

maxTime = 0

)

Iterate Home2L and run all pending callback functions.

Iterate Home2L for a time of 'maxTime' ms and run all pending callback functions.

If 'maxTime == 0', only the currently pending work is done, and the
function does not wait. If 'maxTime < 0', the function may wait
indefinitely (this feature is used by 'Run').

Home2lRun()

def Home2lRun

(

)

Run the Home2L main loop indefinitely (or until stopped).

Run the Home2L main loop indefinitely (or until stopped).
Executes 'Home2lStart()' if this has not happened before.

Home2lStop()

def Home2lStop

(

)

Let 'Home2lRun()' stop at next occasion.

Let 'Home2lRun()' stop at next occasion.

Note: This (and all top-level) functions may presently only be called
from a single (main) thread. In particular, stopping from a different
thread is not supported.