GetLibVersion (FUN) ¶ FUNCTION GetLibVersion : VERSION This function has been automatically generated from the project information. InOut: Scope Name Type Return GetLibVersion VERSION

GetLibVersionNumber (FUN) ¶ FUNCTION GetLibVersionNumber : DWORD This function has been automatically generated from the project information. InOut: Scope Name Type Return GetLibVersionNumber DWORD

IsLibReleased (FUN) ¶ FUNCTION IsLibReleased : BOOL This function has been automatically generated from the project information. InOut: Scope Name Type Return IsLibReleased BOOL

File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 28.05.2024, 08:24:02 companyName string 3S-Smart Software Solutions GmbH libraryFile Asynchronous Job   Manager.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile Asynchronous Job   Manager.clean.json version version 2.0.0.0 ProjectInformation AutoResolveUnbound bool True IsEndUserLibrary False Released False SourceLibrary False LastModificationDateTime date 28.05.2024, 08:24:00 LibraryCategories library-category-list Intern|Base Author string CODESYS Development GmbH Company CODESYS CompiledLibraryCompatibilityVersion CODESYS V3.5 SP16 Patch 3 DefaultNamespace AJM Description See: Description DocFormat reStructuredText LanguageModelAttribute qualified-access-only Placeholder `` AsynchronousJobManager `` Project Asynchronous Job   Manager Title Asynchronous Job   Manager Version version 4.0.0.0

Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. CAA FB Factory ¶ Library Identification ¶ Placeholder: CAA FB Factory Default Resolution: CAA FB Factory, * (CAA Technical Workgroup) Namespace: FBF Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: CAA FB Factory CAA Types Extern ¶ Library Identification ¶ Placeholder: CAA Types Default Resolution: CAA Types Extern, * (CAA Technical Workgroup) Namespace: CAA Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: CAA Types CmpApp ¶ Library Identification ¶ Placeholder: CmpApp Default Resolution: CmpApp, * (System) Namespace: CmpApp Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpApp CmpAsyncMgr ¶ Library Identification ¶ Placeholder: CmpAsyncMgr Default Resolution: CmpAsyncMgr, * (System) Namespace: CmpAsyncMgr Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpAsyncMgr CmpErrors2 Interfaces ¶ Library Identification ¶ Name: CmpErrors2 Interfaces Version: newest Company: System Namespace: CmpErrors Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpErrors2 Interfaces, * (System) CmpEventMgr ¶ Library Identification ¶ Placeholder: CmpEventMgr Default Resolution: CmpEventMgr, * (System) Namespace: CmpEventMgr Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpEventMgr CmpIecTask ¶ Library Identification ¶ Placeholder: CmpIecTask Default Resolution: CmpIecTask, * (System) Namespace: CmpIecTask Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpIecTask CmpSchedule ¶ Library Identification ¶ Placeholder: CmpSchedule Default Resolution: CmpSchedule, * (System) Namespace: CmpSchedule Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpSchedule Common Behaviour Model ¶ Library Identification ¶ Placeholder: CBML Default Resolution: Common Behaviour Model, * (3S - Smart Software Solutions GmbH) Namespace: CBML Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: CBML Component Manager ¶ Library Identification ¶ Placeholder: Component Manager Default Resolution: Component Manager, * (System) Namespace: Component_Manager Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Component Manager SharedData Utilities for MultiCore ¶ Library Identification ¶ Placeholder: SharedDataUtilities Default Resolution: SharedData Utilities for MultiCore, * (3S - Smart Software Solutions GmbH) Namespace: SHD Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: SharedDataUtilities SysEvent ¶ Library Identification ¶ Placeholder: SysEvent Default Resolution: SysEvent, * (System) Namespace: SysEvent Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysEvent SysTypes2 Interfaces ¶ Library Identification ¶ Name: SysTypes2 Interfaces Version: newest Company: System Namespace: SysTypes Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysTypes2 Interfaces, * (System)

