SAP ABAP Class CL_RCC_COMMOBJ_AREA (Area for Communication Object in RCCF)

Hierarchy

☛ SAP_BS_FND (Software Component) SAP Business Suite Foundation
   ⤷ CA-EPT-RCC (Application Component) Remote Control and Communication Framework
     ⤷ RCC_COM (Package) RCCF: Communication

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	20080320

Properties

Class	CL_RCC_COMMOBJ_AREA
Short Description	Area for Communication Object in RCCF
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	RCC_COM	RCCF: Communication
Created	20080320	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_RCC_COMMOBJ_AREA has no forward declaration.

Interfaces

Class CL_RCC_COMMOBJ_AREA has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_SHM_AREA	☐	20080320	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_RCCF_COMMOBJ_AREA'	Name of an Area Class	20080320
2	ROOT	Instance attribute	Public	☑	Object reference (TYPE REF TO)	CL_RCC_COMMOBJ_SHMA=>		Shared Memory(SHM): Model of a Data Class	20080320
3	_CLIENT_DEPENDENT	Constant	Private	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20080320
4	_TRACE_ACTIVE	Static Attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	(Internal) Indicator: Trace Active?	20080320
5	_TRACE_SERVICE	Static Attribute	Private	☐	Object reference (TYPE REF TO)	IF_SHM_TRACE		(Internal) Reference to Trace Class	20080320
6	_TRANSACTIONAL	Constant	Private	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20080320
7	_VERSION_	Constant	Private	☐	Type reference (TYPE)	I	16	(Internal)	20080320

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ATTACH_FOR_READ	Static method	Public	Method	Request Read Lock	20080320
2	ATTACH_FOR_UPDATE	Static method	Public	Method	Request Change Lock	20080320
3	ATTACH_FOR_WRITE	Static method	Public	Method	Request Write Lock	20080320
4	BUILD	Static method	Public	Method	Direct Call of Area Constructur	20080320
5	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20080320
6	DETACH_AREA	Static method	Public	Method	Remove All Locks on All Instances	20080320
7	FREE_AREA	Static method	Public	Method	Delete All Instances	20080320
8	FREE_INSTANCE	Static method	Public	Method	Delete an Instance	20080320
9	GET_GENERATOR_VERSION	Static method	Public	Method	Query Generator Version	20080320
10	GET_INSTANCE_INFOS	Static method	Public	Method	Delivers the Names of All Instances	20080320
11	INVALIDATE_AREA	Static method	Public	Method	Active versions of all instances are set to obsolete	20080320
12	INVALIDATE_INSTANCE	Static method	Public	Method	Active version on an instance is set to obsolete	20080320
13	SET_ROOT	Instance method	Public	Method	Sets Root Object	20080320

Events

Class CL_RCC_COMMOBJ_AREA has no event.

Types

Class CL_RCC_COMMOBJ_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_RCC_COMMOBJ_AREA		Shared Memory: Model of an Area Class	20080320
2	Importing	INST_NAME	Call by reference	☑	Type reference (TYPE)	SHM_INST_NAME	CL_SHM_AREA=>DEFAULT_INSTANCE	Name of a Shared Object Instance in an Area	20080320

#	Exception	Resumable	Description	Created on
1	CX_SHM_CHANGE_LOCK_ACTIVE	☐	A Change Lock Is Already Active	20080320
2	CX_SHM_EXCLUSIVE_LOCK_ACTIVE	☐	Instance is already locked	20080320
3	CX_SHM_INCONSISTENT	☐	Different definitions between program and area	20080320
4	CX_SHM_NO_ACTIVE_VERSION	☐	No Active Version Exists for an Attach	20080320
5	CX_SHM_PARAMETER_ERROR	☐	Incorrect Parameter Transferred	20080320
6	CX_SHM_READ_LOCK_ACTIVE	☐	Request for a Second Shared Lock	20080320

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	Mode of ATTACH (Constants in CL_SHM_AREA)	20080320
2	Returning	HANDLE	Value transfer	☐	Object reference (TYPE REF TO)	CL_RCC_COMMOBJ_AREA		Shared Memory: Model of an Area Class	20080320
3	Importing	INST_NAME	Call by reference	☑	Type reference (TYPE)	SHM_INST_NAME	CL_SHM_AREA=>DEFAULT_INSTANCE	Name of a Shared Object Instance in an Area	20080320
4	Importing	WAIT_TIME	Call by reference	☐	Type reference (TYPE)	I	0	Maximum Wait Time (in Milliseconds)	20080320

