SAP ABAP Class CL_OBJECT_BUFFER (Admin Functions for Object Buffer)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-DB-DBI (Application Component) DB-Independent Database Interface
     ⤷ SBUF (Package) Table Buffers

Properties

Class	CL_OBJECT_BUFFER
Short Description	Admin Functions for Object Buffer
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	SBUF	Table Buffers
Created	20120420	SAP
Last change	20130531	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_OBJECT_BUFFER has no interface implemented.

Friends

Class CL_OBJECT_BUFFER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_CUA_BUFFER	Constant	Public	☐	Type reference (TYPE)	I	1	CUA buffer	20120420
2	GC_ESM_BUFFER	Constant	Public	☐	Type reference (TYPE)	I	3	Export/Import Shared Memory Buffer	20120420
3	GC_FCODE_INFO	Constant	Private	☐	Type reference (TYPE)	CHAR4	'INFO'	Loosely defined; could be used for patch levels	20120629
4	GC_FCODE_TEST	Constant	Private	☐	Type reference (TYPE)	CHAR4	'TEST'	Loosely defined; could be used for patch levels	20120629
5	GC_HARD_RESET	Constant	Public	☐	Type reference (TYPE)	CHAR1	'H'	Hard Reset of Buffer Instance	20120420
6	GC_OBJ_BUFFER	Constant	Public	☐	Type reference (TYPE)	I	0	Export/Import buffer	20120420
7	GC_OTR_BUFFER	Constant	Public	☐	Type reference (TYPE)	I	2	OTR Buffer	20120420
8	GC_SETTING_FORCE_CHECKS	Constant	Public	☐	Type reference (TYPE)	RSTBXBUFINFO-DESCRIPTION	'Consistency Checks'	Character Field Length - 32	20120629
9	GC_SETTING_SHM_PROTECTION	Constant	Public	☐	Type reference (TYPE)	RSEXPBUFINFO-DESCRIPTION	'Shared Memory Protect'	Character Field Length - 32	20120629
10	GC_SETTING_TRACING	Constant	Public	☐	Type reference (TYPE)	RSTBXBUFINFO-DESCRIPTION	'Tracing'	Character Field Length - 32	20120629
11	GC_SOFT_RESET	Constant	Public	☐	Type reference (TYPE)	CHAR1	'I'	Soft Reset of Buffer Instance	20120420
12	GR_CUA_BUFFER	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_OBJECT_BUFFER		Instance of the CUA Buffer	20120420
13	GR_ESM_BUFFER	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_OBJECT_BUFFER		Instance of the ESM Buffer	20120420
14	GR_OBJ_BUFFER	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_OBJECT_BUFFER		Instance of the Export/Import Buffer	20120420
15	GR_OTR_BUFFER	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_OBJECT_BUFFER		Instance of the OTR Buffer	20120420
16	MV_BUFFER_ID	Instance attribute	Private	☐	Type reference (TYPE)	I		Buffer Instance ID	20120420
17	MV_BUFFER_NAME	Instance attribute	Private	☐	Type reference (TYPE)	RSEXPBUFG64-IDENT_V		Name of the Buffer Instance	20120425

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK	Instance method	Public	Method	Checks the consistency of the buffer instance	20120420
2	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20120420
3	C_DB_OBJ	Instance method	Private	Method		20120629
4	DUMP	Instance method	Public	Method	Creates a memory dump of the buffer instance	20120420
5	GET_FREE_LISTS	Instance method	Public	Method	Returns all free lists of buffer instance	20120420
6	GET_INSTANCE	Static method	Public	Method	Returns a buffer instance	20120420
7	GET_LOCK_INFO	Instance method	Public	Method		20120830
8	GET_NAME	Instance method	Public	Method	Returns the name of the buffer instance	20120425
9	GET_OBJECTS	Instance method	Public	Method	Returns all objects in the buffer instance	20120420
10	GET_OVERVIEW	Instance method	Public	Method	Returns an overview of the status of the buffer instance	20120420
11	GET_TEST_SETTING	Instance method	Private	Method		20121022
12	GET_TEST_SETTINGS	Instance method	Public	Method	Returns the current "Test Settings"	20120502
13	INVALIDATE_OBJECTS	Instance method	Public	Method	Invalidates one or more objects in the buffer instance	20120503
14	RESET	Instance method	Public	Method	Reinitializes the buffer instance	20120420
15	SET_FORCE_CHECKS	Instance method	Public	Method		20120702
16	SET_SHM_PROTECTION	Instance method	Public	Method		20120702
17	SET_TEST_SETTING	Instance method	Private	Method		20121022
18	SET_TRACING	Instance method	Public	Method		20120702

Events

Class CL_OBJECT_BUFFER has no event.

Types

Class CL_OBJECT_BUFFER has no local type.

Method Signatures

Method CHECK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_RETURN	Value transfer	☐	Type reference (TYPE)	SY-SUBRC		Rückgabewert von ABAP-Anweisungen	20120420

Method CHECK on class CL_OBJECT_BUFFER has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_BUFFER_ID	Value transfer	☐	Type reference (TYPE)	I		Kennung der Pufferinstanz	20120420

Method CONSTRUCTOR on class CL_OBJECT_BUFFER has no exception.

