SAP ABAP Class CL_APC_KRN_SERVICES (ABAP Push Channel (APC) kernel methods)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-MID-AC (Application Component) ABAP Channels
     ⤷ SAPC_TOOLS (Package) APC troubleshooting tools, e.g. logging, tracing, etc.

Properties

Class	CL_APC_KRN_SERVICES
Short Description	ABAP Push Channel (APC) kernel methods
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status	S	System Program
Category	0
Package	SAPC_TOOLS	APC troubleshooting tools, e.g. logging, tracing, etc.
Created	20121030	SAP
Last change	20140121	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_APC_KRN_SERVICES has no forward declaration.

Interfaces

Class CL_APC_KRN_SERVICES has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_APC_MANAGER	☐	20121116	ABAP Push Channel (APC) WebSocket (WS) framework manager
2	CL_APC_UNIT_TEST_PING	☐	20130628	Generated Testclass
3	CL_APC_WS_CLIENT	☐	20130215	APC framework: APC WebSocket client class
4	CL_APC_WS_MESSAGE_MANAGER	☐	20121121	APC framework: WebSocket message manager

Attributes

Class CL_APC_KRN_SERVICES has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	RECEIVE_MESSAGE	Static method	Protected	Method	Get message/event	20121204
2	REGISTER_CLIENT	Static method	Protected	Method	Register a web-socket client	20130220
3	SEND_BINARY_MESSAGE	Static method	Protected	Method	Send binary message	20121121
4	SEND_TEXT_MESSAGE	Static method	Protected	Method	Send text message	20121121
5	UNREGISTER_CLIENT	Static method	Protected	Method	Unregister a web-socket client	20130220
6	_ACTIVATE_TRACE	Static method	Protected	Method	Activate trace im kernel	20121121
7	_CLOSE_WS_CONNECTION	Static method	Protected	Method	Close the web socket connection	20131028
8	_DELETE_CLIENT	Static method	Protected	Method	Delete the web socket / APC client	20131028
9	_DELETE_ERROR_TEMPLATE	Static method	Protected	Method	Delete the error template registered bevore	20130111
10	_FINALIZE	Static method	Protected	Method	End the APC session	20121121
11	_GET_APPLICATION_DATA	Static method	Protected	Method		20121130
12	_GET_CLIENT_STATISTIC_INFO	Static method	Private	Method	Get information of client statistic	20130627
13	_GET_KERNEL_INFO	Static method	Protected	Method	Get informations from kernel	20121121
14	_GET_SERVER_STATISTIC_INFO	Static method	Protected	Method	Get information of server statistic	20130628
15	_GET_TRACE_LEVEL	Static method	Protected	Method	Get the trace level	20121030
16	_SET_APC_EXITLIST	Static method	Protected	Method		20121126
17	_SET_APPLICATION_DATA	Static method	Protected	Method		20121127
18	_SET_ERROR_TEMPLATE	Static method	Protected	Method	Set the template to be sent in case of error	20121123
19	_SET_INFO_FOR_CLIENT_STATISTIC	Static method	Protected	Method	Set informations for statistics	20130612
20	_SET_INFO_FOR_SERVER_STATISTIC	Static method	Protected	Method	Set information for statistics in the server site	20130618
21	_SET_TRACE_PATH	Static method	Protected	Method	Set the trace path for kernel	20121112
22	_WRITE_TRACE	Static method	Protected	Method	Write the identifier and the trace string	20121030

Events

Class CL_APC_KRN_SERVICES has no event.

Types

Class CL_APC_KRN_SERVICES has no local type.

Method Signatures

Method RECEIVE_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_BINARY_MESSAGE	Call by reference	☐	Type reference (TYPE)	XSTRING			20121204
2	Exporting	E_CLIENT_ID	Call by reference	☐	Type reference (TYPE)	CHAR32		ID of the client	20130301
3	Exporting	E_CLOSE_CODE	Call by reference	☐	Type reference (TYPE)	I		Close code	20130719
4	Exporting	E_CLOSE_REASON	Call by reference	☐	Type reference (TYPE)	STRING		Close reason	20130711
5	Exporting	E_EVENT_TEXT	Call by reference	☐	Type reference (TYPE)	STRING			20121206
6	Exporting	E_EVENT_TYPE	Call by reference	☐	Type reference (TYPE)	I			20121204
7	Exporting	E_TEXT_MESSAGE	Call by reference	☐	Type reference (TYPE)	STRING			20121204
8	Importing	I_IS_CLIENT	Call by reference	☑	Type reference (TYPE)	C			20130301

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

Method REGISTER_CLIENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CLIENT_ID	Value transfer	☐	Type reference (TYPE)	CHAR32		Character field, length 32	20130220
2	Returning	RC	Value transfer	☐	Type reference (TYPE)	I		Error code	20130220

