SAP ABAP Interface IF_APC_WS_CLIENT_EVENT_HANDLER (APC framework: WebSocket client interface)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-MID-AC (Application Component) ABAP Channels
⤷
SAPC_RUNTIME (Package) APC runtime package
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-MID-AC (Application Component) ABAP Channels⤷
SAPC_RUNTIME (Package) APC runtime package
Properties
| Interface | IF_APC_WS_CLIENT_EVENT_HANDLER | |
| Short Description | APC framework: WebSocket client interface |
General Data
| Package | SAPC_RUNTIME | APC runtime package |
| Created | 20130214 | SAP |
| Last changed | 20140121 | SAP |
| Unicode checks active |
Forward declarations
Interface IF_APC_WS_CLIENT_EVENT_HANDLER has no forward declaration.
Interfaces
Interface IF_APC_WS_CLIENT_EVENT_HANDLER has no interface.
Friends
Interface IF_APC_WS_CLIENT_EVENT_HANDLER has no friend.
Attributes
Interface IF_APC_WS_CLIENT_EVENT_HANDLER has no attribute.
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | ON_CLOSE |
Instance method | Public | Method | Calling method after receiving a WebSocket close event | 20130214 |
| 2 | ON_ERROR |
Instance method | Public | Method | Calling method after receiving a WebSocket error event | 20130214 |
| 3 | ON_MESSAGE |
Instance method | Public | Method | Calling method after receiving a WebSocket message | 20130214 |
| 4 | ON_OPEN |
Instance method | Public | Method | Calling method after successful WebSocket connection setup | 20130214 |
Events
Interface IF_APC_WS_CLIENT_EVENT_HANDLER has no event.
Types
Interface IF_APC_WS_CLIENT_EVENT_HANDLER has no local type.
Method Signatures
Method ON_CLOSE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
I_CODE | Call by reference | Type reference (TYPE) | I | Status code of close | 20130719 | ||
| 2 | Importing |
I_REASON | Call by reference | Type reference (TYPE) | STRING | Reason of close | 20130719 |
Method ON_CLOSE on Interface IF_APC_WS_CLIENT_EVENT_HANDLER has no exception.
Method ON_ERROR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
I_CODE | Call by reference | Type reference (TYPE) | I | Status code | 20130719 | ||
| 2 | Importing |
I_REASON | Call by reference | Type reference (TYPE) | STRING | Reason of error | 20130719 |
Method ON_ERROR on Interface IF_APC_WS_CLIENT_EVENT_HANDLER has no exception.
Method ON_MESSAGE 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: Client interface (do not implement) | 20130214 | ||
| 2 | Importing |
I_MESSAGE | Call by reference | Object reference (TYPE REF TO) | IF_APC_WS_MESSAGE | APC framework: Message interface (do not implement) | 20130214 |
Method ON_MESSAGE on Interface IF_APC_WS_CLIENT_EVENT_HANDLER 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: Client interface (do not implement) | 20130214 |
Method ON_OPEN on Interface IF_APC_WS_CLIENT_EVENT_HANDLER has no exception.
History
| Last changed by/on | SAP | 20140121 |
| SAP Release Created in | 740 |
