SAP ABAP Class CL_XMS_SHARED_MEMORY_BUFFER (XI Message Buffer Access)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-XI-IS-IEN (Application Component) Integration Engine
     ⤷ SXMSMSG (Package) XI: Message Handling

Properties

Class	CL_XMS_SHARED_MEMORY_BUFFER
Short Description	XI Message Buffer Access
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	SXMSMSG	XI: Message Handling
Created	20070713	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_XMS_SHARED_MEMORY_BUFFER has no forward declaration.

Interfaces

Class CL_XMS_SHARED_MEMORY_BUFFER has no interface implemented.

Friends

Class CL_XMS_SHARED_MEMORY_BUFFER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	_ENABLED	Instance attribute	Protected	☐	Type reference (TYPE)	CHAR1		Single-Character Indicator	20071112
2	_EOIO_ENABLED	Instance attribute	Protected	☐	Type reference (TYPE)	CHAR1		Single-Character Indicator	20071113
3	_HANDLE_TAB	Instance attribute	Protected	☐	Type reference (TYPE)	SHM_ATTACH_TAB		List of Attachments for Multi-Attach	20071115
4	_INST	Static Attribute	Protected	☐	Object reference (TYPE REF TO)	CL_XMS_SHARED_MEMORY_BUFFER		XI Message Buffer Access	20070713
5	_PREFIX	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_XMS_QUEUE_PREFIX			20070911
6	_SH_MEM_CONF	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_XMS_SH_MEM_CONF		Configuration Shared Memory Area	20071109

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ATTACH	Instance method	Public	Method		20071115
2	ATTACH_SPLIT	Instance method	Public	Method		20071119
3	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20070911
4	DETACH	Instance method	Public	Method		20070917
5	GET_ENABLED	Instance method	Public	Method		20071113
6	GET_INSTANCE	Static method	Public	Method		20070713
7	GET_INST_NAME	Instance method	Protected	Method		20071115
8	GET_INST_NAME_INT	Instance method	Protected	Method		20071119
9	GET_MESSAGE	Instance method	Public	Method		20070713
10	GET_MMF	Instance method	Public	Method		20070803
11	GET_SHM_PARAMS	Instance method	Protected	Method		20071115
12	GET_SHM_PARAMS_INT	Instance method	Protected	Method		20071119
13	SET_MESSAGE	Instance method	Public	Method		20070713
14	SET_MMF	Instance method	Public	Method		20070803
15	SET_QUEUE_REF	Instance method	Public	Method		20071112
16	WRITE	Instance method	Protected	Method		20071115

Events

Class CL_XMS_SHARED_MEMORY_BUFFER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	INST_HANDLE	Public	See coding			20070917	BEGIN OF inst_handle, msgid TYPE sxmsmguid, inst TYPE shm_inst_name, handle TYPE REF TO cl_shm_area, END OF inst_handle
2	INST_HANDLE_TTYP	Public	See coding			20070917	inst_handle_ttyp TYPE SORTED TABLE OF inst_handle WITH UNIQUE KEY primary_key COMPONENTS msgid
3	MSGID_FORMAT	Public	See coding			20070920	BEGIN OF msgid_format, msgid TYPE sxmsmguid, format TYPE sxms_shm_format, END OF msgid_format
4	MSGID_FORMAT_TTYP	Public	See coding			20070920	msgid_format_ttyp TYPE SORTED TABLE OF msgid_format WITH UNIQUE KEY primary_key COMPONENTS msgid
5	MSGID_VERS	Public	See coding			20070803	BEGIN OF msgid_vers, vers TYPE sxmslsqnbr, msgid TYPE sxmsmguid, END OF msgid_vers
6	MSGID_VERS_TTYP	Public	See coding			20070803	msgid_vers_ttyp TYPE TABLE OF msgid_vers WITH DEFAULT KEY

Method Signatures

Method ATTACH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MSG_TAB	Call by reference	☐	Type reference (TYPE)	SXMS_MSG_TABLE		Tabelle von Message Referenzen	20071115

Method ATTACH on class CL_XMS_SHARED_MEMORY_BUFFER has no exception.

Method ATTACH_SPLIT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CHILD_TAB	Call by reference	☐	Type reference (TYPE)	SXMSTCHILD		Tabelle von Message Referenzen	20071119
2	Importing	MSG_SIZE	Call by reference	☐	Type reference (TYPE)	INT4		Natürliche Zahl	20071119
3	Importing	PID	Call by reference	☐	Type reference (TYPE)	SXMSPID		Integration Engine: Pipeline-ID	20071119

Method ATTACH_SPLIT on class CL_XMS_SHARED_MEMORY_BUFFER has no exception.

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class CL_XMS_SHARED_MEMORY_BUFFER has no parameter.
Method CONSTRUCTOR on class CL_XMS_SHARED_MEMORY_BUFFER has no exception.

Method DETACH Signature

Method DETACH on class CL_XMS_SHARED_MEMORY_BUFFER has no parameter.
Method DETACH on class CL_XMS_SHARED_MEMORY_BUFFER has no exception.

Method GET_ENABLED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ENABLED	Value transfer	☐	Type reference (TYPE)	CHAR1		Einstelliges Kennzeichen	20071113

Method GET_ENABLED on class CL_XMS_SHARED_MEMORY_BUFFER has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	INST	Value transfer	☐	Object reference (TYPE REF TO)	CL_XMS_SHARED_MEMORY_BUFFER		XI Message Puffer Zugriff	20070713

Method GET_INSTANCE on class CL_XMS_SHARED_MEMORY_BUFFER has no exception.

Method GET_INST_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	INST_NAME	Value transfer	☐	Type reference (TYPE)	SHM_INST_NAME			20071115
2	Importing	MESSAGE	Call by reference	☐	Object reference (TYPE REF TO)	IF_XMS_MESSAGE			20071115

