SAP ABAP Class CL_DBA_SHM_AREA (DBA Cockpit: Shared Memory Area)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-DB (Application Component) Database Interface, Database Platforms
     ⤷ SDBA_RUNTIME (Package) DBA Cockpit: Runtime

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	20050520

Properties

Class	CL_DBA_SHM_AREA
Short Description	DBA Cockpit: Shared Memory Area
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	SDBA_RUNTIME	DBA Cockpit: Runtime
Created	20050520	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_DBA_SHM_AREA has no forward declaration.

Interfaces

Class CL_DBA_SHM_AREA has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_SHM_AREA	☐	20110912	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_DBA_SHM_AREA'	Name of an Area Class	20050520
2	ROOT	Instance attribute	Public	☑	Object reference (TYPE REF TO)	CL_DBA_SHM_ROOT		SHM: Model of a Data Class	20050520
3	_CLIENT_DEPENDENT	Constant	Private	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20050520
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)	20061220
5	_TRACE_ACTIVE	Static Attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	(Internal) Flag: Trace Active?	20050520
6	_TRACE_SERVICE	Static Attribute	Private	☐	Object reference (TYPE REF TO)	IF_SHM_TRACE		(Internal) Reference to Trace Class	20050520
7	_TRANSACTIONAL	Constant	Private	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20050520
8	_VERSION_	Constant	Private	☐	Type reference (TYPE)	I	19	(internal)	20050520

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ATTACH_FOR_READ	Static method	Public	Method	Request a Read Lock	20050520
2	ATTACH_FOR_UPDATE	Static method	Public	Method	Request a Change Lock	20050520
3	ATTACH_FOR_WRITE	Static method	Public	Method	Request a Write Lock	20050520
4	BUILD	Static method	Public	Method	Direct Call of Area Constructor	20050520
5	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20050520
6	DETACH_AREA	Static method	Public	Method	Release all locks on all instances	20050520
7	FREE_AREA	Static method	Public	Method	Delete all instances	20050520
8	FREE_INSTANCE	Static method	Public	Method	Deletion of an Instance	20050520
9	GET_GENERATOR_VERSION	Static method	Public	Method	Query Generator Version	20050520
10	GET_INSTANCE_INFOS	Static method	Public	Method	Returns the names of all instances	20050520
11	INVALIDATE_AREA	Static method	Public	Method	Active versions of all instances will be set to obsolete	20050520
12	INVALIDATE_INSTANCE	Static method	Public	Method	Active version of one instance will be set to obsolete	20050520
13	PROPAGATE_AREA	Static method	Public	Method	OBSOLET: Use INVALIDATE_AREA	20061220
14	PROPAGATE_INSTANCE	Static method	Public	Method	OBSOLET: Use INVALIDATE_INSTANCE	20061220
15	SET_ROOT	Instance method	Public	Method	Sets Root Objects	20050520

Events

Class CL_DBA_SHM_AREA has no event.

Types

Class CL_DBA_SHM_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	Returning	HANDLE	Value transfer	☐	Object reference (TYPE REF TO)	CL_DBA_SHM_AREA		SHM: Modell einer Gebietsklasse	20050520
2	Importing	INST_NAME	Call by reference	☑	Type reference (TYPE)	SHM_INST_NAME	CL_SHM_AREA=>DEFAULT_INSTANCE	Name einer Shared-Object-Instanz eines Gebiets	20050520

#	Exception	Resumable	Description	Created on
1	CX_SHM_CHANGE_LOCK_ACTIVE	☐	Eine Änderungssperre ist bereits aktiv	20050520
2	CX_SHM_EXCLUSIVE_LOCK_ACTIVE	☐	Instanz bereits gesperrt	20050520
3	CX_SHM_INCONSISTENT	☐	Verschiedene Definitionen zwischen Programm und Gebiet	20050520
4	CX_SHM_NO_ACTIVE_VERSION	☐	Keine aktive Version für eine Anmeldung vorhanden	20050520
5	CX_SHM_PARAMETER_ERROR	☐	Falscher Parameter übergeben	20050520
6	CX_SHM_READ_LOCK_ACTIVE	☐	Anforderung für eine zweite Lesesperre	20050520

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 der Anmeldung (Konstanten in CL_SHM_AREA)	20050520
2	Returning	HANDLE	Value transfer	☐	Object reference (TYPE REF TO)	CL_DBA_SHM_AREA		SHM: Modell einer Gebietsklasse	20050520
3	Importing	INST_NAME	Call by reference	☑	Type reference (TYPE)	SHM_INST_NAME	CL_SHM_AREA=>DEFAULT_INSTANCE	Name einer Shared-Object-Instanz eines Gebiets	20050520
4	Importing	WAIT_TIME	Call by reference	☐	Type reference (TYPE)	I	0	Maximale Wartezeit (in Millisekunden)	20050520