#	Exception	Resumable	Description	Created on
1	CX_SHM_CHANGE_LOCK_ACTIVE	☐	A Write Lock Is Already Active	20080320
2	CX_SHM_EXCLUSIVE_LOCK_ACTIVE	☐	Instance is already locked	20080320
3	CX_SHM_INCONSISTENT	☐	Different definitions between program and area	20080320
4	CX_SHM_NO_ACTIVE_VERSION	☐	No Active Version Exists for an Attach	20080320
5	CX_SHM_PARAMETER_ERROR	☐	Parameter Transferred Has Incorrect Value	20080320
6	CX_SHM_PENDING_LOCK_REMOVED	☐	Shared Objects: Waiting Lock Was Deleted	20080320
7	CX_SHM_VERSION_LIMIT_EXCEEDED	☐	No Further Versions Available	20080320

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	Mode of ATTACH (Constants in CL_SHM_AREA)	20080320
2	Returning	HANDLE	Value transfer	☐	Object reference (TYPE REF TO)	CL_RCC_COMMOBJ_AREA		Shared Memory: Model of an Area Class	20080320
3	Importing	INST_NAME	Call by reference	☑	Type reference (TYPE)	SHM_INST_NAME	CL_SHM_AREA=>DEFAULT_INSTANCE	Name of a Shared Object Instance in an Area	20080320
4	Importing	WAIT_TIME	Call by reference	☐	Type reference (TYPE)	I	0	Maximum Wait Time (in Milliseconds)	20080320

#	Exception	Resumable	Description	Created on
1	CX_SHM_CHANGE_LOCK_ACTIVE	☐	A Write Lock Is Already Active	20080320
2	CX_SHM_EXCLUSIVE_LOCK_ACTIVE	☐	Instance is already locked	20080320
3	CX_SHM_PARAMETER_ERROR	☐	Parameter Transferred Has Incorrect Value	20080320
4	CX_SHM_PENDING_LOCK_REMOVED	☐	Shared Objects: Waiting Lock Was Deleted	20080320
5	CX_SHM_VERSION_LIMIT_EXCEEDED	☐	No Further Versions Available	20080320

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 of a Shared Object Instance in an Area	20080320

#	Exception	Resumable	Description	Created on
1	CX_SHMA_INCONSISTENT	☐	Shared Memory Administ.: Inconsistent Attribute Combination	20080320
2	CX_SHMA_NOT_CONFIGURED	☐	Shared Memory Administ.: Area Property Is not Configured	20080320
3	CX_SHM_BUILD_FAILED	☐	CONSTRUCTOR Run Aborted	20080320

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class CL_RCC_COMMOBJ_AREA has no parameter.
Method CLASS_CONSTRUCTOR on class CL_RCC_COMMOBJ_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		Detach Return Value (Constants in CL_SHM_AREA)	20080320

Method DETACH_AREA on class CL_RCC_COMMOBJ_AREA has no exception.

Method FREE_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		Return Value (Constants in CL_SHM_AREA)	20080320
2	Importing	TERMINATE_CHANGER	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Writers terminated	20080320

#	Exception	Resumable	Description	Created on
1	CX_SHM_PARAMETER_ERROR	☐	Incorrect Parameter Transferred	20080320

Method FREE_INSTANCE 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 of a Shared Object Instance in an Area	20080320
2	Returning	RC	Value transfer	☐	Type reference (TYPE)	SHM_RC		Return Value (Constants in CL_SHM_AREA)	20080320
3	Importing	TERMINATE_CHANGER	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Writers terminated	20080320

#	Exception	Resumable	Description	Created on
1	CX_SHM_PARAMETER_ERROR	☐	Incorrect Parameter Transferred	20080320

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			20080320

Method GET_GENERATOR_VERSION on class CL_RCC_COMMOBJ_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		Overview of All Instances of a Shared Memory Area	20080320

Method GET_INSTANCE_INFOS on class CL_RCC_COMMOBJ_AREA has no exception.

Method INVALIDATE_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		Detach Return Value (Constants in CL_SHM_AREA)	20080320
2	Importing	TERMINATE_CHANGER	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Active writers terminated	20080320

#	Exception	Resumable	Description	Created on
1	CX_SHM_PARAMETER_ERROR	☐	Incorrect Parameter Transferred	20080320

Method INVALIDATE_INSTANCE 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 of a Shared Object Instance in an Area	20080320
2	Returning	RC	Value transfer	☐	Type reference (TYPE)	SHM_RC		Detach Return Value (Constants in CL_SHM_AREA)	20080320
3	Importing	TERMINATE_CHANGER	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Active writers terminated	20080320

#	Exception	Resumable	Description	Created on
1	CX_SHM_PARAMETER_ERROR	☐	Incorrect Parameter Transferred	20080320

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_RCC_COMMOBJ_SHMA		Root Object	20080320

#	Exception	Resumable	Description	Created on
1	CX_SHM_INITIAL_REFERENCE	☐	Initial Reference Transferred	20080320
2	CX_SHM_WRONG_HANDLE	☐	Wrong Handle	20080320

History

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