SAP ABAP Class CL_SAM_SESSION_QUEUE_SENDER (Session Queue Sender)
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_QUEUE_SENDER | Queue Sender | 20031013 |
| 2 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_SAM_QUEUE_ACCESSOR | Helper Interface | 20031013 |
| 3 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_SAM_SESSION_PROPERTIES | Properties | 20031205 |
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Inheritance (c INHERITING FROM c_ref) | CL_BCB_SESSION_QUEUE_SENDER | 20040227 | |
| 2 | Inheritance (c INHERITING FROM c_ref) | CL_CRM_BM_SENDER | broadcast messaging | 20040317 |
| 3 | Inheritance (c INHERITING FROM c_ref) | CL_ICWC_SAM_WORKER_SENDER | sender to avoid deadlocks | 20040227 |
Properties
| Class | CL_SAM_SESSION_QUEUE_SENDER | |
| Short Description | Session Queue Sender | |
| Super Class | CL_SAM_QUEUE_SENDER | Queue Sender |
| 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 | 20031013 | SAP |
| Last change | 20130531 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | IF_SAM_QUEUE_ACCESSOR | Helper Interface | 20031013 | ||
| 2 | IF_SAM_SESSION_PROPERTIES | Properties | 20031205 |
Friends
| # | Friend | Modeled only | Created on | Description |
|---|---|---|---|---|
| 1 | CL_SAM_SESSION_QUEUE_CNTRLER | 20040227 | Session Queue Controller |
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Instance attribute | Protected | Object reference (TYPE REF TO) | CL_SAM_QUEUE_RECEIVER | 20031208 | ||||
| 2 | Instance attribute | Protected | Object reference (TYPE REF TO) | CL_SAM_QUEUE_RECEIVER | 20031208 | ||||
| 3 | Instance attribute | Protected | Type reference (TYPE) | I | 0 | Timeout für HTTP-Request | 20040227 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Constructor | 20031013 | ||
| 2 | Instance method | Protected | Method | deserializes a message | 20031017 | |
| 3 | Instance method | Public | Method | sends a messaget to the client | 20031205 | |
| 4 | Instance method | Protected | Method | serializes a message | 20031017 | |
| 5 | Instance method | Protected | Method | ** internal only: sends the message | 20031016 | |
| 6 | Instance method | Protected | Method | ** internal only: sends message, receives response | 20040227 | |
| 7 | Instance method | Protected | Method | ** internal only: sets timeout for sender http request | 20040227 |
Events
| # | Event | Type | Visibility | Description | Created on |
|---|---|---|---|---|---|
| 1 | NEW_SAM_MSG | Instance Event (0) |
Public (2) |
Event that a new SAM Message was written to a queue | 20131022 |
Types
Class CL_SAM_SESSION_QUEUE_SENDER has no local type.
Method Signatures
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | QUEUE | Call by reference | Type reference (TYPE) | STRING | SPACE | 20031013 | |||
| 2 | TIMEOUT | Call by reference | Type reference (TYPE) | I | 0 | 20120314 |
Method CONSTRUCTOR on class CL_SAM_SESSION_QUEUE_SENDER has no exception.
Method DESERIALIZE_MESSAGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | HTTP_ENTITY | Call by reference | Object reference (TYPE REF TO) | IF_HTTP_ENTITY | HTTP Framework (iHTTP) HTTP Entity | 20031017 | |||
| 2 | MESSAGE | Value transfer | Object reference (TYPE REF TO) | CL_SAM_MESSAGE | Message | 20031017 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Messaging Exception | 20031017 |
Method SEND_TO_CLIENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | MESSAGE | Call by reference | Object reference (TYPE REF TO) | IF_SAM_TEXT_MESSAGE | Text Message | 20031205 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Messaging Exception | 20031205 |
Method SERIALIZE_MESSAGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | HTTP_ENTITY | Call by reference | Object reference (TYPE REF TO) | IF_HTTP_ENTITY | HTTP Framework (iHTTP) HTTP Entity | 20031017 | |||
| 2 | MESSAGE | Call by reference | Object reference (TYPE REF TO) | CL_SAM_MESSAGE | Message | 20031017 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Messaging Exception | 20031017 |
Method _SEND Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ANSWER | Value transfer | Object reference (TYPE REF TO) | CL_SAM_MESSAGE | Message | 20031016 | |||
| 2 | MESSAGE | Call by reference | Object reference (TYPE REF TO) | CL_SAM_MESSAGE | Message | 20031016 | |||
| 3 | RETURN_ANSWER | Call by reference | Type reference (TYPE) | STRING | SPACE | boolsche Variable (sam_prop_true, sam_prop_false) | 20031016 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Messaging Exception | 20031016 |
Method _SEND_AND_RECEIVE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ANSWER | Value transfer | Object reference (TYPE REF TO) | IF_SAM_MESSAGE | Message | 20040227 | |||
| 2 | MESSAGE | Call by reference | Object reference (TYPE REF TO) | IF_SAM_MESSAGE | Message | 20040227 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Messaging Exception | 20040227 |
Method _SET_TIMEOUT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | VALUE | Call by reference | Type reference (TYPE) | I | 20040227 |
Method _SET_TIMEOUT on class CL_SAM_SESSION_QUEUE_SENDER has no exception.
Event Signatures
Event NEW_SAM_MSG Signature
Event NEW_SAM_MSG on class CL_SAM_SESSION_QUEUE_SENDER has no parameter.
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in |