SAP ABAP Class CL_TCL_PROCESS (Class for processing parallel tasks)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-ABA-LA (Application Component) Syntax, Compiler, Runtime
⤷
S_ABAP_TCL (Package) Tiny Class Library
⤷
⤷
Properties
| Class | CL_TCL_PROCESS | |
| Short Description | Class for processing parallel tasks | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | S_ABAP_TCL | Tiny Class Library |
| Created | 20040810 | SAP |
| Last change | 20090618 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
Class CL_TCL_PROCESS has no forward declaration.
Interfaces
Class CL_TCL_PROCESS has no interface implemented.
Friends
Class CL_TCL_PROCESS has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Instance attribute | Public | Type reference (TYPE) | STRING | Current task to be processed | 20040810 | |||
| 2 | Instance attribute | Private | See coding | Table of tasks that have the status "delayed" | 20040810 | ||||
| 3 | Instance attribute | Private | See coding | Table of Locked Tasks | 20040810 | ||||
| 4 | Instance attribute | Private | See coding | Table of tasks that have to be confirmed | 20040810 | ||||
| 5 | Instance attribute | Private | See coding | Table of Executable Tasks | 20040810 | ||||
| 6 | Instance attribute | Private | See coding | Table of Tasks with Their Threads | 20040810 | ||||
| 7 | Instance attribute | Private | See coding | Table of Threads | 20040810 | ||||
| 8 | Instance attribute | Private | See coding | X-Ref for Optimization | 20040810 | ||||
| 9 | Instance attribute | Private | Type reference (TYPE) | I | Index for Table Iteration | 20040810 | |||
| 10 | Constant | Public | Type reference (TYPE) | SYSUBRC | '0012' | Error | 20040810 | ||
| 11 | Constant | Public | Type reference (TYPE) | SYSUBRC | '0008' | Process completed | 20040810 | ||
| 12 | Constant | Public | Type reference (TYPE) | SYSUBRC | '0016' | Process blocked | 20040810 | ||
| 13 | Constant | Public | Type reference (TYPE) | SYSUBRC | '0004' | Process waiting | 20040810 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Method | Adds a task to the process | 20040810 | |
| 2 | Instance method | Public | Method | Lock task / dependent tasks remain in queue | 20040810 | |
| 3 | Instance method | Private | Method | Internal Use | 20040810 | |
| 4 | Instance method | Public | Method | End processing of task / Activate successor | 20040810 | |
| 5 | Instance method | Public | Method | Query Process Status | 20040810 | |
| 6 | Instance method | Public | Method | Lock task / dependent tasks remain in queue | 20040810 | |
| 7 | Instance method | Public | Method | Determine next task to be processed | 20040810 | |
| 8 | Instance method | Private | Method | Internal Use | 20040810 | |
| 9 | Instance method | Public | Method | Place task in execution queue again | 20040810 | |
| 10 | Instance method | Public | Method | Unlock task | 20040810 |
Events
Class CL_TCL_PROCESS has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | TCL_PROCESS_DELAYED | Private | See coding | 20040810 | BEGIN OF tcl_process_delayed,
task TYPE REF TO cl_tcl_vertex,
time TYPE timestampl,
END OF tcl_process_delayed
|
||
| 2 | TCL_PROCESS_PENDING | Private | See coding | 20040810 | BEGIN OF tcl_process_pending,
task_id TYPE string,
task TYPE REF TO cl_tcl_vertex,
END OF tcl_process_pending
|
||
| 3 | TCL_PROCESS_THREAD | Private | See coding | 20040810 | BEGIN OF tcl_process_thread,
thread_id TYPE string,
task TYPE REF TO cl_tcl_vertex,
END OF tcl_process_thread
|
||
| 4 | TCL_PROCESS_XREF | Private | See coding | 20040810 | BEGIN OF tcl_process_xref,
task TYPE REF TO cl_tcl_vertex,
thread_id TYPE string,
END OF tcl_process_xref
|
Method Signatures
Method ADD_TASK Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | LOCK | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20040810 | |||
| 2 | TASK_ID | Call by reference | Type reference (TYPE) | STRING | Task-ID | 20040810 | |||
| 3 | THREADS | Call by reference | Type reference (TYPE) | CL_TCL=>TCL_ARRAY_STRING | Array der belegten Threads | 20040810 |
Method ADD_TASK on class CL_TCL_PROCESS has no exception.
Method DELETE_TASK Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RETURN | Value transfer | Type reference (TYPE) | SYSUBRC | Rückgabewert | 20040810 | |||
| 2 | TASK_ID | Call by reference | Type reference (TYPE) | STRING | Task-ID | 20040810 |
Method DELETE_TASK on class CL_TCL_PROCESS has no exception.
Method DELETE_TASK_REFERENCES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | TASK | Call by reference | Object reference (TYPE REF TO) | CL_TCL_VERTEX | Task | 20040810 |
Method DELETE_TASK_REFERENCES on class CL_TCL_PROCESS has no exception.
Method FINISH_TASK Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RETURN | Value transfer | Type reference (TYPE) | SYSUBRC | Rückgabewert | 20040810 | |||
| 2 | TASK_ID | Call by reference | Type reference (TYPE) | STRING | Task-ID | 20040810 |
Method FINISH_TASK on class CL_TCL_PROCESS has no exception.
Method GET_STATUS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RETURN | Value transfer | Type reference (TYPE) | SYSUBRC | Rückgabewert | 20040810 |
Method GET_STATUS on class CL_TCL_PROCESS has no exception.
Method LOCK_TASK Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RETURN | Value transfer | Type reference (TYPE) | SYSUBRC | Rückgabewert | 20040810 | |||
| 2 | TASK_ID | Call by reference | Type reference (TYPE) | STRING | Task-ID | 20040810 |
Method LOCK_TASK on class CL_TCL_PROCESS has no exception.
Method NEXT_TASK Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RETURN | Value transfer | Type reference (TYPE) | SYSUBRC | Rückgabewert | 20040810 |
Method NEXT_TASK on class CL_TCL_PROCESS has no exception.
Method PROCESS_SUCCESSOR_TASKS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | TASK | Call by reference | Object reference (TYPE REF TO) | CL_TCL_VERTEX | Task | 20040810 |
Method PROCESS_SUCCESSOR_TASKS on class CL_TCL_PROCESS has no exception.
Method REDO_TASK Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | DELAY | Call by reference | Type reference (TYPE) | I | 0 | Wartezeit in Sekunden | 20040810 | ||
| 2 | RETURN | Value transfer | Type reference (TYPE) | SYSUBRC | Rückgabewert | 20040810 | |||
| 3 | TASK_ID | Call by reference | Type reference (TYPE) | STRING | Task-ID | 20040810 |
Method REDO_TASK on class CL_TCL_PROCESS has no exception.
Method UNLOCK_TASK Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RETURN | Value transfer | Type reference (TYPE) | SYSUBRC | Rückgabewert | 20040810 | |||
| 2 | TASK_ID | Call by reference | Type reference (TYPE) | STRING | Task-ID | 20040810 |
Method UNLOCK_TASK on class CL_TCL_PROCESS has no exception.
History
| Last changed by/on | SAP | 20090618 |
| SAP Release Created in | 700 |