SAP ABAP Class CL_APC_WS_CLIENT (APC framework: APC WebSocket client class)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-MID-AC (Application Component) ABAP Channels
     ⤷ SAPC_RUNTIME (Package) APC runtime package

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_APC_WS_CLIENT	APC framework: WebSocket client interface (do not implement)	20130214

Properties

Class	CL_APC_WS_CLIENT
Short Description	APC framework: APC WebSocket client class
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status	S	System Program
Category	0
Package	SAPC_RUNTIME	APC runtime package
Created	20130214	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)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_APC_WS_CLIENT	☐	☐	APC framework: WebSocket client interface (do not implement)	20130214

Friends

#	Friend	Modeled only	Created on	Description
1	CL_ABAP_APC_DISPATCHER	☐	20130219	Dispatcher for AMC Messages
2	CL_APC_WS_CLIENT_MANAGER	☐	20130215	APC framework: Manager class for APC WebSocket Client
3	CL_APC_WS_INITIAL_REQUEST	☐	20130215	APC framework: Initial request at WebSocket connection setup

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_CONNECTION_STATE_CLOSED	Instance attribute	Public	☐	Attribute reference (LIKE)				20130218
2	CO_CONNECTION_STATE_CLOSING	Instance attribute	Public	☐	Attribute reference (LIKE)				20130305
3	CO_CONNECTION_STATE_CONNECTING	Instance attribute	Public	☐	Attribute reference (LIKE)				20130218
4	CO_CONNECTION_STATE_OPEN	Instance attribute	Public	☐	Attribute reference (LIKE)				20130218
5	CO_CONNECTION_STATE_UNDEFINED	Instance attribute	Public	☐	Attribute reference (LIKE)				20130218
6	CO_CREATE_CLIENT_BY_DEST	Constant	Private	☐	Type reference (TYPE)	I	2	Create APC by destination	20130222
7	CO_CREATE_CLIENT_BY_URL	Constant	Private	☐	Type reference (TYPE)	I	1	Create APC by URL	20130222
8	CO_MESSAGE_INCOMING	Instance attribute	Public	☐	Attribute reference (LIKE)				20130214
9	CO_MESSAGE_OUTGOING	Instance attribute	Public	☐	Attribute reference (LIKE)				20130214
10	G_REGISTERED_CLIENTS	Static Attribute	Private	☐	Type reference (TYPE)	GT_REGISTERED_CLIENTS			20130215
11	M_CLIENT_ID	Instance attribute	Private	☐	Type reference (TYPE)	SYSUUID_C		Client ID	20130215
12	M_CREATE_CLIENT_BY	Instance attribute	Private	☐	Type reference (TYPE)	I		Creation type of APC client	20130222
13	M_EVENT_HANDLER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_APC_WS_CLIENT_EVENT_HANDLER		APC framework: WebSocket client interface	20130215
14	M_HTTP_CLIENT	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_HTTP_CLIENT		HTTP Client Abstraction	20130214
15	M_HTTP_CLIENT_STATISTIC	Instance attribute	Private	☐	Type reference (TYPE)	GT_HTTP_CLIENT_STATISTIC			20130610
16	M_HTTP_DESTINATION	Instance attribute	Private	☐	Type reference (TYPE)	STRING		HTTP destiantion in use	20130222
17	M_HTTP_URL	Instance attribute	Private	☐	Type reference (TYPE)	STRING		HTTP URL in use	20130222
18	M_INITIAL_REQUEST	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_APC_WS_INITIAL_REQUEST		APC framework: Initial request at WebSocket connection setup	20130214
19	M_MESSAGE_MANAGER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_APC_WS_MESSAGE_MANAGER		APC framework: WebSocket message manager	20130214
20	M_READY_STATE	Instance attribute	Private	☐	Type reference (TYPE)	I		WebSocket Connection state	20130218
21	M_VSI_PROFILE_INCOMING	Instance attribute	Private	☐	Type reference (TYPE)	VSCAN_PROFILE		Virus Scan Profile	20130214
22	M_VSI_PROFILE_OUTGOING	Instance attribute	Private	☐	Type reference (TYPE)	VSCAN_PROFILE		Virus Scan Profile	20130214
23	M_WS_SUBPROTOCOL	Instance attribute	Private	☐	Type reference (TYPE)	STRING		WeBSocket subprotocol	20130214

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CLOSE	Instance method	Public	Method		20130214
2	CONNECT	Instance method	Public	Method		20130214
3	CREATE_BY_DESTINATION	Instance method	Private	Method	Create HTTP client by destination	20130222
4	CREATE_BY_URL	Instance method	Private	Method	Create HTTP client by URL	20130222
5	CREATE_MESSAGE	Instance method	Public	Method		20130214
6	DESTRUCTOR	Instance method	Public	Destructor	Destructor for APC clients in kernel	20130218
7	DISPATCH	Static method	Private	Method	Dispatch messages to the subscribed clients	20130215
8	GET_CONNECTION_STATE	Instance method	Public	Method		20130218
9	GET_HTTP_KERNEL_STATATISTIC	Instance method	Private	Method	Set HTTP client statitics for APC WS	20130610
10	GET_INITIAL_REQUEST	Instance method	Public	Method		20130214
11	ON_OPEN	Instance method	Private	Method	Execute ON_OPEN event	20130215
12	SEND	Instance method	Public	Method		20130214
13	SET_VIRUS_SCAN_PROFILE	Instance method	Public	Method		20130214

