SAP ABAP Class CL_WEBSOCKET_UTILITY (Web Socket Utility class)
Hierarchy
☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-CST-IC (Application Component) Internet Communication Manager
     ⤷ SICM (Package) Internet Communication Manager
Properties
Class CL_WEBSOCKET_UTILITY  
Short Description Web Socket Utility class    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status S  System Program 
Category 0   
Package SICM   Internet Communication Manager 
Created 20120816   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
Class CL_WEBSOCKET_UTILITY has no interface implemented.
Friends
# Friend Modeled only Created on Description
1 CL_APC_MANAGER 20130207 ABAP Push Channel (APC) WebSocket (WS) framework manager
2 CL_APC_WS_CLIENT 20130214 APC framework: APC WebSocket client class
Attributes
Class CL_WEBSOCKET_UTILITY has no attribute.
Methods
# Method Level Visibility Method type Description Created on
1 CLIENT_CHECK_WS_RESPONSE Static method Private Method Check Web Socket Handshake HTTP Response 20130207
2 CLIENT_GEN_WS_REQUEST Static method Public Method Creates client-side web socket handshake HTTP request 20130207
3 GEN_NEGATIVE_WS_RESPONSE Static method Private Method Deny WebSocket Upgrade request 20120816
4 GEN_POSITIVE_WS_RESPONSE Static method Private Method Set HTTP response for Web Socket Upgrade request 20120816
5 IS_WEBSOCKET_CONN Static method Private Method Check if connection was upgraded to Web Socket 20120816
6 IS_WEBSOCKET_UPGRADE_REQUESTED Static method Private Method Check for Web Socket Upgrade 20120816
Events
Class CL_WEBSOCKET_UTILITY has no event.
Types
Class CL_WEBSOCKET_UTILITY has no local type.
Method Signatures

Method CLIENT_CHECK_WS_RESPONSE Signature

Method CLIENT_CHECK_WS_RESPONSE on class CL_WEBSOCKET_UTILITY has no parameter.
Method CLIENT_CHECK_WS_RESPONSE on class CL_WEBSOCKET_UTILITY has no exception.

Method CLIENT_GEN_WS_REQUEST Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing HTTP_REQUEST Call by reference Object reference (TYPE REF TO) IF_HTTP_REQUEST HTTP Framework (iHTTP) HTTP Request 20130207
2 Importing PROTOCOL Call by reference Type reference (TYPE) STRING Spezifikation des Subprotokolls 20130207
# Exception Resumable Description Created on
1 INTERNAL_ERROR Interner Fehler aufgetreten 20130207

Method GEN_NEGATIVE_WS_RESPONSE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing HTTP_SERVER Call by reference Object reference (TYPE REF TO) IF_HTTP_SERVER HTTP Framework (iHTTP) HTTP Server 20120816
2 Importing REASON Call by reference Type reference (TYPE) STRING Reason for negative upgrade response 20120816

Method GEN_NEGATIVE_WS_RESPONSE on class CL_WEBSOCKET_UTILITY has no exception.

Method GEN_POSITIVE_WS_RESPONSE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing HTTP_SERVER Call by reference Object reference (TYPE REF TO) IF_HTTP_SERVER HTTP Framework (iHTTP) HTTP Server 20120816
2 Importing WEBSOCKET_PROTOCOL Call by reference Type reference (TYPE) STRING Switch to this protocol 20120816
# Exception Resumable Description Created on
1 ILLEGAL_PARAM Illegal Parameter specified 20120816
2 ILLEGAL_REQUEST wrong server object specified 20120816
3 INTERNAL_ERROR internal error occurred 20120816
4 UNSUPPORTED_VERSION requested WebSocket version not supported 20120816

Method IS_WEBSOCKET_CONN Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing HTTP_SERVER Call by reference Object reference (TYPE REF TO) IF_HTTP_SERVER HTTP Framework (iHTTP) HTTP Server 20120816
2 Returning IS_WEBSOCKET_CONN Value transfer Type reference (TYPE) ABAP_BOOL 20120816

Method IS_WEBSOCKET_CONN on class CL_WEBSOCKET_UTILITY has no exception.

Method IS_WEBSOCKET_UPGRADE_REQUESTED Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing HTTP_SERVER Call by reference Object reference (TYPE REF TO) IF_HTTP_SERVER HTTP Framework (iHTTP) HTTP Server 20120816
2 Returning IS_REQUESTED Value transfer Type reference (TYPE) ABAP_BOOL Boolean return value 20120816

Method IS_WEBSOCKET_UPGRADE_REQUESTED on class CL_WEBSOCKET_UTILITY has no exception.
History
Last changed by/on SAP  20140121 
SAP Release Created in 740