SAP ABAP Class CL_RSPLS_ENQ_AREA (Enqueue Using Shared Objects Memory)
Hierarchy
☛
SAP_BW (Software Component) SAP Business Warehouse
⤷ BW-PLA (Application Component) Planning
⤷ RSPLS (Package) Planning: General Services
⤷ BW-PLA (Application Component) Planning
⤷ RSPLS (Package) Planning: General Services
Meta Relationship - Using
# | Relationship type | Using | Short Description | Created on |
---|---|---|---|---|
1 | Inheritance (c INHERITING FROM c_ref) | CL_SHM_AREA | Shared Memory: General Area Handle | 20040514 |
Properties
Class | CL_RSPLS_ENQ_AREA | |
Short Description | Enqueue Using Shared Objects Memory | |
Super Class | CL_SHM_AREA | Shared Memory: General Area Handle |
Instantiability of a Class | 0 | Private |
Final |
General Data
Message Class | ||
Program status | S | System Program |
Category | 45 | Area Class (Shared Objects) |
Package | RSPLS | Planning: General Services |
Created | 20040514 | SAP |
Last change | 20140121 | SAP |
Shared Memory-enabled | ||
Fixed point arithmetic | ||
Unicode checks active |
Forward declarations
Class CL_RSPLS_ENQ_AREA has no forward declaration.
Interfaces
Class CL_RSPLS_ENQ_AREA has no interface implemented.
Friends
# | Friend | Modeled only | Created on | Description |
---|---|---|---|---|
1 | CL_SHM_AREA | 20130725 | Shared Memory: General Area Handle |
Attributes
# | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | AREA_NAME | Constant | Public | Type reference (TYPE) | SHM_AREA_NAME | 'CL_RSPLS_ENQ_AREA' | Name of an Area Class | 20040514 | |
2 | ROOT | Instance attribute | Public | Object reference (TYPE REF TO) | CL_RSPLS_ENQ_ROOT | SHM: Model of a Data Class | 20040514 | ||
3 | _CLIENT_DEPENDENT | Constant | Private | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | 20040514 | ||
4 | _LIFE_CONTEXT | Constant | Private | Type reference (TYPE) | SHM_LIFE_CONTEXT | CL_SHM_AREA=>LIFE_CONTEXT_APPSERVER | Lifetime of an Area (Constants in CL_SHM_AREA) | 20060926 | |
5 | _TRACE_ACTIVE | Static Attribute | Private | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | (Internal) Flag: Trace Active? | 20040514 | |
6 | _TRACE_SERVICE | Static Attribute | Private | Object reference (TYPE REF TO) | IF_SHM_TRACE | (Internal) Reference to Trace Class | 20040514 | ||
7 | _TRANSACTIONAL | Constant | Private | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20040514 | ||
8 | _VERSION_ | Constant | Private | Type reference (TYPE) | I | 21 | (internal) | 20040514 |
Methods
# | Method | Level | Visibility | Method type | Description | Created on |
---|---|---|---|---|---|---|
1 | ATTACH_FOR_READ | Static method | Public | Method | Request Shared Lock | 20040514 |
2 | ATTACH_FOR_UPDATE | Static method | Public | Method | Request a Change Lock | 20040514 |
3 | ATTACH_FOR_WRITE | Static method | Public | Method | Request a Write Lock | 20040514 |
4 | BUILD | Static method | Public | Method | Direct Call of Area Constructor | 20040514 |
5 | CLASS_CONSTRUCTOR | Static method | Public | Constructor | CLASS_CONSTRUCTOR | 20040514 |
6 | DETACH_AREA | Static method | Public | Method | Release all locks on all instances | 20040514 |
7 | FREE_AREA | Static method | Public | Method | Delete all instances | 20040514 |
8 | FREE_INSTANCE | Static method | Public | Method | Deletion of an Instance | 20040514 |
9 | GET_GENERATOR_VERSION | Static method | Public | Method | Query Generator Version | 20040514 |
10 | GET_INSTANCE_INFOS | Static method | Public | Method | Returns the names of all instances | 20040514 |
11 | INVALIDATE_AREA | Static method | Public | Method | Active versions of all instances will be set to obsolete | 20040514 |
12 | INVALIDATE_INSTANCE | Static method | Public | Method | Active version of one instance will be set to obsolete | 20040514 |
13 | SET_ROOT | Instance method | Public | Method | Sets Root Objects | 20040514 |
Events
Class CL_RSPLS_ENQ_AREA has no event.
Types
Class CL_RSPLS_ENQ_AREA has no local type.
Method Signatures
Method ATTACH_FOR_READ Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | CLIENT | Call by reference | Type reference (TYPE) | SHM_CLIENT | 20040514 | |||
2 | Returning | HANDLE | Value transfer | Object reference (TYPE REF TO) | CL_RSPLS_ENQ_AREA | SHM: Modell einer Gebietsklasse | 20040514 | ||
3 | Importing | INST_NAME | Call by reference | Type reference (TYPE) | SHM_INST_NAME | CL_SHM_AREA=>DEFAULT_INSTANCE | Name einer Shared Object Instanz eines Areas | 20040514 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_SHM_CHANGE_LOCK_ACTIVE | Eine Änderungssperre ist schon aktiv | 20040514 | |
2 | CX_SHM_EXCLUSIVE_LOCK_ACTIVE | Instanz ist schon gesperrt | 20040514 | |
3 | CX_SHM_INCONSISTENT | Unterschiedliche Definitionen zwischen Program und Gebiet | 20040514 | |
4 | CX_SHM_NO_ACTIVE_VERSION | Keine aktive Version für ein Attach vorhanden | 20040514 | |
5 | CX_SHM_PARAMETER_ERROR | Falscher Parameter übergeben | 20040514 | |
6 | CX_SHM_READ_LOCK_ACTIVE | Anforderung einer 2. Lesesperre | 20040514 |
Method ATTACH_FOR_UPDATE Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | ATTACH_MODE | Call by reference | Type reference (TYPE) | SHM_ATTACH_MODE | CL_SHM_AREA=>ATTACH_MODE_DEFAULT | Modus des ATTACHS (Konstanten in CL_SHM_AREA) | 20040514 | |
2 | Importing | CLIENT | Call by reference | Type reference (TYPE) | SHM_CLIENT | 20040514 | |||
3 | Returning | HANDLE | Value transfer | Object reference (TYPE REF TO) | CL_RSPLS_ENQ_AREA | SHM: Modell einer Gebietsklasse | 20040514 | ||
4 | Importing | INST_NAME | Call by reference | Type reference (TYPE) | SHM_INST_NAME | CL_SHM_AREA=>DEFAULT_INSTANCE | Name einer Shared Object Instanz eines Areas | 20040514 | |
5 | Importing | WAIT_TIME | Call by reference | Type reference (TYPE) | I | 0 | Maximale Wartezeit (in Millisekunden) | 20040514 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_SHM_CHANGE_LOCK_ACTIVE | Eine Schreibsperre ist schon aktiv | 20040514 | |
2 | CX_SHM_EXCLUSIVE_LOCK_ACTIVE | Instanz ist schon gesperrt | 20040514 | |
3 | CX_SHM_INCONSISTENT | Unterschiedliche Definitionen zwischen Program und Gebiet | 20040514 | |
4 | CX_SHM_NO_ACTIVE_VERSION | Keine aktive Version für ein Attach vorhanden | 20040514 | |
5 | CX_SHM_PARAMETER_ERROR | Übergebener Parameter hat falschen Wert | 20040514 | |
6 | CX_SHM_PENDING_LOCK_REMOVED | Shared Objects: wartende Sperre wurde gelöscht | 20050114 | |
7 | CX_SHM_VERSION_LIMIT_EXCEEDED | Keine weiteren Versionen verfügbar | 20040514 |
Method ATTACH_FOR_WRITE Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | ATTACH_MODE | Call by reference | Type reference (TYPE) | SHM_ATTACH_MODE | CL_SHM_AREA=>ATTACH_MODE_DEFAULT | Modus des ATTACHS (Konstanten in CL_SHM_AREA) | 20040514 | |
2 | Importing | CLIENT | Call by reference | Type reference (TYPE) | SHM_CLIENT | 20040514 | |||
3 | Returning | HANDLE | Value transfer | Object reference (TYPE REF TO) | CL_RSPLS_ENQ_AREA | SHM: Modell einer Gebietsklasse | 20040514 | ||
4 | Importing | INST_NAME | Call by reference | Type reference (TYPE) | SHM_INST_NAME | CL_SHM_AREA=>DEFAULT_INSTANCE | Name einer Shared Object Instanz eines Areas | 20040514 | |
5 | Importing | WAIT_TIME | Call by reference | Type reference (TYPE) | I | 0 | Maximale Wartezeit (in Millisekunden) | 20040514 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_SHM_CHANGE_LOCK_ACTIVE | Eine Schreibsperre ist schon aktiv | 20040514 | |
2 | CX_SHM_EXCLUSIVE_LOCK_ACTIVE | Instanz ist schon gesperrt | 20040514 | |
3 | CX_SHM_PARAMETER_ERROR | Übergebener Parameter hat falschen Wert | 20040514 | |
4 | CX_SHM_PENDING_LOCK_REMOVED | Shared Objects: wartende Sperre wurde gelöscht | 20050114 | |
5 | CX_SHM_VERSION_LIMIT_EXCEEDED | Keine weiteren Versionen verfügbar | 20040514 |
Method BUILD Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | INST_NAME | Call by reference | Type reference (TYPE) | SHM_INST_NAME | CL_SHM_AREA=>DEFAULT_INSTANCE | Name einer Shared Object Instanz eines Areas | 20040514 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_SHMA_INCONSISTENT | SHMA: Inkonsistente Attribut-Kombination | 20040514 | |
2 | CX_SHMA_NOT_CONFIGURED | SHMA: Gebietseigenschaft ist nicht konfiguriert | 20040514 | |
3 | CX_SHM_BUILD_FAILED | Konstruktorlauf ist fehlgeschlagen | 20040514 |
Method CLASS_CONSTRUCTOR Signature
Method CLASS_CONSTRUCTOR on class CL_RSPLS_ENQ_AREA has no parameter.
Method CLASS_CONSTRUCTOR on class CL_RSPLS_ENQ_AREA has no exception.
Method DETACH_AREA Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | CLIENT | Call by reference | Type reference (TYPE) | SHM_CLIENT | 20040514 | |||
2 | Returning | RC | Value transfer | Type reference (TYPE) | SHM_RC | Detach-Rückgabewert (Konstanten in CL_SHM_AREA) | 20040514 |
Method DETACH_AREA on class CL_RSPLS_ENQ_AREA has no exception.
Method FREE_AREA Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | CLIENT | Call by reference | Type reference (TYPE) | SHM_CLIENT | 20040514 | |||
2 | Returning | RC | Value transfer | Type reference (TYPE) | SHM_RC | Rückgabewert (Konstanten in CL_SHM_AREA) | 20040514 | ||
3 | Importing | TERMINATE_CHANGER | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Schreiber werden beendet | 20040514 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_SHM_PARAMETER_ERROR | Falscher Parameter übergeben | 20040514 |
Method FREE_INSTANCE Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | CLIENT | Call by reference | Type reference (TYPE) | SHM_CLIENT | 20040514 | |||
2 | Importing | INST_NAME | Call by reference | Type reference (TYPE) | SHM_INST_NAME | CL_SHM_AREA=>DEFAULT_INSTANCE | Name einer Shared Object Instanz eines Areas | 20040514 | |
3 | Returning | RC | Value transfer | Type reference (TYPE) | SHM_RC | Rückgabewert (Konstanten in CL_SHM_AREA) | 20040514 | ||
4 | Importing | TERMINATE_CHANGER | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Schreiber werden beendet | 20040514 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_SHM_PARAMETER_ERROR | Falscher Parameter übergeben | 20040514 |
Method GET_GENERATOR_VERSION Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Returning | GENERATOR_VERSION | Value transfer | Type reference (TYPE) | I | 20040514 |
Method GET_GENERATOR_VERSION on class CL_RSPLS_ENQ_AREA has no exception.
Method GET_INSTANCE_INFOS Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | CLIENT | Call by reference | Type reference (TYPE) | SHM_CLIENT | 20040514 | |||
2 | Returning | INFOS | Value transfer | Type reference (TYPE) | SHM_INST_INFOS | Übersicht aller Instanzen eines SHM-Gebiets | 20040514 | ||
3 | Importing | INST_NAME | Call by reference | Type reference (TYPE) | SHM_INST_NAME | Name of a Shared Object Instance in an Area | 20120726 |
Method GET_INSTANCE_INFOS on class CL_RSPLS_ENQ_AREA has no exception.
Method INVALIDATE_AREA Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | CLIENT | Call by reference | Type reference (TYPE) | SHM_CLIENT | 20040514 | |||
2 | Returning | RC | Value transfer | Type reference (TYPE) | SHM_RC | Detach-Rückgabewert (Konstanten in CL_SHM_AREA) | 20040514 | ||
3 | Importing | TERMINATE_CHANGER | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Aktive Schreiber werden beendet | 20040514 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_SHM_PARAMETER_ERROR | Falscher Parameter übergeben | 20040514 |
Method INVALIDATE_INSTANCE Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | CLIENT | Call by reference | Type reference (TYPE) | SHM_CLIENT | 20040514 | |||
2 | Importing | INST_NAME | Call by reference | Type reference (TYPE) | SHM_INST_NAME | CL_SHM_AREA=>DEFAULT_INSTANCE | Name einer Shared Object Instanz eines Areas | 20040514 | |
3 | Returning | RC | Value transfer | Type reference (TYPE) | SHM_RC | Detach-Rückgabewert (Konstanten in CL_SHM_AREA) | 20040514 | ||
4 | Importing | TERMINATE_CHANGER | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Aktive Schreiber werden beendet | 20040514 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_SHM_PARAMETER_ERROR | Falscher Parameter übergeben | 20040514 |
Method SET_ROOT Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | ROOT | Call by reference | Object reference (TYPE REF TO) | CL_RSPLS_ENQ_ROOT | Wurzelobjekt | 20040514 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_SHM_INITIAL_REFERENCE | Initiale Referenz übergeben | 20040514 | |
2 | CX_SHM_WRONG_HANDLE | Falsches Handle | 20040514 |
History
Last changed by/on | SAP | 20140121 |
SAP Release Created in | 700 |