SAP ABAP Class CL_SSI_WEBSOCKET (Basic Web Socket Handling)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-CST (Application Component) Client/Server Technology
     ⤷ SSI_MSG (Package) Messaging

Properties

Class	CL_SSI_WEBSOCKET
Short Description	Basic Web Socket Handling
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SSI_MSG	Messaging
Created	20121203	SAP
Last change	20140121	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_SSI_WEBSOCKET has no forward declaration.

Interfaces

Class CL_SSI_WEBSOCKET has no interface implemented.

Friends

Class CL_SSI_WEBSOCKET has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_ROLE_CLIENT	Constant	Public	☐	Type reference (TYPE)	I	0	Role of WebSocket	20130215
2	CO_ROLE_SERVER	Constant	Public	☐	Type reference (TYPE)	I	1	Role of WebSocket	20130215
3	CO_SESSION_MODE_INVALID	Constant	Public	☐	Type reference (TYPE)	I	0	Session Mode	20121203
4	CO_SESSION_MODE_STATEFUL	Constant	Public	☐	Type reference (TYPE)	I	2	Session Mode	20121203
5	CO_SESSION_MODE_STATELESS	Constant	Public	☐	Type reference (TYPE)	I	1	Session Mode	20121203
6	CO_STATE_CONNECTED	Constant	Public	☐	Type reference (TYPE)	I	2	State of Web Socket	20121203
7	CO_STATE_CONNECTING	Constant	Public	☐	Type reference (TYPE)	I	1	State of Web Socket	20121203
8	CO_STATE_DELETING	Constant	Public	☐	Type reference (TYPE)	I	3	State of Web Socket	20121203
9	CO_STATE_FREE	Constant	Public	☐	Type reference (TYPE)	I	0	State of Web Socket	20121203
10	IS_THIS_SERVER	Instance attribute	Private	☐	Type reference (TYPE)	SSI_BOOL	'1'	Boolean Value	20121206
11	SERVER_NAME	Instance attribute	Public	☑	Type reference (TYPE)	SSI_SERVERNAME		Name of Application Server	20121206

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20121206
2	FORCE_CLOSE	Instance method	Public	Method	Force Close and Delete WebSocket	20130606
3	READ_TABLE	Instance method	Public	Method	Read Web Socket Table	20121203
4	SWITCH_TRACE	Instance method	Public	Method	Activate/Deactivate Web Socket User Trace	20130417
5	_FORCE_CLOSE	Instance method	Private	Method	Force Close and Delete WebSocket	20130606
6	_READ_TABLE	Instance method	Private	Method	Read Web Socket Table from Kernel	20121203
7	_SWITCH_TRACE	Instance method	Private	Method	Activate/Deactivate Web Socket User Trace	20130416

Events

Class CL_SSI_WEBSOCKET has no event.

Types

Class CL_SSI_WEBSOCKET has no local type.

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	SERVER_NAME	Call by reference	☑	Type reference (TYPE)	SSI_SERVERNAME		Name des Applikations-Servers	20121206

Method CONSTRUCTOR on class CL_SSI_WEBSOCKET has no exception.

Method FORCE_CLOSE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	WEBSOCKET_HANDLE	Call by reference	☐	Type reference (TYPE)	SSI_WEBSOCKET_HANDLE		WebSocket handle	20130606

#	Exception	Resumable	Description	Created on
1	CX_SSI_BAD_PARAMETER	☐	Bad Parameter	20130606
2	CX_SSI_INTERNAL	☐	Internal error of the ssi package	20130606
3	CX_SSI_NOT_FOUND	☐	WebSocket not found (stale handle?)	20130606
4	CX_SSI_NO_AUTH	☐	no authority for this action	20130606

Method READ_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	TABLE	Value transfer	☐	Type reference (TYPE)	SSI_WEBSOCKET_TABLE		Liste aller registierten Empfänger	20121203

#	Exception	Resumable	Description	Created on
1	CX_SSI_INTERNAL	☐	Internal error of the ssi package	20121203
2	CX_SSI_NO_AUTH	☐	no authority for this action	20130716

Method SWITCH_TRACE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LEVEL	Call by reference	☐	Type reference (TYPE)	I		Trace level	20130417
2	Importing	WEBSOCKET_HANDLE	Call by reference	☐	Type reference (TYPE)	SSI_WEBSOCKET_HANDLE		WebSocket handle	20130417

#	Exception	Resumable	Description	Created on
1	CX_SSI_BAD_PARAMETER	☐	Bad Parameter	20130417
2	CX_SSI_INTERNAL	☐	Internal error of the ssi package	20130417
3	CX_SSI_NOT_FOUND	☐	WebSocket not found (stale handle?)	20130418
4	CX_SSI_NO_AUTH	☐	no authority for this action	20130417

Method _FORCE_CLOSE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	RETURN_CODE	Call by reference	☐	Type reference (TYPE)	I		Return Code from kernel	20130606
2	Importing	WEBSOCKET_HANDLE	Call by reference	☐	Type reference (TYPE)	SSI_WEBSOCKET_HANDLE		WebSocket handle	20130606

#	Exception	Resumable	Description	Created on
1	CX_SSI_INTERNAL	☐	Internal error of the ssi package	20130606

Method _READ_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	RETURN_CODE	Call by reference	☐	Type reference (TYPE)	I		Return Code from kernel	20121203
2	Exporting	TABLE	Call by reference	☐	Type reference (TYPE)	SSI_WEBSOCKET_TABLE		Liste aller registierten Empfänger	20121203

#	Exception	Resumable	Description	Created on
1	CX_SSI_INTERNAL	☐	Internal error of the ssi package	20121203

Method _SWITCH_TRACE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LEVEL	Call by reference	☐	Type reference (TYPE)	I		Trace level	20130416
2	Exporting	RETURN_CODE	Call by reference	☐	Type reference (TYPE)	I		Return Code from kernel	20130416
3	Importing	WEBSOCKET_HANDLE	Call by reference	☐	Type reference (TYPE)	SSI_WEBSOCKET_HANDLE		WebSocket handle	20130416

#	Exception	Resumable	Description	Created on
1	CX_SSI_INTERNAL	☐	Internal error of the ssi package	20130416

History

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