SAP ABAP Class CL_BGRFC_UNIT_HANDLER (Implementation of bgRFC Unit Administration)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-MID-RFC-BG (Application Component) Background RFC (bgRFC)
     ⤷ SQRFC2 (Package) ABAP Development for bgRFC

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_BGRFC_UNIT_HANDLER	Scheduler Administration of bgRFC Units	20070913

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_BGRFC_UNIT_HANDLER_INB	Abstract Class for Inbound Unit Handler	20080206
2	Inheritance (c INHERITING FROM c_ref)	CL_BGRFC_UNIT_HANDLER_OUT	Abstract Class for Outbound Unit Handling	20071026

Properties

Class	CL_BGRFC_UNIT_HANDLER
Short Description	Implementation of bgRFC Unit Administration
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status	S	System Program
Category	0
Package	SQRFC2	ABAP Development for bgRFC
Created	20070913	SAP
Last change	20140121	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)
2	IF_BGRFC_UNIT_EXECUTOR	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_BGRFC_UNIT_HANDLER	☐	☐	Scheduler Administration of bgRFC Units	20070913

Friends

Class CL_BGRFC_UNIT_HANDLER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	LOGGER	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_BGRFC_LOGGER		tRFC/qRFC Logging	20071008
2	MI_EXEC_FACTORY	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_BGRFC_UNIT_EXEC_FACTORY		Interface to Unit Executor Factory	20130417
3	MV_PERFORM_USER_SWITCH	Instance attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL			20130320
4	RETRY_QUEUE_NAME_PREFIX	Constant	Protected	☐	Type reference (TYPE)	CHAR14	'%_QRFC_RETRY_'	Prefix for Retry Queues	20071011
5	UNIT_HISTORY_ACTIVE	Instance attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL		Unit history required for this unit	20070914
6	UTASK	Instance attribute	Protected	☐	Type reference (TYPE)	VBKEY_D		Key for Update and Enqueue/Dequeue	20070914
7	U_TASK_ACTIVE	Instance attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL		Update task active for this unit	20070914

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHANGE_EXE_MODE	Instance method	Protected	Method	Change Execution Mode	20071017
2	CHANGE_EXE_STATE	Instance method	Protected	Method	Change Execution State of Unit	20071114
3	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20071008
4	CONVERT_BGRFC_TO_ARFC_DATA	Static method	Public	Method	Conversion of FM Data from bgRFC to Old aRFC Format	20070917
5	END_OF_PING	Instance method	Public	Method	Callback Method for Asynchronous Ping	20071029
6	FILL_BGRFC_SRV_STATE	Instance method	Protected	Method	Fill bgRFC Status Data	20080206
7	FILL_RSTATE_STRUCT	Instance method	Protected	Method	Fills Structure for ARFC_STATE	20070918
8	GET_DEST_NAME	Instance method	Protected	Method	Get Destination Name for Unit	20070928
9	GET_UNIT_PAYLOAD	Instance method	Protected	Method	Gets Unit Transaction Data from Database	20070917
10	HANDLE_ON_UNIT_HISTORY	Instance method	Protected	Method	Write Unit History	20070914
11	LOCK_UNIT	Instance method	Protected	Method	Low-Level Lock Implementation	20071022
12	LOG_PROCESSING_FAILURE	Instance method	Protected	Method	Error Logging	20071022
13	MAP_EXE_STATE_TO_LOCK_REASON	Static method	Protected	Method	Map Unit States to Lock Reasons	20071022
14	PERSIST_ERROR_MESSAGES	Instance method	Protected	Method	Store the Original Error Message for Notification	20130318
15	PREPARE_SYNCHRONOUS_EXECUTION	Instance method	Protected	Method	Preparation of synchronous execution	20080306
16	PROVIDE_PMI_DATA	Instance method	Protected	Method	Pass Data to PMI Adapter	20071024
17	SET_PROPERTY_KERNEL_STATISTICS	Instance method	Public	Method	Sets Unit Properties for Kernel Statistics	20071024
18	USER_SWITCH	Instance method	Protected	Method	Switch User	20070925

Events

Class CL_BGRFC_UNIT_HANDLER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	INCR_REDO_AND_PRED_CNT_TYPE	Protected	See coding			20071011	BEGIN OF incr_redo_and_pred_cnt_type , unit_id TYPE bgrfc_unit_id, redo_cnt_incr TYPE i, pred_cnt_incr TYPE i, END OF incr_redo_and_pred_cnt_type
2	INCR_REDO_PRED_CNT_TAB_TYPE	Protected	See coding			20071011	incr_redo_pred_cnt_tab_type TYPE SORTED TABLE OF incr_redo_and_pred_cnt_type WITH UNIQUE KEY unit_id INITIAL SIZE 4
3	UNIT_EXE_MODE_TAB_TYPE	Protected	See coding			20071011	unit_exe_mode_tab_type TYPE STANDARD TABLE OF unit_exe_mode_type WITH NON-UNIQUE KEY unit_id INITIAL SIZE 16
4	UNIT_EXE_MODE_TYPE	Protected	See coding			20071011	BEGIN OF unit_exe_mode_type, unit_id TYPE bgrfc_unit_id, exe_mode TYPE bgrfc_exe_mode, END OF unit_exe_mode_type

