SAP ABAP Class CL_APC_WS_HTTP_SESSION_TIMEOUT (ABAP Push Channel HTTP session timeout event)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-MID-AC (Application Component) ABAP Channels
⤷
SAPC_APPLICATION (Package) APC application package
⤷
⤷
Properties
| Class | CL_APC_WS_HTTP_SESSION_TIMEOUT | |
| Short Description | ABAP Push Channel HTTP session timeout event | |
| Super Class | ||
| Instantiability of a Class | 0 | Private |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | SAPC_APPLICATION | APC application package |
| Created | 20130627 | SAP |
| Last change | 20140121 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class CL_APC_WS_HTTP_SESSION_TIMEOUT has no interface implemented.
Friends
Class CL_APC_WS_HTTP_SESSION_TIMEOUT has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Constant | Private | Type reference (TYPE) | I | 1000 | Method call is supported and executed successfully | 20131029 | ||
| 2 | Constant | Private | Type reference (TYPE) | AMC_CHANNEL_ID | '/http_session_timeout' | Identifier of the ABAP Messaging Channel | 20130627 | ||
| 3 | Constant | Private | Type reference (TYPE) | AMC_APPLICATION_ID | 'SYSTEM_CHANNELS' | ABAP Messaging Application identifier | 20130627 | ||
| 4 | Static Attribute | Private | Object reference (TYPE REF TO) | IF_HTTP_SERVER | HTTP Framework (iHTTP) HTTP Server | 20130627 | |||
| 5 | Static Attribute | Private | Type reference (TYPE) | GTYPE_SESSION_ID | 20130627 | ||||
| 6 | Static Attribute | Private | Type reference (TYPE) | GTYPE_SESSION_REGISTRATION | 20130627 | ||||
| 7 | Instance attribute | Private | Object reference (TYPE REF TO) | LCL_HTTP_CONTEXT | 20130627 | ||||
| 8 | Static Attribute | Private | Type reference (TYPE) | GTYPE_SESSION_ID | 20130627 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Method | Activate SAPGUI progress indicator in HTTP contex | 20130627 | |
| 2 | Instance method | Public | Method | Deactivate SAPGUI progress indicator in HTTP contex | 20130627 | |
| 3 | Static method | Public | Method | Create or get an instance of progress indicator | 20130627 | |
| 4 | Static method | Public | Method | Bind AMC channel to SAPGUI progress indicator | 20130627 | |
| 5 | Static method | Private | Method | Send SAPGUI progress indicator information | 20130627 |
Events
Class CL_APC_WS_HTTP_SESSION_TIMEOUT has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | GTYPE_SESSION_ID | Public | See coding | 20130627 | gtype_session_id TYPE c LENGTH 32
|
||
| 2 | GTYPE_SESSION_REGISTRATION | Private | See coding | 20130627 | BEGIN OF gtype_session_registration,
session_id_field_name TYPE string,
session_id TYPE gtype_session_id,
session_timeout TYPE REF TO cl_apc_ws_http_session_timeout,
END OF gtype_session_registration
|
Method Signatures
Method ACTIVATE Signature
Method ACTIVATE on class CL_APC_WS_HTTP_SESSION_TIMEOUT has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | APC WS HTTP session timeout exception class | 20130627 |
Method DEACTIVATE Signature
Method DEACTIVATE on class CL_APC_WS_HTTP_SESSION_TIMEOUT has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | APC WS HTTP session timeout exception class | 20130627 |
Method GET Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_CHECK_RECEIVER | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Check the availability of APC WebSocket receiver | 20130826 | ||
| 2 | I_SERVER | Call by reference | Object reference (TYPE REF TO) | IF_HTTP_SERVER | HTTP Framework (iHTTP) HTTP Server | 20130627 | |||
| 3 | I_SESSION_ID | Call by reference | Type reference (TYPE) | GTYPE_SESSION_ID | 20130627 | ||||
| 4 | I_SESSION_ID_FIELD_NAME | Call by reference | Type reference (TYPE) | STRING | 'SESSION_ID' | PCP field name | 20130711 | ||
| 5 | R_SESSION_TIMEOUT | Value transfer | Object reference (TYPE REF TO) | CL_APC_WS_HTTP_SESSION_TIMEOUT | ABAP Push Channel HTTP session timeout event | 20130627 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | APC WS HTTP session timeout exception class | 20130627 |
Method PREPARE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_BINDING_MANAGER | Call by reference | Object reference (TYPE REF TO) | IF_APC_WS_BINDING_MANAGER | APC framework: Connection binding manager (do not implement) | 20130627 | |||
| 2 | I_SESSION_ID | Call by reference | Type reference (TYPE) | GTYPE_SESSION_ID | 20130627 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | APC WS HTTP session timeout exception class | 20130627 |
Method SEND Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_REASON | Call by reference | Type reference (TYPE) | I | 20130722 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | APC WS HTTP session timeout exception class | 20130627 |
History
| Last changed by/on | SAP | 20140121 |
| SAP Release Created in | 740 |