Events

Class CL_APC_WS_CLIENT has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	GT_HTTP_CLIENT_STATISTIC	Private	See coding			20130610	BEGIN OF gt_http_client_statistic, protocol TYPE i, host TYPE string, port TYPE string, path TYPE string, END OF gt_http_client_statistic
2	GT_REGISTERED_CLIENT	Private	See coding			20130215	BEGIN OF gt_registered_client, client_id TYPE sysuuid_c, client TYPE REF TO cl_apc_ws_client, " cl_abap_weak_reference, " event_handler TYPE REF TO if_apc_ws_client_event_handler, END OF gt_registered_client
3	GT_REGISTERED_CLIENTS	Private	See coding			20130215	gt_registered_clients TYPE HASHED TABLE OF gt_registered_client WITH UNIQUE KEY client_id

Method Signatures

Method CLOSE Signature

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

Method CONNECT Signature

Method CONNECT on class CL_APC_WS_CLIENT has no parameter.
Method CONNECT on class CL_APC_WS_CLIENT has no exception.

Method CREATE_BY_DESTINATION Signature

Method CREATE_BY_DESTINATION on class CL_APC_WS_CLIENT has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_APC_ERROR	☐	APC framework: Error handling class for ABAP Push Channel	20130225

Method CREATE_BY_URL Signature

Method CREATE_BY_URL on class CL_APC_WS_CLIENT has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_APC_ERROR	☐	APC framework: Error handling class for ABAP Push Channel	20130225

Method CREATE_MESSAGE Signature

Method CREATE_MESSAGE on class CL_APC_WS_CLIENT has no parameter.
Method CREATE_MESSAGE on class CL_APC_WS_CLIENT has no exception.

Method DESTRUCTOR Signature

Method DESTRUCTOR on class CL_APC_WS_CLIENT has no parameter.
Method DESTRUCTOR on class CL_APC_WS_CLIENT has no exception.

Method DISPATCH Signature

Method DISPATCH on class CL_APC_WS_CLIENT has no parameter.
Method DISPATCH on class CL_APC_WS_CLIENT has no exception.

Method GET_CONNECTION_STATE Signature

Method GET_CONNECTION_STATE on class CL_APC_WS_CLIENT has no parameter.
Method GET_CONNECTION_STATE on class CL_APC_WS_CLIENT has no exception.

Method GET_HTTP_KERNEL_STATATISTIC Signature

Method GET_HTTP_KERNEL_STATATISTIC on class CL_APC_WS_CLIENT has no parameter.
Method GET_HTTP_KERNEL_STATATISTIC on class CL_APC_WS_CLIENT has no exception.

Method GET_INITIAL_REQUEST Signature

Method GET_INITIAL_REQUEST on class CL_APC_WS_CLIENT has no parameter.
Method GET_INITIAL_REQUEST on class CL_APC_WS_CLIENT has no exception.

Method ON_OPEN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CLIENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_APC_WS_CLIENT		APC framework: WebSocket client interface (do not implement)	20130215
2	Importing	I_EVENT_HANDLER	Call by reference	☐	Object reference (TYPE REF TO)	IF_APC_WS_CLIENT_EVENT_HANDLER		APC framework: WebSocket client interface	20130215

#	Exception	Resumable	Description	Created on
1	CX_APC_ERROR	☐	APC framework: Error handling class for ABAP Push Channel	20130225

Method SEND Signature

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

Method SET_VIRUS_SCAN_PROFILE Signature

Method SET_VIRUS_SCAN_PROFILE on class CL_APC_WS_CLIENT has no parameter.
Method SET_VIRUS_SCAN_PROFILE on class CL_APC_WS_CLIENT has no exception.

History

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