SAP ABAP Class CL_TREX_ICM_CLIENT (TREX Client using ICM)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-TRX-API (Application Component) TREX ABAP + JAVA API
     ⤷ STREX (Package) TREX ABAP client

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_TREX_ASYNC_CONNECTION	Connection to TREX Allowing Asynchronous Communication	20070201
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_TREX_CONNECTION	Connection to TREX	20061220

Properties

Class	CL_TREX_ICM_CLIENT
Short Description	TREX Client using ICM
Super Class
Instantiability of a Class	1	Protected
Final	☐

General Data

Message Class
Program status
Category	0
Package	STREX	TREX ABAP client
Created	20050817	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)
2	IF_TREX_CONNECTION	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_TREX_ASYNC_CONNECTION	☐	☐	Connection to TREX Allowing Asynchronous Communication	20070201
2	IF_TREX_CONNECTION	☐	☐	Connection to TREX	20061220

Friends

#	Friend	Modeled only	Created on	Description
1	CL_TREX_FACTORY	☐	20060302	Factory

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	ASYNC_CONNECTIONS	Static Attribute	Private	☐	Type reference (TYPE)	T_ASYNC_CONNECTIONS			20070206
2	COMPRESSION	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20060215
3	C_CLASS_NAME	Constant	Private	☐	Type reference (TYPE)	STRING	'CL_TREX_ICM_CLIENT->'		20050929
4	C_ENDIAN_BIG	Constant	Public	☐	Type reference (TYPE)	STRING	'3830282018100800'		20060201
5	C_ENDIAN_BIG_UTF8	Constant	Public	☐	Type reference (TYPE)	XSTRING	'33383330323832303138313030383030'		20060522
6	C_ENDIAN_LITTLE	Constant	Public	☐	Type reference (TYPE)	STRING	'0008101820283038'		20060201
7	C_ENDIAN_LITTLE_UTF8	Constant	Public	☐	Type reference (TYPE)	XSTRING	'30303038313031383230323833303338'		20060522
8	C_PATH_ASXML	Instance attribute	Private	☐	Attribute reference (LIKE)				20080924
9	C_PERF_ID_REMOTE_CALL	Instance attribute	Public	☐	Attribute reference (LIKE)				20061221
10	C_PROTOCOL_VERSION	Constant	Public	☐	Type reference (TYPE)	STRING	IF_TREX_CONNECTION=>C_PROTOCOL_VERSION		20051006
11	C_TREXNET_VERSION	Constant	Private	☐	Type reference (TYPE)	STRING	'1.0.0'		20050817
12	DEFAULT_STREAMING	Static Attribute	Public	☐	Type reference (TYPE)	ABAP_BOOL			20080128
13	FUNCTION	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20070104
14	HTTP_CLIENT	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_HTTP_CLIENT		HTTP Client Abstraction	20050817
15	ID	Instance attribute	Public	☑	Type reference (TYPE)	I			20070206
16	R3_VERSION_INFO	Static Attribute	Private	☐	Type reference (TYPE)	STRING			20050817
17	SERVER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_TREX_INDEX_SERVER		Index Server	20070104
18	START_TIME	Instance attribute	Private	☐	Type reference (TYPE)	I			20070201
19	STREAMING	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20071219

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CALL	Instance method	Public	Method		20070104
2	CALL_WITH_XSTRINGS	Instance method	Public	Method		20050818
3	CHECK_STATUS	Instance method	Private	Method		20071219
4	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20080128
5	CLOSE	Instance method	Public	Method		20080924
6	COMPRESS	Instance method	Public	Method		20050817
7	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20050817
8	INIT	Instance method	Private	Method		20070104
9	INIT_HEADER	Instance method	Private	Method		20050817
10	INIT_R3_VERSION_INFO	Static method	Private	Method		20060518
11	LISTEN	Static method	Public	Method		20070206
12	RECEIVE	Instance method	Public	Method		20070201
13	RECEIVE_SXML_READABLE	Instance method	Public	Method		20071219
14	RECEIVE_XSTRING	Instance method	Public	Method		20070201
15	REDIRECT	Instance method	Public	Method		20070104
16	SEND	Instance method	Public	Method		20070201
17	SEND_XSTRING	Instance method	Public	Method		20070201
18	SET_ENDIAN	Instance method	Private	Method		20060630
19	SET_REQUEST_ENDIAN	Instance method	Private	Method		20060522
20	SET_RESPONSE_ENDIAN	Instance method	Private	Method		20060522
21	_RECEIVE	Instance method	Private	Method		20071219
22	_SEND	Instance method	Private	Method		20071219

Events

Class CL_TREX_ICM_CLIENT has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	T_ASYNC_CONNECTIONS	Private	See coding			20070206	t_async_connections type hashed table of t_async_connection_pair with unique key http
2	T_ASYNC_CONNECTION_PAIR	Private	See coding			20070206	begin of t_async_connection_pair , http type ref to if_http_client , trex type ref to cl_trex_icm_client , end of t_async_connection_pair

Method Signatures

Method CALL Signature

Method CALL on class CL_TREX_ICM_CLIENT has no parameter.
Method CALL on class CL_TREX_ICM_CLIENT has no exception.

Method CALL_WITH_XSTRINGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	REQUEST	Call by reference	☐	Type reference (TYPE)	XSTRING			20050906
2	Importing	REQUEST_ENDIAN	Call by reference	☑	Type reference (TYPE)	STRING			20060522
3	Exporting	RESPONSE	Call by reference	☐	Type reference (TYPE)	XSTRING			20050906
4	Importing	RESPONSE_ENDIAN	Call by reference	☑	Type reference (TYPE)	STRING			20060522

