SAP ABAP Class CL_APC_WS_MESSAGE (APC framework: WebSocket message handling)

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_MESSAGE	APC framework: Message interface (do not implement)	20120903

Properties

Class	CL_APC_WS_MESSAGE
Short Description	APC framework: WebSocket message handling
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status	S	System Program
Category	0
Package	SAPC_RUNTIME	APC runtime package
Created	20120903	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_MESSAGE	☐	☐	APC framework: Message interface (do not implement)	20120903

Friends

#	Friend	Modeled only	Created on	Description
1	CL_APC_MANAGER	☐	20120917	ABAP Push Channel (APC) WebSocket (WS) framework manager
2	CL_APC_WS_CLIENT	☐	20130215	APC framework: APC WebSocket client class
3	CL_APC_WS_MESSAGE_MANAGER	☐	20121120	APC framework: WebSocket message manager

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_INCOMING_MESSAGE_EVENT	Constant	Private	☐	Type reference (TYPE)	I	2	Incoming WebSocket message	20121204
2	CO_INCOMING_MESSAGE_START	Constant	Private	☐	Type reference (TYPE)	I	1	Incoming WebSocket message	20121204
3	CO_MESSAGE_TYPE_BINARY	Instance attribute	Public	☐	Attribute reference (LIKE)				20121126
4	CO_MESSAGE_TYPE_TEXT	Instance attribute	Public	☐	Attribute reference (LIKE)				20121126
5	CO_METHOD_ACCESS_ERROR	Constant	Private	☐	Type reference (TYPE)	I	100	Accessing method failed	20121204
6	CO_OUTGOING_MESSAGE	Constant	Private	☐	Type reference (TYPE)	I	3	Outgoing WebSocket message	20121204
7	M_APPLICATION	Instance attribute	Private	☐	Type reference (TYPE)	APC_APPL_V		Generated Table for View	20121024
8	M_BINARY_MESSAGE	Instance attribute	Private	☐	Type reference (TYPE)	XSTRING			20121119
9	M_CONTEXT	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_APC_WS_CONTEXT		APC framework: WebSocket context interface	20120917
10	M_HTTP_REQUEST	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_HTTP_REQUEST		HTTP Framework (iHTTP) HTTP Request	20120917
11	M_MESSAGE_TYPE	Instance attribute	Private	☐	Type reference (TYPE)	I		Used message type (CO_MESSAGE_TYPE_*)	20130213
12	M_MESSAGING_OBJECT_TYPE	Instance attribute	Private	☐	Type reference (TYPE)	I		WebSocket message type (incoming/outgoing)	20121204
13	M_SCANNER_RECEIVE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_VSI		Virus Scan API for Application Developers	20121019
14	M_SCANNER_SEND	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_VSI		Virus Scan API for Application Developers	20121024
15	M_TEXT_MESSAGE	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20121119

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CREATE_INCOMING_MESSAGE	Static method	Private	Method	Create APC WebSocket incoming message object	20120917
2	CREATE_OUTGOING_MESSAGE	Static method	Private	Method	Create APC WebSocket outgoing message object	20120917
3	GET_BINARY	Instance method	Public	Method		20120917
4	GET_CONTEXT	Instance method	Public	Method		20121119
5	GET_MESSAGE_TYPE	Instance method	Public	Method		20120917
6	GET_TEXT	Instance method	Public	Method		20120917
7	SET_BINARY	Instance method	Public	Method		20120917
8	SET_TEXT	Instance method	Public	Method		20120917
9	VIRUS_SCAN_MESSAGE	Instance method	Private	Method	Check message content via virus scanner	20121030

Events

Class CL_APC_WS_MESSAGE has no event.

Types

Class CL_APC_WS_MESSAGE has no local type.

Method Signatures

Method CREATE_INCOMING_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_APPLICATION	Call by reference	☐	Type reference (TYPE)	APC_APPL_V		Generated Table for View	20121024
2	Importing	I_BINARY_MESSAGE	Call by reference	☑	Type reference (TYPE)	XSTRING			20121204
3	Importing	I_HTTP_REQUEST	Call by reference	☑	Object reference (TYPE REF TO)	IF_HTTP_REQUEST		HTTP Framework (iHTTP) HTTP Request	20121024
4	Importing	I_TEXT_MESSAGE	Call by reference	☑	Type reference (TYPE)	STRING			20121204
5	Returning	R_MESSAGE	Value transfer	☐	Object reference (TYPE REF TO)	IF_APC_WS_MESSAGE		APC framework: WebSocket message interface	20120903

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

Method CREATE_OUTGOING_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_APPLICATION	Call by reference	☐	Type reference (TYPE)	APC_APPL_V		Generated Table for View	20121024
2	Returning	R_MESSAGE	Value transfer	☐	Object reference (TYPE REF TO)	IF_APC_WS_MESSAGE		APC framework: WebSocket message interface	20121024

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

Method GET_BINARY Signature

Method GET_BINARY on class CL_APC_WS_MESSAGE has no parameter.
Method GET_BINARY on class CL_APC_WS_MESSAGE has no exception.

Method GET_CONTEXT Signature

Method GET_CONTEXT on class CL_APC_WS_MESSAGE has no parameter.
Method GET_CONTEXT on class CL_APC_WS_MESSAGE has no exception.

Method GET_MESSAGE_TYPE Signature

Method GET_MESSAGE_TYPE on class CL_APC_WS_MESSAGE has no parameter.
Method GET_MESSAGE_TYPE on class CL_APC_WS_MESSAGE has no exception.

Method GET_TEXT Signature

Method GET_TEXT on class CL_APC_WS_MESSAGE has no parameter.
Method GET_TEXT on class CL_APC_WS_MESSAGE has no exception.

Method SET_BINARY Signature

Method SET_BINARY on class CL_APC_WS_MESSAGE has no parameter.
Method SET_BINARY on class CL_APC_WS_MESSAGE has no exception.

Method SET_TEXT Signature

Method SET_TEXT on class CL_APC_WS_MESSAGE has no parameter.
Method SET_TEXT on class CL_APC_WS_MESSAGE has no exception.

Method VIRUS_SCAN_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_MESSAGE_BINARY	Call by reference	☑	Type reference (TYPE)	XSTRING			20121031
2	Importing	I_MESSAGE_TEXT	Call by reference	☑	Type reference (TYPE)	STRING			20121031
3	Importing	I_VSI	Call by reference	☐	Object reference (TYPE REF TO)	CL_VSI		Virus Scan API for Application Developers	20130109

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

History

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