SAP ABAP Class CL_FS_ENQUEUE_MANAGER (Help Class for Lock Management)

Hierarchy

☛ SAP_ABA (Software Component) Cross-Application Component
   ⤷ CA-GTF-TS-CNS (Application Component) Change Pointer Service
     ⤷ CNS (Package) Change Notification Service

Properties

Class	CL_FS_ENQUEUE_MANAGER
Short Description	Help Class for Lock Management
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	CNS	Change Notification Service
Created	20080523	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_FS_ENQUEUE_MANAGER has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_CNS_TEST_HELPER	☐	20080526	CNS Test Helper

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CON_BLOCK_SIZE	Constant	Private	☐	Type reference (TYPE)	I	20		20080523
2	CON_GET_VB_KEY	Constant	Private	☐	Type reference (TYPE)	X	2		20080523
3	GT_ENQUEUE_MANAGER	Static Attribute	Private	☐	Type reference (TYPE)	LTY_T_ENQUEUE_MANAGER			20080523
4	MO_CALLBACK	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_FS_ENQUEUE_CALLBACK		Callback Interface for Lock Management Help Class	20080523
5	MR_ENQUEUE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	DATA			20080523
6	MV_ENQKEY	Static Attribute	Private	☐	Type reference (TYPE)	EQEUSRVB			20080523
7	MV_IS_INIT	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20080523

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_INIT	Instance method	Private	Method	Check Whether Initialized	20080523
2	CHECK_SINGLE_LOCK	Instance method	Public	Method	Check Whether a Lock Exists	20080523
3	CLASS_CONSTRUCTOR	Static method	Public	Constructor		20080523
4	CONSTRUCTOR	Instance method	Public	Constructor		20080523
5	DEQ_ALL_LOCKS	Static method	Private	Event handling method	End of Transaction for Event Handler	20080523
6	DEQ_SINGLE	Instance method	Public	Method	Unlock an Object	20080523
7	ENQ_FLUSH	Instance method	Public	Method	Lock a Number of Objects	20080523
8	ENQ_SINGLE	Instance method	Public	Method	Lock an Object	20080523
9	GET_BLOCK_SIZE	Instance method	Private	Method	Determine Maximum Number of Locks per Flush	20080523
10	S_GET_INSTANCE	Static method	Public	Method	Get an Instance of Enqueue Manager/ Create	20080523

Events

Class CL_FS_ENQUEUE_MANAGER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	LTY_S_ENQUEUE_MANAGER	Private	See coding			20080523	BEGIN OF lty_s_enqueue_manager, enqueue_object TYPE string, manager TYPE REF TO cl_fs_enqueue_manager, END OF lty_s_enqueue_manager
2	LTY_T_ENQUEUE_MANAGER	Private	See coding			20080523	lty_t_enqueue_manager TYPE HASHED TABLE OF lty_s_enqueue_manager WITH UNIQUE KEY enqueue_object

Method Signatures

Method CHECK_INIT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_LOCK_ARGUMENTS	Call by reference	☐	Type reference (TYPE)	ANY			20080523

Method CHECK_INIT on class CL_FS_ENQUEUE_MANAGER has no exception.

Method CHECK_SINGLE_LOCK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_ENQUEUE	Call by reference	☐	Type reference (TYPE)	ANY			20080523
2	Returning	RV_IS_LOCKED	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20080523

Method CHECK_SINGLE_LOCK on class CL_FS_ENQUEUE_MANAGER has no exception.

Method CLASS_CONSTRUCTOR Signature

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

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CALLBACK	Call by reference	☐	Object reference (TYPE REF TO)	IF_FS_ENQUEUE_CALLBACK		Callback Interface für Hilfsklasse Sperrmanagement	20080523

Method CONSTRUCTOR on class CL_FS_ENQUEUE_MANAGER has no exception.

Method DEQ_ALL_LOCKS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	KIND	Value transfer	☐	Attribute reference (LIKE)				20080523

Method DEQ_ALL_LOCKS on class CL_FS_ENQUEUE_MANAGER has no exception.

Method DEQ_SINGLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_LOCK_ARGUMENTS	Call by reference	☐	Type reference (TYPE)	ANY			20080523

Method DEQ_SINGLE on class CL_FS_ENQUEUE_MANAGER has no exception.

Method ENQ_FLUSH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_ENQUEUE_FAILED	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE			20080523
2	Exporting	ET_ENQUEUE_NEW	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE			20080523
3	Exporting	ET_ENQUEUE_SUCCESS	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE			20080523
4	Importing	IT_LOCK_ARGUMENTS	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE			20080523

#	Exception	Resumable	Description	Created on
1	CX_FS_ENQUEUE_ERROR	☐	Exception in Hilfsklasse Sperrmanagement	20080523

Method ENQ_SINGLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_LOCK_ARGUMENTS	Call by reference	☐	Type reference (TYPE)	ANY			20080523
2	Returning	RV_FOREIGN_LOCK	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20080523

#	Exception	Resumable	Description	Created on
1	CX_FS_ENQUEUE_ERROR	☐	Exception in Hilfsklasse Sperrmanagement	20080523

Method GET_BLOCK_SIZE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_BLOCK_SIZE	Value transfer	☐	Type reference (TYPE)	I			20080523

Method GET_BLOCK_SIZE on class CL_FS_ENQUEUE_MANAGER has no exception.

Method S_GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CALLBACK	Call by reference	☐	Object reference (TYPE REF TO)	IF_FS_ENQUEUE_CALLBACK		Callback Interface für Hilfsklasse Sperrmanagement	20080523
2	Returning	RO_ENQUEUE_MANAGER	Value transfer	☐	Object reference (TYPE REF TO)	CL_FS_ENQUEUE_MANAGER		Enqueu Manager	20080523

Method S_GET_INSTANCE on class CL_FS_ENQUEUE_MANAGER has no exception.

History

Last changed by/on	SAP	20110908
SAP Release Created in	711