Method REGISTER_CLIENT on class CL_APC_KRN_SERVICES has no exception.

Method SEND_BINARY_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CLIENT_ID	Call by reference	☑	Type reference (TYPE)	CHAR32		Character field, length 32	20130221
2	Importing	I_MESSAGE	Call by reference	☐	Type reference (TYPE)	XSTRING			20121121

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

Method SEND_TEXT_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CLIENT_ID	Call by reference	☑	Type reference (TYPE)	CHAR32		Character field, length 32	20130221
2	Importing	I_MESSAGE	Call by reference	☐	Type reference (TYPE)	STRING			20121121

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

Method UNREGISTER_CLIENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CLIENT_ID	Value transfer	☐	Type reference (TYPE)	CHAR32		Character field, length 32	20130220
2	Importing	I_CLOSE_REASON	Call by reference	☑	Type reference (TYPE)	STRING		Close reason	20130710
3	Importing	I_CLOSE_STATUS_CODE	Value transfer	☑	Type reference (TYPE)	I		Close status code	20130710
4	Returning	RC	Value transfer	☐	Type reference (TYPE)	I		Error code	20130220

Method UNREGISTER_CLIENT on class CL_APC_KRN_SERVICES has no exception.

Method _ACTIVATE_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	20121121
2	Exporting	RC	Value transfer	☐	Type reference (TYPE)	I		Error code	20121121

Method _ACTIVATE_TRACE on class CL_APC_KRN_SERVICES has no exception.

Method _CLOSE_WS_CONNECTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CLIENT_ID	Value transfer	☐	Type reference (TYPE)	CHAR32		ID of client closing the connection	20131028
2	Importing	I_CLOSE_REASON	Value transfer	☐	Type reference (TYPE)	STRING		Close Reason	20131028
3	Importing	I_CLOSE_STATUS_CODE	Value transfer	☐	Type reference (TYPE)	I		Close status code	20131028
4	Returning	RC	Value transfer	☐	Type reference (TYPE)	I		Error code	20131028

Method _CLOSE_WS_CONNECTION on class CL_APC_KRN_SERVICES has no exception.

Method _DELETE_CLIENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CLIENT_ID	Value transfer	☐	Type reference (TYPE)	CHAR32		ID of client closing the connection	20131028
2	Returning	RC	Value transfer	☐	Type reference (TYPE)	I		Error code	20131028

Method _DELETE_CLIENT on class CL_APC_KRN_SERVICES has no exception.

Method _DELETE_ERROR_TEMPLATE Signature

Method _DELETE_ERROR_TEMPLATE on class CL_APC_KRN_SERVICES has no parameter.
Method _DELETE_ERROR_TEMPLATE on class CL_APC_KRN_SERVICES has no exception.

Method _FINALIZE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FORCE_DELETE_SESSION	Call by reference	☐	Type reference (TYPE)	C			20121127
2	Returning	RC	Value transfer	☐	Type reference (TYPE)	I		Error code	20121121

Method _FINALIZE on class CL_APC_KRN_SERVICES has no exception.

Method _GET_APPLICATION_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	APP_DATA_1	Call by reference	☐	Type reference (TYPE)	XSTRING			20121130
2	Exporting	APP_DATA_2	Call by reference	☐	Type reference (TYPE)	STRING			20121130
3	Returning	RC	Value transfer	☐	Type reference (TYPE)	I		Error code	20121130

Method _GET_APPLICATION_DATA on class CL_APC_KRN_SERVICES has no exception.

Method _GET_CLIENT_STATISTIC_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	CLIENT_DEST_STAT_INFO	Call by reference	☐	Type reference (TYPE)	PFAPC_CLIENT_DEST_STATISTIC		APC client destination statistics record (composite record)	20130627
2	Exporting	CLIENT_STAT_INFO	Call by reference	☐	Type reference (TYPE)	PFAPC_CLIENT_STATISTIC		APC Client Statistics Record (Single Record)	20130627
3	Returning	RC	Value transfer	☐	Type reference (TYPE)	I		Error code	20130627

Method _GET_CLIENT_STATISTIC_INFO on class CL_APC_KRN_SERVICES has no exception.

Method _GET_KERNEL_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_ACCEPT_REMOTE_PROFILE_LEVEL	Call by reference	☐	Type reference (TYPE)	I		If remote profile is accepted	20121121
2	Exporting	E_ACCEPT_REMOTE_RECORDER_LEVEL	Call by reference	☐	Type reference (TYPE)	I		If remote recorder is accepted	20121203
3	Exporting	E_ACCEPT_REMOTE_TRACE_LEVEL	Call by reference	☐	Type reference (TYPE)	I		If remote trace is accepted	20121121
4	Exporting	E_APC_KERNEL_VERSION	Call by reference	☐	Type reference (TYPE)	I		Version of APC kernel	20121121
5	Exporting	E_DEBUGGING_POSSIBLE	Call by reference	☐	Type reference (TYPE)	C		If debugging is possible	20121121
6	Exporting	E_FUNCTIONAL_TRACE_LEVEL	Call by reference	☐	Type reference (TYPE)	I		Trace level	20121121
7	Exporting	E_LOGON_SUCCESSFUL	Call by reference	☐	Type reference (TYPE)	C		If user logged on successfully	20121121