Method GET_INST_NAME on class CL_XMS_SHARED_MEMORY_BUFFER has no exception.

Method GET_INST_NAME_INT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	INST_NAME	Value transfer	☐	Type reference (TYPE)	SHM_INST_NAME			20071119
2	Importing	MSGID	Call by reference	☐	Type reference (TYPE)	SXMSMGUID			20071119
3	Importing	PID	Call by reference	☐	Type reference (TYPE)	SXMSPID			20071119
4	Importing	VERS	Call by reference	☐	Type reference (TYPE)	SXMSLSQNBR			20071119

Method GET_INST_NAME_INT on class CL_XMS_SHARED_MEMORY_BUFFER has no exception.

Method GET_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	FORMAT	Value transfer	☐	Type reference (TYPE)	SXMS_SHM_FORMAT		Format der Message	20070920
2	Exporting	LAST_VERSION	Value transfer	☐	Type reference (TYPE)	SXMSLSQNBR		Fortlaufende Nummer für ID eines Message-Log	20070914
3	Exporting	MESSAGE	Value transfer	☐	Object reference (TYPE REF TO)	IF_XMS_MESSAGE		XI: internal message interface	20070713
4	Importing	MSGID	Call by reference	☐	Type reference (TYPE)	SXMSMGUID		XI: Message-Id	20070713
5	Importing	PID	Call by reference	☐	Type reference (TYPE)	SXMSPID		Verifikation : Process ID	20070713
6	Importing	QUEUE	Call by reference	☐	Type reference (TYPE)	TRFCQNAM		Name einer tRFC-Queue	20070911
7	Importing	VERS	Call by reference	☐	Type reference (TYPE)	SXMSLSQNBR		Fortlaufende Nummer für ID eines Message-Log	20070713

#	Exception	Resumable	Description	Created on
1	CX_XMS_SYSTEM_ERROR	☐	XI: Systemfehler	20070713

Method GET_MMF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	MMF	Value transfer	☐	Object reference (TYPE REF TO)	IF_XMS_MESSAGE_MMF		Multi message interface	20070803
2	Exporting	MSGID_FORMAT_TAB	Value transfer	☐	Type reference (TYPE)	MSGID_FORMAT_TTYP			20070920
3	Importing	MSGID_VERS_TAB	Call by reference	☐	Type reference (TYPE)	MSGID_VERS_TTYP			20070803
4	Importing	PID	Call by reference	☐	Type reference (TYPE)	SXMSPID		Integration Engine: Pipeline-ID	20070803
5	Importing	QUEUE	Call by reference	☐	Type reference (TYPE)	TRFCQNAM		Name einer tRFC-Queue	20070911

#	Exception	Resumable	Description	Created on
1	CX_XMS_SYSTEM_ERROR	☐	XI: Systemfehler	20070803

Method GET_SHM_PARAMS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ATT	Value transfer	☐	Type reference (TYPE)	SHM_ATTACH		Liste der Attaches für den Multi-Attach	20071115
2	Importing	MESSAGE	Value transfer	☐	Object reference (TYPE REF TO)	IF_XMS_MESSAGE			20071115

Method GET_SHM_PARAMS on class CL_XMS_SHARED_MEMORY_BUFFER has no exception.

Method GET_SHM_PARAMS_INT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ATT	Value transfer	☐	Type reference (TYPE)	SHM_ATTACH		Liste der Attaches für den Multi-Attach	20071119
2	Importing	MSGID	Call by reference	☐	Type reference (TYPE)	SXMSMGUID		XI: Message-Id	20071119
3	Importing	MSG_SIZE	Call by reference	☐	Type reference (TYPE)	INT4		Natürliche Zahl	20071119
4	Importing	PID	Call by reference	☐	Type reference (TYPE)	SXMSPID		Integration Engine: Pipeline-ID	20071119
5	Importing	QUEUE	Call by reference	☐	Type reference (TYPE)	TRFCQNAM		Name einer tRFC-Queue	20071119
6	Importing	VERS	Call by reference	☐	Type reference (TYPE)	SXMSLSQNBR		Fortlaufende Nummer für ID eines Message-Log	20071119

Method GET_SHM_PARAMS_INT on class CL_XMS_SHARED_MEMORY_BUFFER has no exception.

Method SET_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MESSAGE	Call by reference	☐	Object reference (TYPE REF TO)	IF_XMS_MESSAGE		XI: internal message interface	20070713

#	Exception	Resumable	Description	Created on
1	CX_XMS_SYSTEM_ERROR	☐	XI: Systemfehler	20070713

Method SET_MMF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MMF	Call by reference	☐	Object reference (TYPE REF TO)	IF_XMS_MESSAGE_MMF		Multi message interface	20070803

#	Exception	Resumable	Description	Created on
1	CX_XMS_SYSTEM_ERROR	☐	XI: Systemfehler	20070803

Method SET_QUEUE_REF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MESSAGE	Call by reference	☐	Object reference (TYPE REF TO)	IF_XMS_MESSAGE		XI: Message-Id	20071116

Method SET_QUEUE_REF on class CL_XMS_SHARED_MEMORY_BUFFER has no exception.

Method WRITE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	HANDLE	Call by reference	☐	Type reference (TYPE)	SHM_ATTACH		Beschreibt einen Attach für den Multi-Attach	20071115
2	Importing	MESSAGE	Call by reference	☐	Object reference (TYPE REF TO)	IF_XMS_MESSAGE		XI: internal message interface	20071115

#	Exception	Resumable	Description	Created on
1	CX_XMS_SYSTEM_ERROR	☐	XI: Systemfehler	20071115

History

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