Method C_DB_OBJ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CV_DATA	Call by reference	☑	Type reference (TYPE)	ANY			20121024
2	Importing	IV_FUNC_CODE	Call by reference	☐	Type reference (TYPE)	C		Function code	20120629
3	Importing	IV_KEY	Call by reference	☑	Type reference (TYPE)	RSOBJKEY		Object key	20121024
4	Importing	IV_KEY_L	Call by reference	☑	Type reference (TYPE)	RSKEYLEN		Key length	20121024
5	Importing	IV_SUB_CODE	Call by reference	☐	Type reference (TYPE)	C	SPACE	Sub-function code	20120629
6	Importing	IV_TABNAME	Call by reference	☑	Type reference (TYPE)	TABNAME		Table name	20121024

Method C_DB_OBJ on class CL_OBJECT_BUFFER has no exception.

Method DUMP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_FILENAME	Call by reference	☐	Type reference (TYPE)	STRING		Name des erzeugten Dump-Files	20120425

Method DUMP on class CL_OBJECT_BUFFER has no exception.

Method GET_FREE_LISTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_FREE_LISTS	Call by reference	☐	Type reference (TYPE)	RSEXPOBUF64_T		Tabelle mit allen Frelisten der Pufferinstanz	20120420

Method GET_FREE_LISTS on class CL_OBJECT_BUFFER has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_BUFFER_ID	Value transfer	☐	Type reference (TYPE)	I		Kennung der Pufferinstanz	20120420
2	Returning	RR_BUFFER	Value transfer	☐	Object reference (TYPE REF TO)	CL_OBJECT_BUFFER		Pufferinstanz	20120420

Method GET_INSTANCE on class CL_OBJECT_BUFFER has no exception.

Method GET_LOCK_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_LOCK_INFO	Call by reference	☐	Type reference (TYPE)	RSEXPOBUF64_T		Table containing info abouit mutex locks	20120830

Method GET_LOCK_INFO on class CL_OBJECT_BUFFER has no exception.

Method GET_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_BUFFER_NAME	Value transfer	☐	Type reference (TYPE)	STRING		Name der Pufferinstanz	20120425

Method GET_NAME on class CL_OBJECT_BUFFER has no exception.

Method GET_OBJECTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_OBJECTS	Call by reference	☐	Type reference (TYPE)	RSEXPOBUF64_T		Tabelle mit gepufferten Objekten	20120420

Method GET_OBJECTS on class CL_OBJECT_BUFFER has no exception.

Method GET_OVERVIEW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_STATUS	Call by reference	☐	Type reference (TYPE)	RSEXPBUFG64		Globale Statistikstruktur für dbexpbuf.c	20120420

Method GET_OVERVIEW on class CL_OBJECT_BUFFER has no exception.

Method GET_TEST_SETTING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CS_TEST_SETTING	Call by reference	☐	Type reference (TYPE)	RSEXPBUFINFO			20121022

Method GET_TEST_SETTING on class CL_OBJECT_BUFFER has no exception.

Method GET_TEST_SETTINGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_SETTINGS	Call by reference	☐	Type reference (TYPE)	RSEXPBUFINFO_T		Aktuelle Einstellungen der "Test Settings"	20120502

Method GET_TEST_SETTINGS on class CL_OBJECT_BUFFER has no exception.

Method INVALIDATE_OBJECTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DELETE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Aus dem Puffer löschen	20120503
2	Importing	IV_GENERIC	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Schlüssel als Prefix interpretieren	20120503
3	Importing	IV_KEY	Value transfer	☐	Type reference (TYPE)	RSOBJKEY	SPACE	Objektschlüssel	20120503
4	Importing	IV_KEY_L	Value transfer	☐	Type reference (TYPE)	RSKEYLEN	0	Schlüssellänge	20120503
5	Importing	IV_SYNCHRONIZE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Auf allen Servern invalidieren	20120503
6	Importing	IV_TABNAME	Value transfer	☐	Type reference (TYPE)	TABNAME	SPACE	Tabellenname	20120503

Method INVALIDATE_OBJECTS on class CL_OBJECT_BUFFER has no exception.

Method RESET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_RESET_MODE	Value transfer	☐	Type reference (TYPE)	C	GC_SOFT_RESET	Eine der Konstanten GC_*_RESET	20120420

Method RESET on class CL_OBJECT_BUFFER has no exception.

Method SET_FORCE_CHECKS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ON	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		On/Off	20120702

Method SET_FORCE_CHECKS on class CL_OBJECT_BUFFER has no exception.

Method SET_SHM_PROTECTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ON	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		On/Off	20120702

Method SET_SHM_PROTECTION on class CL_OBJECT_BUFFER has no exception.

Method SET_TEST_SETTING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ON	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		On/Off	20121022
2	Importing	IV_PROPERTY	Call by reference	☐	Type reference (TYPE)	RSEXPBUFINFO-DESCRIPTION		Characterfeld der Länge 32	20121022

Method SET_TEST_SETTING on class CL_OBJECT_BUFFER has no exception.

Method SET_TRACING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ON	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		On/Off	20120702

Method SET_TRACING on class CL_OBJECT_BUFFER has no exception.

History

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