#	Exception	Resumable	Description	Created on
1	CX_SHM_CHANGE_LOCK_ACTIVE	☐	Eine Schreibsperre ist bereits aktiv	20050520
2	CX_SHM_EXCLUSIVE_LOCK_ACTIVE	☐	Instanz bereits gesperrt	20050520
3	CX_SHM_INCONSISTENT	☐	Verschiedene Definitionen zwischen Programm und Gebiet	20050520
4	CX_SHM_NO_ACTIVE_VERSION	☐	Keine aktive Version für eine Anmeldung vorhanden	20050520
5	CX_SHM_PARAMETER_ERROR	☐	Übergebener Parameter hat einen falschen Wert	20050520
6	CX_SHM_PENDING_LOCK_REMOVED	☐	Shared Objects: Wartende Sperre wurde gelöscht	20050520
7	CX_SHM_VERSION_LIMIT_EXCEEDED	☐	Keine zusätzlichen Versionen verfügbar	20050520

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 der Anmeldung (Konstanten in CL_SHM_AREA)	20050520
2	Returning	HANDLE	Value transfer	☐	Object reference (TYPE REF TO)	CL_DBA_SHM_AREA		SHM: Modell einer Gebietsklasse	20050520
3	Importing	INST_NAME	Call by reference	☑	Type reference (TYPE)	SHM_INST_NAME	CL_SHM_AREA=>DEFAULT_INSTANCE	Name einer Shared-Object-Instanz eines Gebiets	20050520
4	Importing	WAIT_TIME	Call by reference	☐	Type reference (TYPE)	I	0	Maximale Wartezeit (in Millisekunden)	20050520

#	Exception	Resumable	Description	Created on
1	CX_SHM_CHANGE_LOCK_ACTIVE	☐	Eine Schreibsperre ist bereits aktiv	20050520
2	CX_SHM_EXCLUSIVE_LOCK_ACTIVE	☐	Instanz bereits gesperrt	20050520
3	CX_SHM_PARAMETER_ERROR	☐	Übergebener Parameter hat einen falschen Wert	20050520
4	CX_SHM_PENDING_LOCK_REMOVED	☐	Shared Objects: Wartende Sperre wurde gelöscht	20050520
5	CX_SHM_VERSION_LIMIT_EXCEEDED	☐	Keine zusätzlichen Versionen verfügbar	20050520

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 Gebiets	20050520

#	Exception	Resumable	Description	Created on
1	CX_SHMA_INCONSISTENT	☐	SHM-Administration: Inkonsistente Attributkombination	20050520
2	CX_SHMA_NOT_CONFIGURED	☐	SHM-Administration: Gebietseigenschaft nicht konfiguriert	20050520
3	CX_SHM_BUILD_FAILED	☐	Konstruktorlauf fehlgeschlagen	20050520

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class CL_DBA_SHM_AREA has no parameter.
Method CLASS_CONSTRUCTOR on class CL_DBA_SHM_AREA has no exception.

Method DETACH_AREA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RC	Value transfer	☐	Type reference (TYPE)	SHM_RC		Rückgabewert freigeben (Konstanten in CL_SHM_AREA)	20050520

Method DETACH_AREA on class CL_DBA_SHM_AREA has no exception.

Method FREE_AREA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	AFFECT_SERVER	Call by reference	☐	Type reference (TYPE)	SHM_AFFECT_SERVER	CL_SHM_AREA=>AFFECT_LOCAL_SERVER	Servers on which the area will be deleted or invalidated	20061220
2	Returning	RC	Value transfer	☐	Type reference (TYPE)	SHM_RC		Rückgabewert (Konstanten in CL_SHM_AREA)	20050520
3	Importing	TERMINATE_CHANGER	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Schreibprozesse werden beendet	20050520

