SAP ABAP Interface IF_APC_WS_CLIENT (APC framework: WebSocket client 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_CLIENT	APC framework: APC WebSocket client class	20130214

Properties

Interface	IF_APC_WS_CLIENT
Short Description	APC framework: WebSocket client interface (do not implement)

General Data

Package	SAPC_RUNTIME	APC runtime package
Created	20130213	SAP
Last changed	20140121	SAP
Unicode checks active	☑

Forward declarations

Interface IF_APC_WS_CLIENT has no forward declaration.

Interfaces

Interface IF_APC_WS_CLIENT has no interface.

Friends

Interface IF_APC_WS_CLIENT has no friend.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_CONNECTION_STATE_CLOSED	Constant	Public	☐	Type reference (TYPE)	I	3	The connection has been closed or could not be opened.	20130218
2	CO_CONNECTION_STATE_CLOSING	Constant	Public	☐	Type reference (TYPE)	I	2	The connection is closing.	20130305
3	CO_CONNECTION_STATE_CONNECTING	Constant	Public	☐	Type reference (TYPE)	I	0	The connection has not yet been established.	20130218
4	CO_CONNECTION_STATE_OPEN	Constant	Public	☐	Type reference (TYPE)	I	1	The connection is established and communication is possible.	20130218
5	CO_CONNECTION_STATE_UNDEFINED	Constant	Public	☐	Type reference (TYPE)	I	-1	WebSocket connection in "UNDEFINED" state	20130218
6	CO_MESSAGE_INCOMING	Constant	Public	☐	Type reference (TYPE)	I	2	Incoming message	20130214
7	CO_MESSAGE_OUTGOING	Constant	Public	☐	Type reference (TYPE)	I	1	Outgoing message	20130214

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CLOSE	Instance method	Public	Method	Close WebSocket connection	20130214
2	CONNECT	Instance method	Public	Method	Initiate WebSocket connection setup	20130214
3	CREATE_MESSAGE	Instance method	Public	Method	Create message	20130214
4	GET_CONNECTION_STATE	Instance method	Public	Method	Get WebSocket connection state	20130218
5	GET_INITIAL_REQUEST	Instance method	Public	Method	Get initial request interface	20130214
6	SEND	Instance method	Public	Method	Send message	20130214
7	SET_VIRUS_SCAN_PROFILE	Instance method	Public	Method	Set virus scan profile	20130214

Events

Interface IF_APC_WS_CLIENT has no event.

Types

Interface IF_APC_WS_CLIENT has no local type.

Method Signatures

Method CLOSE Signature

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

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

Method CONNECT Signature

Method CONNECT on Interface IF_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

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_MESSAGE	Value transfer	☐	Object reference (TYPE REF TO)	IF_APC_WS_MESSAGE		APC framework: Message interface (do not implement)	20130214

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

Method GET_CONNECTION_STATE Signature

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

Method GET_CONNECTION_STATE on Interface IF_APC_WS_CLIENT has no exception.

Method GET_INITIAL_REQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_INITIAL_REQUEST	Value transfer	☐	Object reference (TYPE REF TO)	IF_APC_WS_CLIENT_INITIAL_REQ		APC framework: Client initial request (do not implement)	20130214

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

Method SEND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_MESSAGE	Call by reference	☐	Object reference (TYPE REF TO)	IF_APC_WS_MESSAGE		APC framework: Message interface (do not implement)	20130214

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

Method SET_VIRUS_SCAN_PROFILE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_MESSAGE_TRANSFER_DIRECTION	Call by reference	☐	Type reference (TYPE)	I	CO_MESSAGE_OUTGOING	CCO_MESSAGE_OUTGOING or CO_MESSAGE_INCOMING	20130214
2	Importing	I_VSCAN_PROFILE	Call by reference	☐	Type reference (TYPE)	VSCAN_PROFILE		Virus Scan Profile	20130214

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

History

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