#	Exception	Resumable	Description	Created on
1	CX_TREX_REMOTE_COMMUNICATION	☐	Ausnahme Remote-Kommunikation	20050818

Method CHECK_STATUS Signature

Method CHECK_STATUS on class CL_TREX_ICM_CLIENT has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_TREX_REMOTE_COMMUNICATION	☐	Remote Communication Exception	20071219

Method CLASS_CONSTRUCTOR Signature

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

Method CLOSE Signature

Method CLOSE on class CL_TREX_ICM_CLIENT has no parameter.
Method CLOSE on class CL_TREX_ICM_CLIENT has no exception.

Method COMPRESS Signature

Method COMPRESS on class CL_TREX_ICM_CLIENT has no parameter.
Method COMPRESS on class CL_TREX_ICM_CLIENT has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FUNCTION	Call by reference	☐	Type reference (TYPE)	STRING			20060302
2	Importing	HOST	Call by reference	☐	Type reference (TYPE)	STRING			20061220
3	Importing	ID	Call by reference	☑	Type reference (TYPE)	I			20070206
4	Importing	PORT	Call by reference	☐	Type reference (TYPE)	STRING			20061220
5	Importing	STREAMING	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20071219

#	Exception	Resumable	Description	Created on
1	CX_TREX_REMOTE_INITIALIZATION	☐	Remote-Kommunikation konnte nicht initialisiert werden	20060302

Method INIT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FUNCTION	Call by reference	☐	Type reference (TYPE)	STRING			20070104
2	Importing	SERVER	Call by reference	☐	Object reference (TYPE REF TO)	CL_TREX_INDEX_SERVER		Index Server	20070104

#	Exception	Resumable	Description	Created on
1	CX_TREX_REMOTE_INITIALIZATION	☐	Failed to Initialize Remote Communication	20070104

Method INIT_HEADER Signature

Method INIT_HEADER on class CL_TREX_ICM_CLIENT has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_TREX_REMOTE_INITIALIZATION	☐	Remote-Kommunikation konnte nicht initialisiert werden	20050818

Method INIT_R3_VERSION_INFO Signature

Method INIT_R3_VERSION_INFO on class CL_TREX_ICM_CLIENT has no parameter.
Method INIT_R3_VERSION_INFO on class CL_TREX_ICM_CLIENT has no exception.

Method LISTEN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RVAL	Value transfer	☐	Object reference (TYPE REF TO)	CL_TREX_ICM_CLIENT		TREX Client using ICM	20070206

#	Exception	Resumable	Description	Created on
1	CX_TREX_REMOTE_COMMUNICATION	☐	Remote Communication Exception	20100630

Method RECEIVE Signature

Method RECEIVE on class CL_TREX_ICM_CLIENT has no parameter.
Method RECEIVE on class CL_TREX_ICM_CLIENT has no exception.

Method RECEIVE_SXML_READABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	RESPONSE	Call by reference	☐	Object reference (TYPE REF TO)	IF_TREX_SXML_READABLE		Readable from SXML Reader	20071219

#	Exception	Resumable	Description	Created on
1	CX_TREX_REMOTE_COMMUNICATION	☐	Remote Communication Exception	20071219
2	CX_XSLT_SYSTEM_ERROR	☐	Error During a Transformation	20080924

Method RECEIVE_XSTRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	RESPONSE	Call by reference	☐	Type reference (TYPE)	XSTRING			20070201

#	Exception	Resumable	Description	Created on
1	CX_TREX_REMOTE_COMMUNICATION	☐	Remote Communication Exception	20070201

Method REDIRECT Signature

Method REDIRECT on class CL_TREX_ICM_CLIENT has no parameter.
Method REDIRECT on class CL_TREX_ICM_CLIENT has no exception.

Method SEND Signature

Method SEND on class CL_TREX_ICM_CLIENT has no parameter.
Method SEND on class CL_TREX_ICM_CLIENT has no exception.

Method SEND_XSTRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	REQUEST	Call by reference	☐	Type reference (TYPE)	XSTRING			20070201
2	Importing	REQUEST_ENDIAN	Call by reference	☑	Type reference (TYPE)	STRING			20070201
3	Importing	RESPONSE_ENDIAN	Call by reference	☑	Type reference (TYPE)	STRING			20070201

#	Exception	Resumable	Description	Created on
1	CX_TREX_REMOTE_COMMUNICATION	☐	Remote Communication Exception	20070201

Method SET_ENDIAN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	REQUEST_ENDIAN	Call by reference	☑	Type reference (TYPE)	STRING			20060630
2	Importing	RESPONSE_ENDIAN	Call by reference	☑	Type reference (TYPE)	STRING			20060630

Method SET_ENDIAN on class CL_TREX_ICM_CLIENT has no exception.

Method SET_REQUEST_ENDIAN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ENDIAN	Call by reference	☐	Type reference (TYPE)	STRING			20060522

Method SET_REQUEST_ENDIAN on class CL_TREX_ICM_CLIENT has no exception.

Method SET_RESPONSE_ENDIAN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ENDIAN	Call by reference	☐	Type reference (TYPE)	STRING			20060522

Method SET_RESPONSE_ENDIAN on class CL_TREX_ICM_CLIENT has no exception.

Method _RECEIVE Signature

Method _RECEIVE on class CL_TREX_ICM_CLIENT has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_TREX_HTTP	☐	Remote Communication Exception	20100510

Method _SEND Signature

Method _SEND on class CL_TREX_ICM_CLIENT has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_TREX_REMOTE_COMMUNICATION	☐	Remote Communication Exception	20071219

History

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