Method _GET_KERNEL_INFO on class CL_APC_KRN_SERVICES has no exception.

Method _GET_SERVER_STATISTIC_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RC	Value transfer	☐	Type reference (TYPE)	I		Error code	20130628
2	Exporting	SERVER_DEST_STAT_INFO	Call by reference	☐	Type reference (TYPE)	PFAPC_SERVER_DEST_STATISTIC		APC client destination statistics record (composite record)	20130628
3	Exporting	SERVER_STAT_INFO	Call by reference	☐	Type reference (TYPE)	PFAPC_SERVER_STATISTIC		APC Server Statistics Record (Single Record)	20130628

Method _GET_SERVER_STATISTIC_INFO on class CL_APC_KRN_SERVICES has no exception.

Method _GET_TRACE_LEVEL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RC	Value transfer	☐	Type reference (TYPE)	I		Error code	20121030
2	Exporting	TRACELEVEL	Call by reference	☐	Type reference (TYPE)	I		Trace level	20121030

Method _GET_TRACE_LEVEL on class CL_APC_KRN_SERVICES has no exception.

Method _SET_APC_EXITLIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RC	Value transfer	☐	Type reference (TYPE)	I		Error code	20121126

Method _SET_APC_EXITLIST on class CL_APC_KRN_SERVICES has no exception.

Method _SET_APPLICATION_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	APP_DATA_1	Call by reference	☐	Type reference (TYPE)	XSTRING			20121127
2	Importing	APP_DATA_2	Call by reference	☐	Type reference (TYPE)	STRING			20121127
3	Returning	RC	Value transfer	☐	Type reference (TYPE)	I		Error code	20121127

Method _SET_APPLICATION_DATA on class CL_APC_KRN_SERVICES has no exception.

Method _SET_ERROR_TEMPLATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ERROR_TEMPLATE	Call by reference	☐	Type reference (TYPE)	STRING		Template of error	20121123
2	Returning	RC	Value transfer	☐	Type reference (TYPE)	I		Error Code	20121123

Method _SET_ERROR_TEMPLATE on class CL_APC_KRN_SERVICES has no exception.

Method _SET_INFO_FOR_CLIENT_STATISTIC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	APPLICATION_ID	Call by reference	☐	Type reference (TYPE)	STRING		Application ID	20130612
2	Importing	CLIENT_ID	Call by reference	☐	Type reference (TYPE)	CHAR32		Character field, length 32	20130612
3	Importing	DESTINATION	Call by reference	☐	Type reference (TYPE)	STRING		Destination	20130612
4	Importing	HOST	Call by reference	☐	Type reference (TYPE)	STRING		Host	20130612
5	Importing	PATH	Call by reference	☐	Type reference (TYPE)	STRING		Path	20130612
6	Importing	PORT	Call by reference	☐	Type reference (TYPE)	STRING		Port	20130612
7	Importing	PROTOCOL	Call by reference	☐	Type reference (TYPE)	I		Web Socket Protocol	20130612
8	Returning	RC	Value transfer	☐	Type reference (TYPE)	I		Error code	20130612

Method _SET_INFO_FOR_CLIENT_STATISTIC on class CL_APC_KRN_SERVICES has no exception.

Method _SET_INFO_FOR_SERVER_STATISTIC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EXEC_TIME	Call by reference	☐	Type reference (TYPE)	F		Execution time of application	20130618
2	Returning	RC	Value transfer	☐	Type reference (TYPE)	I		Error code	20130618

Method _SET_INFO_FOR_SERVER_STATISTIC on class CL_APC_KRN_SERVICES has no exception.

Method _SET_TRACE_PATH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RC	Value transfer	☐	Type reference (TYPE)	I		Error code	20121112
2	Importing	TRACE_PATH	Call by reference	☐	Type reference (TYPE)	STRING		Trace path to set	20121112

Method _SET_TRACE_PATH on class CL_APC_KRN_SERVICES has no exception.

Method _WRITE_TRACE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IDENTIFIER	Call by reference	☐	Type reference (TYPE)	STRING		Identifier	20121030
2	Importing	TRACE_BUFFER	Call by reference	☐	Type reference (TYPE)	STRING		Buffer for the trace string	20121030

Method _WRITE_TRACE on class CL_APC_KRN_SERVICES has no exception.

History

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