VersionConstants (GVL) ¶ InOut: Scope Name Type Initial Constant gc_byVersion BYTE 1 gc_byVersion_1 BYTE 0
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 24.07.2019, 08:29:54 companyName string 3S-Smart Software Solutions GmbH libraryFile CAA_NetBaseServices.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP15 contentFile CAA_NetBaseServices.clean.json version version 2.0.0.0 ProjectInformation Depends on PS bool False Depends on RTS False OnlineHelp True Released True LastModificationDateTime date 24.07.2019, 08:29:50 LibraryCategories library-category-list Intern|CAA|Network Author string 3S - Smart Software Solutions GmbH Company CAA Technical Workgroup DefaultNamespace NBS Description See: Description DocFormat reStructuredText LanguageModelAttribute qualified-access-only Placeholder CAA NetBaseSrv Project CAA_NetBaseServices Title CAA Net Base Services SpecVersion version 3.0.0.0 Version 3.5.15.0
Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. CAA Behaviour Model ¶ Library Identification ¶ Placeholder: CAA Behaviour Model Default Resolution: CAA Behaviour Model, * (CAA Technical Workgroup) Namespace: CBM Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: CAA Behaviour Model CAA List And Tree ¶ Library Identification ¶ Placeholder: CAA List And Tree Default Resolution: CAA List And Tree, * (CAA Technical Workgroup) Namespace: LAT Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: CAA List And Tree CAA Segmented Buffer Manager Extern ¶ Library Identification ¶ Placeholder: CAA SegBufMan Default Resolution: CAA Segmented Buffer Manager Extern, * (CAA Technical Workgroup) Namespace: SBM Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: CAA SegBufMan CAA Tick Extern ¶ Library Identification ¶ Placeholder: CAA Tick Default Resolution: CAA Tick Extern, * (CAA Technical Workgroup) Namespace: TICKS Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: CAA Tick CAA TickUtil Extern ¶ Library Identification ¶ Placeholder: CAA TickUtil Default Resolution: CAA TickUtil Extern, * (CAA Technical Workgroup) Namespace: TICKU Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: CAA TickUtil 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 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) Standard ¶ Library Identification ¶ Placeholder: Standard Default Resolution: Standard, * (System) Namespace: Standard Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Standard SysSem ¶ Library Identification ¶ Placeholder: SysSem Default Resolution: SysSem, * (System) Namespace: SysSem Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysSem SysSocket ¶ Library Identification ¶ Placeholder: SysSocket Default Resolution: SysSocket, * (System) Namespace: SysSocket Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysSocket SysTask ¶ Library Identification ¶ Placeholder: SysTask Default Resolution: SysTask, * (System) Namespace: SysTask Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysTask 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) TCP ¶ Library Identification ¶ Placeholder: TCP Default Resolution: TCP, * (3S - Smart Software Solutions GmbH) Namespace: TCP Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: TCP UDP ¶ Library Identification ¶ Placeholder: UDP Default Resolution: UDP, * (3S - Smart Software Solutions GmbH) Namespace: UDP Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: UDP
TCP_Connection.IPAddress (PROP) ¶ PROPERTY IPAddress : SysSocket.INADDR IP Address of the NIC the connection is connected with
CmpAsyncMgr Library Documentation ¶ Company System Title CmpAsyncMgr Version 3.5.17.0 Categories System|SysLibs Author 3S - Smart Software Solutions GmbH Placeholder CmpAsyncMgr Description 1 ¶ Provides functions to execute operations in asynchronous tasks. An example can be downloaded here: Example.project Contents: ¶ ASYNCJOB_EVENTPARAM (Struct) ASYNCJOB_HOOKPARAM (Struct) ASYNCJOB_PARAM (Union) ASYNCJOB_TASKPARAM (Struct) AsyncAdd (Function) AsyncBaseClass (FunctionBlock) AsyncRemoveJob (Method) AsyncSetJobParams (Method) AsyncGetJobReturnValue (Function) AsyncKill (Function) AsyncRemove (Function) AsyncRemoveAll (Function) GVL (GVL) GVL_2 (GVL) Indices and tables ¶ 1 Based on CmpAsyncMgr.library, last modified 20.04.2021, 15:33:39. LibDoc 4.4.0.0-b.27 The content file CmpAsyncMgr.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 20.04.2021, 15:33:39.
ASYNCJOB_EVENTPARAM (STRUCT) ¶ TYPE ASYNCJOB_EVENTPARAM : STRUCT Specifiy the event that executes the job, in case ulType is set to ASYNCJOB_EVENT InOut: Name Type Comment ulEventId UDINT Event id ulEventClass UDINT Event class ulCmpId UDINT Component id that generates the event
ASYNCJOB_HOOKPARAM (STRUCT) ¶ TYPE ASYNCJOB_HOOKPARAM : STRUCT Specifiy the hook thats executes the job, in case ulType is set to ASYNCJOB_HOOK InOut: Name Type Comment ulHookId UDINT Hook id when the job should be executed, for example CH_COMM_CYCLE
ASYNCJOB_TASKPARAM (STRUCT) ¶ TYPE ASYNCJOB_TASKPARAM : STRUCT Specifiy task that executes the job, in case ulType is set to ASYNCJOB_TASK InOut: Name Type Comment pszTaskname POINTER TO STRING Task name of queue. Same task can be re-used for different jobs, or use separate tasks for different jobs. If name is not specified, a default name is generated based on the priority. ulTaskPriority UDINT Priority of task. ulTaskSleepTime UDINT Not used, set to 0. phTaskHandle POINTER TO RTS_IEC_HANDLE Handle of the task used for the job. Filled by AsyncAdd. Set to RTS_INVALID_HANDLE in the call. ulEndTaskAfterJob UDINT If set, task will be terminated after the job is finished.
ASYNCJOB_PARAM (UNION) ¶ TYPE ASYNCJOB_PARAM : union Union type, including all async job call definitions. InOut: Name Type TaskParam AsyncJob_TaskParam EventParam AsyncJob_EventParam HookParam AsyncJob_HookParam
AsyncAdd (FUN) ¶ FUNCTION AsyncAdd : RTS_IEC_HANDLE Function to start a new asynchronous job. Note On shutdown or reset, or before download, call AsyncRemoveAll() to remove all registered asynchronous jobs. During exit of an application (Application reset or delete), an asynchronous job is executed synchronously! InOut: Scope Name Type Comment Return AsyncAdd RTS_IEC_HANDLE Handle to the job object Input pfJobFunc POINTER TO BYTE Function pointer to be called asyncrononous. Use ADR to retrieve the function pointer. pParam POINTER TO BYTE Parameter to be passed to pfJobFunc pInstance POINTER TO BYTE In case of ulIecFunc is ASYNC_IS_IEC, and if pfJobFunc is a method of a FB, pass here the instance pointer of the FB In other cases, set to 0 pulState POINTER TO UDINT Pointer to job state, filled by CmpAsyncMgr. Check this state cyclically. ulIecFunc UDINT Indicates if pfJobFunc is written in IEC or C: ASYNC_IS_IEC or ASYNC_ISNOT_IEC ulType UDINT Type of an async job: ASYNCJOB_TASK, ASYNCJOB_EVENT or ASYNCJOB_HOOK ulTimeout UDINT Timout for the operation in milliseconds. Can be 0, then infinite. pAsyncJobParam POINTER TO ASYNCJOB_PARAM Pointer to structure ASYNCJOB_PARAM. Specify task by name with member TaskParam.pszTaskname. A new task will be created on first call. For other jobs, this same task can be re-used by setting the same name. Specify task priority with member TaskParam.ulTaskPriority. pResult POINTER TO RTS_IEC_RESULT Pointer to the runtime system error code (see CmpErrors2 Interface Library): ERR_PARAMETER: invalid parameter Result of CmpMemPool ERR_NOTIMPLEMENTED: ulType ASYNCJOB_EVENT and SysEvent handling fails ERR_NOT_SUPPORTED: ulType ASYNCJOB_TASK and SysTask handling fails