Method Signatures

Method CHANGE_EXE_MODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EXE_MODE	Call by reference	☐	Type reference (TYPE)	BGRFC_EXE_MODE		Ausführungsart einer Unit (normal/reconfirm/poll)	20071017

Method CHANGE_EXE_MODE on class CL_BGRFC_UNIT_HANDLER has no exception.

Method CHANGE_EXE_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EXE_STATE	Call by reference	☐	Type reference (TYPE)	BGRFC_EXE_STATE		Ausführungszustand einer Unit im Hintergrund RFC	20071114

Method CHANGE_EXE_STATE on class CL_BGRFC_UNIT_HANDLER has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LOGGER	Call by reference	☐	Object reference (TYPE REF TO)	CL_BGRFC_LOGGER		tRFC/qRFC-Logging	20071008
2	Importing	UNIT_ID	Call by reference	☐	Type reference (TYPE)	BGRFC_UNIT_ID		Id einer Unit im Hintergrund RFC	20071018

Method CONSTRUCTOR on class CL_BGRFC_UNIT_HANDLER has no exception.

Method CONVERT_BGRFC_TO_ARFC_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	ARFC_SDATA_TAB	Call by reference	☐	Type reference (TYPE)	ARFCSDATA_TAB		Tabelle für RFC Funktionsdaten im alten ARFC Format	20070917
2	Importing	ARFC_STATE	Call by reference	☐	Type reference (TYPE)	ARFCRSTATE		Zustand der ARFC-Calls auf der Receiver-Seite.	20070917
3	Changing	ARFC_STATE_TAB	Call by reference	☐	Type reference (TYPE)	ARFCRSTATE_TAB		Zustand der ARFC-Calls auf der Receiver-Seite.	20070917
4	Importing	BGRFC_DATA	Call by reference	☐	Type reference (TYPE)	XSTRING		Daten des bgRFC	20070917
5	Exporting	UNIT_SIZE	Call by reference	☐	Type reference (TYPE)	I		Datenvolumen Unit	20070917

Method CONVERT_BGRFC_TO_ARFC_DATA on class CL_BGRFC_UNIT_HANDLER has no exception.

Method END_OF_PING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	P_TASK	Call by reference	☐	Type reference (TYPE)	CLIKE		Taskname	20071029

Method END_OF_PING on class CL_BGRFC_UNIT_HANDLER has no exception.

Method FILL_BGRFC_SRV_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	BGRFC_STATE	Value transfer	☐	Type reference (TYPE)	BGRFC_SRV_STATE		Serverstatus von bgRFC Units	20080206

Method FILL_BGRFC_SRV_STATE on class CL_BGRFC_UNIT_HANDLER has no exception.

Method FILL_RSTATE_STRUCT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ARFC_RSTATE	Value transfer	☐	Type reference (TYPE)	ARFCRSTATE		Zustand der ARFC-Calls auf der Receiver-Seite.	20070918

#	Exception	Resumable	Description	Created on
1	CX_BGRFC_EXECUTION_ERRORS	☐	Ausnahmen bei der Ausführung von Units	20071002

Method GET_DEST_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	DEST_NAME	Value transfer	☐	Type reference (TYPE)	ARFCCALLID-ARFCDEST		logische Destination (Wird bei Funktionsaufruf angegeben)	20070928

Method GET_DEST_NAME on class CL_BGRFC_UNIT_HANDLER has no exception.

Method GET_UNIT_PAYLOAD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	PAYLOAD	Value transfer	☐	Type reference (TYPE)	XSTRING		Unit Nutzdaten	20070917

Method GET_UNIT_PAYLOAD on class CL_BGRFC_UNIT_HANDLER has no exception.

Method HANDLE_ON_UNIT_HISTORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	P_MESSAGE	Call by reference	☑	Type reference (TYPE)	BGRFC_EXE_MESSAGE		Nachricht zu einem Hintergrund RFC	20070914
2	Importing	P_STATE	Call by reference	☐	Type reference (TYPE)	BGRFC_EXE_STATE		Ausführungszustand einer Unit im Hintergrund RFC	20070914

Method HANDLE_ON_UNIT_HISTORY on class CL_BGRFC_UNIT_HANDLER has no exception.