BackgroundTask (FB) ¶ FUNCTION_BLOCK FINAL BackgroundTask EXTENDS FBF.InstanceBase IMPLEMENTS IBackgroundTask , ICmpEventCallback Encapsulates all the details of managing a iec task in the context of the runtime system. A running background task can be controlled via the methods of IBackgroundTask . Note Watchdog Sensitivity: If the actual cycle time of a task exceeds the currently udiWatchdogTime , the currently defined usiWatchdogSensitivity value is taken into account: Sensitivity 0, 1 => exception in cycle 1 Sensitivity 2 => exception in cycle 2 Sensitivity n => exception in cycle n Single Timeout => Exception if the actual cycle time is longer than usiWatchdogSensitivity x udiWatchdogTime . InOut: Scope Name Type Comment Input Const tgTaskGroup TASK_GROUP anAppName APP_NAME tnTaskName TASK_NAME usiTaskPrio USINT udiTaskInterval UDINT Taskinterval in µs xWatchdogEnabled BOOL TRUE => Watchdog will be enabled udiWatchdogTime UDINT Watchdog Time in µs usiWatchdogSensitivity USINT Defines the behavior of a task watchdog when exceeding the udiWatchdogTime . (See note above) Input xEnable BOOL TRUE : Activates the defined operation FALSE : Aborts/resets the defined operation itfParams SHD.ISharedQueue Parameter Queue feeding the IAsyncActionProvider.AsyncAction itfAction IAsyncActionProvider Specifies the action executed in the context of this background task Output xBusy BOOL TRUE : Operation is running xError BOOL TRUE : Error condition reached eErrorID ERROR If xError is TRUE => Information about the current error condition itfResult SHD.ISharedArea Current states and results of the background task dwCurrentCycleTime DWORD dwAverageCycleTime DWORD dwMaxCycleTime DWORD dwMinCycleTime DWORD dwCycleCounter DWORD Properties: ActionController ModelTimeLimit ModelTimeOut Methods: SetInitialValue AbortModel GetConfiguration GetConfiguration2 GetModelState ResetModel StartModel TaskDisableScheduling TaskDisableWatchdog TaskEnableScheduling TaskEnableWatchdog TaskResetStatistics Structure: IBackgroundTask TaskDisableScheduling (Method) TaskDisableWatchdog (Method) TaskEnableScheduling (Method) TaskEnableWatchdog (Method) TaskResetStatistics (Method) IBehaviourModel AbortModel (Method) ActionController (Property) GetConfiguration (Method) GetConfiguration2 (Method) GetModelState (Method) ModelTimeLimit (Property) ModelTimeOut (Property) ResetModel (Method) StartModel (Method) SetInitialValue (Method)

BackgroundTaskFactoryBase (FB) ¶ FUNCTION_BLOCK PUBLIC BackgroundTaskFactoryBase EXTENDS FBF.FactoryBase This is a base implementation of a factory for BackgroundTask instances. Please extend this function block and implement the prvInstPoolAdr property for realizing a factory based on static memory. The default implementation results in a heap memory based factory with a initial capacity of 5 ( prvInstCount := 5 ). Overwriting prvInstCount provides the possibility to control the initial capacity of the pool. Implementing prvInstPoolExtendsFactor provides the possibility to control the dynmic extension of the pool. prvInstPoolExtendsFactor = 0 => No possibility for extending the pool. prvInstPoolExtendsFactor > 0 => Extendion of the pool will be possible. A value of e.g. prvInstPoolExtendsFactor := 50 always expands the pool by 50% of its original size. Properties: prvInstCount prvInstSize Methods: Create Structure: Create (Method) prvInstCount (Property) prvInstSize (Property)

BackgroundTaskFactoryArgs (FB) ¶ FUNCTION_BLOCK FINAL BackgroundTaskFactoryArgs EXTENDS FBF.InstanceData Parameter type of the BackgroundTaskFactoryBase.Create method. See: The documentation of the CAA FB Fatory library InOut: Scope Name Type Inherited from Input hInst CAA.HANDLE InstanceData tgTaskGroup TASK_GROUP anAppName APP_NAME tnTaskName TASK_NAME usiTaskPrio USINT udiTaskInterval UDINT xWatchdogEnabled BOOL udiWatchdogTime UDINT usiWatchdogSensitivity USINT itfParams SHD.ISharedQueue itfAction IAsyncActionProvider

IAsyncActionProvider (ITF) ¶ INTERFACE IAsyncActionProvider EXTENDS __SYSTEM.IQueryInterface Separated from the implementation of a function block for abstracting a background task ( BackgroundTask ), a additional interface for describing actions ( IAsyncActionProvider ) was introduced. New parameters for the current action will be passed by the itfParam input of the IAsyncActionProvider.AsyncAction method. The value is taken from a queue (See: itfParams of BackgroundTask ). This way the AsyncAction is decoupled from foreground task processing. The processing of the action can take several cycles. At the end of processing, the output xComplete` is set to TRUE and the result of the action is made available to the foreground task via the IAsyncActionProvider.AsyncResult property. Properties: AsyncResult Methods: AsyncAction Structure: AsyncAction (Method) AsyncResult (Property)

IAsyncActionProvider.AsyncAction (METH) ¶ METHOD AsyncAction The action of a BackgroundTask is modeled as a method of a function block instance ( AsyncAction ) and will be cyclically called until the return value xComplete indicating a condition that the current asynchronous operation is now completed and the method can then provided with a new parameter. The input parameter itfParam is a “generic pointer” (interface) to a data structure containing the current parameter values ( SHD.IQueueableNode ). The result of the AsyncAction is made available to the foreground task via the IAsyncActionProvider.AsyncResult property. InOut: Scope Name Type Comment Input itfParam SHD.IQueueableNode Data structure containing the current parameter values Output xComplete BOOL TRUE => indicating that the current asynchronous operation is now completed