#	Exception	Resumable	Description	Created on
1	CX_SHM_PARAMETER_ERROR	☐	Falscher Parameter übergeben	20050520

Method FREE_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	AFFECT_SERVER	Call by reference	☐	Type reference (TYPE)	SHM_AFFECT_SERVER	CL_SHM_AREA=>AFFECT_LOCAL_SERVER	Servers on which the area will be deleted or invalidated	20061220
2	Importing	INST_NAME	Call by reference	☑	Type reference (TYPE)	SHM_INST_NAME	CL_SHM_AREA=>DEFAULT_INSTANCE	Name einer Shared-Object-Instanz eines Gebiets	20050520
3	Returning	RC	Value transfer	☐	Type reference (TYPE)	SHM_RC		Rückgabewert (Konstanten in CL_SHM_AREA)	20050520
4	Importing	TERMINATE_CHANGER	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Schreibprozesse werden beendet	20050520

#	Exception	Resumable	Description	Created on
1	CX_SHM_PARAMETER_ERROR	☐	Falscher Parameter übergeben	20050520

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			20050520

Method GET_GENERATOR_VERSION on class CL_DBA_SHM_AREA has no exception.

Method GET_INSTANCE_INFOS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	INFOS	Value transfer	☐	Type reference (TYPE)	SHM_INST_INFOS		Übersicht aller Instanzen eines SHM-Bereichs	20050520

Method GET_INSTANCE_INFOS on class CL_DBA_SHM_AREA has no exception.

Method INVALIDATE_AREA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	AFFECT_SERVER	Call by reference	☐	Type reference (TYPE)	SHM_AFFECT_SERVER	CL_SHM_AREA=>AFFECT_LOCAL_SERVER	Servers on which the area will be deleted or invalidated	20061220
2	Returning	RC	Value transfer	☐	Type reference (TYPE)	SHM_RC		Rückgabewert freigeben (Konstanten in CL_SHM_AREA)	20050520
3	Importing	TERMINATE_CHANGER	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Aktive Schreibprozesse werden beendet	20050520

#	Exception	Resumable	Description	Created on
1	CX_SHM_PARAMETER_ERROR	☐	Falscher Parameter übergeben	20050520

Method INVALIDATE_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	AFFECT_SERVER	Call by reference	☐	Type reference (TYPE)	SHM_AFFECT_SERVER	CL_SHM_AREA=>AFFECT_LOCAL_SERVER	Servers on which the area will be deleted or invalidated	20061220
2	Importing	INST_NAME	Call by reference	☑	Type reference (TYPE)	SHM_INST_NAME	CL_SHM_AREA=>DEFAULT_INSTANCE	Name einer Shared-Object-Instanz eines Gebiets	20050520
3	Returning	RC	Value transfer	☐	Type reference (TYPE)	SHM_RC		Rückgabewert freigeben (Konstanten in CL_SHM_AREA)	20050520
4	Importing	TERMINATE_CHANGER	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Aktive Schreibprozesse werden beendet	20050520

#	Exception	Resumable	Description	Created on
1	CX_SHM_PARAMETER_ERROR	☐	Falscher Parameter übergeben	20050520

Method PROPAGATE_AREA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	AFFECTING_LOCAL_SERVER	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Local server should also be synchronized	20061220

#	Exception	Resumable	Description	Created on
1	CX_SHM_PARAMETER_ERROR	☐	Incorrect parameter transferred	20061220

Method PROPAGATE_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	AFFECTING_LOCAL_SERVER	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Local server should also be synchronized	20061220
2	Importing	INST_NAME	Call by reference	☑	Type reference (TYPE)	SHM_INST_NAME	CL_SHM_AREA=>DEFAULT_INSTANCE	Name of a Shared Object Instance of an Area	20061220

#	Exception	Resumable	Description	Created on
1	CX_SHM_PARAMETER_ERROR	☐	Incorrect parameter transferred	20061220

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_DBA_SHM_ROOT		Wurzelobjekt	20050520

#	Exception	Resumable	Description	Created on
1	CX_SHM_INITIAL_REFERENCE	☐	Initiale Referenz übergeben	20050520
2	CX_SHM_WRONG_HANDLE	☐	Falsche ID	20050520

History

Last changed by/on	SAP	20130531
SAP Release Created in	710