SAP ABAP Class CL_SAM_CLIENT_QUEUE_RECEIVER (Client Queue Receiver)

Hierarchy

☛ WEBCUIF (Software Component) SAP Web UI Framework
   ⤷ CA-GTF-IC-FRW-MES (Application Component) Messaging
     ⤷ CRM_SAM_BSP_SESSION (Package) SAM BSP Session Messaging

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_SAM_SHARED_QUEUE_RECEIVER	Session Queue Receiver	20031210
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SAM_MESSAGE_LISTENER	Message Listener	20031205
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SAM_SESSION_PROPERTIES	Properties	20031205

Properties

Class	CL_SAM_CLIENT_QUEUE_RECEIVER
Short Description	Client Queue Receiver
Super Class	CL_SAM_SHARED_QUEUE_RECEIVER	Session Queue Receiver
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	CRM_SAM_BSP_SESSION	SAM BSP Session Messaging
Created	20031205	SAP
Last change	20100303	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	T	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_SAM_MESSAGE_LISTENER	☐	☐	Message Listener	20031205
2	IF_SAM_SESSION_PROPERTIES	☐	☐	Properties	20031205

Friends

#	Friend	Modeled only	Created on	Description
1	IF_SAM_QUEUE_ACCESSOR	☐	20031205	Helper Interface

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_ICM_CACHE_POLL_PAGE_NAME	Constant	Protected	☐	Type reference (TYPE)	STRING	'notify.htm'	Name of Polling Page	20090111
2	C_ICM_CACHE_POLL_URL_PREFIX	Constant	Protected	☐	Type reference (TYPE)	STRING	'/sap/webcuif/notify/polling'		20090111
3	S_CLIENT_NOTIFICATION_KEY	Static Attribute	Protected	☐	Type reference (TYPE)	STRING			20031212
4	S_CLIENT_NOTIFICATION_URL	Static Attribute	Protected	☐	Type reference (TYPE)	STRING		Client Notification URL	20090109
5	S_NOTIFIER	Static Attribute	Protected	☐	Object reference (TYPE REF TO)	CL_CRM_ICF_NOTIFY_POLLING		Client Notification	20031205
6	S_QUEUE_RECEIVER	Static Attribute	Protected	☐	Object reference (TYPE REF TO)	CL_SAM_QUEUE_RECEIVER			20031210

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor		20031205
2	GENERATE_POLLING_URL	Static method	Public	Method	creates the polling url page	20090109
3	GET_CLIENT_NOTIFICATION_KEY	Static method	Public	Method	returns notification key for this session	20031212
4	GET_POLLING_URL	Static method	Public	Method	Get the polling URL Page	20090109
5	ON_MESSAGE	Instance method	Public	Method		20031205

Events

Class CL_SAM_CLIENT_QUEUE_RECEIVER has no event.

Types

Class CL_SAM_CLIENT_QUEUE_RECEIVER 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	KEY	Call by reference	☑	Type reference (TYPE)	STRING		Notification Key	20031205

Method CONSTRUCTOR on class CL_SAM_CLIENT_QUEUE_RECEIVER has no exception.

Method GENERATE_POLLING_URL Signature

Method GENERATE_POLLING_URL on class CL_SAM_CLIENT_QUEUE_RECEIVER has no parameter.
Method GENERATE_POLLING_URL on class CL_SAM_CLIENT_QUEUE_RECEIVER has no exception.

Method GET_CLIENT_NOTIFICATION_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	KEY	Value transfer	☐	Type reference (TYPE)	STRING			20031212

Method GET_CLIENT_NOTIFICATION_KEY on class CL_SAM_CLIENT_QUEUE_RECEIVER has no exception.

Method GET_POLLING_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_URL	Value transfer	☐	Type reference (TYPE)	STRING		Polling URL	20090109

Method GET_POLLING_URL on class CL_SAM_CLIENT_QUEUE_RECEIVER has no exception.

Method ON_MESSAGE Signature

Method ON_MESSAGE on class CL_SAM_CLIENT_QUEUE_RECEIVER has no parameter.
Method ON_MESSAGE on class CL_SAM_CLIENT_QUEUE_RECEIVER has no exception.

History

Last changed by/on	SAP	20100303
SAP Release Created in	400