SAP ABAP Interface IF_APC_WS_MESSAGE (APC framework: Message interface (do not implement))

Hierarchy

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

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	CL_APC_WS_MESSAGE	APC framework: WebSocket message handling	20120903

Properties

Interface	IF_APC_WS_MESSAGE
Short Description	APC framework: Message interface (do not implement)

General Data

Package	SAPC_RUNTIME	APC runtime package
Created	20120831	SAP
Last changed	20130531	SAP
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 IF_APC_WS_MESSAGE has no interface.

Friends

Interface IF_APC_WS_MESSAGE has no friend.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_MESSAGE_TYPE_BINARY	Constant	Public	☐	Type reference (TYPE)	I	2	Message type binary	20121119
2	CO_MESSAGE_TYPE_TEXT	Constant	Public	☐	Type reference (TYPE)	I	1	Message type text	20121119

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	GET_BINARY	Instance method	Public	Method	Returns WebSocket binary message	20120917
2	GET_CONTEXT	Instance method	Public	Method	Returns APC WebSocket context interface	20120917
3	GET_MESSAGE_TYPE	Instance method	Public	Method	Returns WebSocket message type	20120917
4	GET_TEXT	Instance method	Public	Method	Returns WebSocket text message	20120917
5	SET_BINARY	Instance method	Public	Method	Sets WebSocket binary message	20120917
6	SET_TEXT	Instance method	Public	Method	Sets WebSocket text message	20120917

Events

Interface IF_APC_WS_MESSAGE has no event.

Types

Interface IF_APC_WS_MESSAGE has no local type.

Method Signatures

Method GET_BINARY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_MESSAGE	Value transfer	☐	Type reference (TYPE)	XSTRING			20120903

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

Method GET_CONTEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_CONTEXT	Value transfer	☐	Object reference (TYPE REF TO)	IF_APC_WS_CONTEXT		APC framework: WebSocket context interface	20120904

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

Method GET_MESSAGE_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_TYPE	Value transfer	☐	Type reference (TYPE)	I			20120903

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

Method GET_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_MESSAGE	Value transfer	☐	Type reference (TYPE)	STRING			20120903

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

Method SET_BINARY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_MESSAGE	Call by reference	☐	Type reference (TYPE)	XSTRING			20120903

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

Method SET_TEXT Signature

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

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

History

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