Method LOCK_UNIT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	END_TIME	Call by reference	☑	Type reference (TYPE)	TIMESTAMPL		Ende der Gültigkeit einer Sperre	20071022
2	Importing	EXE_MESSAGE	Call by reference	☑	Type reference (TYPE)	BGRFC_EXE_MESSAGE		Nachricht zu einem Hintergrund RFC	20071022
3	Importing	EXE_STATE	Call by reference	☐	Type reference (TYPE)	BGRFC_EXE_STATE		Ausführungszustand einer Unit im Hintergrund RFC	20071022
4	Importing	LOCK_ID	Call by reference	☐	Type reference (TYPE)	BGRFC_LOCK_ID		Id einer Sperre im Hintergrund RFC	20071022
5	Importing	LOCK_KIND	Call by reference	☐	Type reference (TYPE)	BGRFC_LOCK_KIND		Art einer Hintergrund RFC Sperre	20071022
6	Importing	MESSAGE_ID	Call by reference	☑	Type reference (TYPE)	SYMSGID		Nachrichtenklasse	20071022
7	Importing	MESSAGE_NUMBER	Call by reference	☑	Type reference (TYPE)	SYMSGNO		Nachrichtennummer	20071022
8	Importing	MESSAGE_PARAMETER1	Call by reference	☑	Type reference (TYPE)	SYMSGV		Nachrichtenvariable	20071022
9	Importing	MESSAGE_PARAMETER2	Call by reference	☑	Type reference (TYPE)	SYMSGV		Nachrichtenvariable	20071022
10	Importing	MESSAGE_PARAMETER3	Call by reference	☑	Type reference (TYPE)	SYMSGV		Nachrichtenvariable	20071022
11	Importing	MESSAGE_PARAMETER4	Call by reference	☑	Type reference (TYPE)	SYMSGV		Nachrichtenvariable	20071022
12	Importing	TIME_STAMP	Call by reference	☐	Type reference (TYPE)	TIMESTAMPL		UTC-Zeitstempel in Langform (JJJJMMTThhmmssmmmuuun)	20071022

Method LOCK_UNIT on class CL_BGRFC_UNIT_HANDLER has no exception.

Method LOG_PROCESSING_FAILURE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EXE_MESSAGE	Call by reference	☐	Type reference (TYPE)	BGRFC_EXE_MESSAGE		Nachricht zu einem Hintergrund RFC	20071022
2	Importing	EXE_STATE	Call by reference	☐	Type reference (TYPE)	BGRFC_EXE_STATE		Ausführungszustand einer Unit im Hintergrund RFC	20071022
3	Importing	TIME_STAMP	Call by reference	☐	Type reference (TYPE)	TIMESTAMPL		UTC-Zeitstempel in Langform (JJJJMMTThhmmssmmmuuun)	20071022

Method LOG_PROCESSING_FAILURE on class CL_BGRFC_UNIT_HANDLER has no exception.

Method MAP_EXE_STATE_TO_LOCK_REASON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EXE_STATE	Call by reference	☐	Type reference (TYPE)	BGRFC_EXE_STATE		Ausführungszustand einer Unit im Hintergrund RFC	20071022
2	Returning	LOCK_REASON	Value transfer	☐	Type reference (TYPE)	BGRFC_LOCK_KIND		Art einer Hintergrund RFC Sperre	20071022

Method MAP_EXE_STATE_TO_LOCK_REASON on class CL_BGRFC_UNIT_HANDLER has no exception.

Method PERSIST_ERROR_MESSAGES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_MESSAGES	Call by reference	☐	Type reference (TYPE)	IF_BGRFC_UNIT_EXECUTOR=>TASK_ERROR_TYPE			20130318
2	Importing	IV_EXE_STATE	Call by reference	☐	Type reference (TYPE)	BGRFC_EXE_STATE		Ausführungszustand einer Unit im Hintergrund RFC	20130318

Method PERSIST_ERROR_MESSAGES on class CL_BGRFC_UNIT_HANDLER has no exception.

Method PREPARE_SYNCHRONOUS_EXECUTION Signature

Method PREPARE_SYNCHRONOUS_EXECUTION on class CL_BGRFC_UNIT_HANDLER has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_BGRFC_EXECUTION_ERRORS	☐	Ausnahmen bei der Ausführung von Units	20080306

Method PROVIDE_PMI_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EXE_STATE	Call by reference	☐	Type reference (TYPE)	BGRFC_EXE_STATE		Ausführungszustand einer Unit im Hintergrund RFC	20071024

Method PROVIDE_PMI_DATA on class CL_BGRFC_UNIT_HANDLER has no exception.

Method SET_PROPERTY_KERNEL_STATISTICS Signature

Method SET_PROPERTY_KERNEL_STATISTICS on class CL_BGRFC_UNIT_HANDLER has no parameter.
Method SET_PROPERTY_KERNEL_STATISTICS on class CL_BGRFC_UNIT_HANDLER has no exception.

Method USER_SWITCH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DEST_NAME	Call by reference	☐	Type reference (TYPE)	ARFCCALLID-ARFCDEST		logische Destination (Wird bei Funktionsaufruf angegeben)	20070925
2	Importing	ON	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Benutzerumschaltung einschalten oder zurückschalten	20070925
3	Importing	USER_NAME	Call by reference	☐	Type reference (TYPE)	SYUNAME		Benutzername	20070925

#	Exception	Resumable	Description	Created on
1	CX_BGRFC_EXECUTION_ERRORS	☐	Ausnahmen bei der Ausführung von Units	20121030

History

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