/AWS1/CL_KNV=>GETSIGNALINGCHANNELENDPOINT()

About GetSignalingChannelEndpoint

Provides an endpoint for the specified signaling channel to send and receive messages. This API uses the SingleMasterChannelEndpointConfiguration input parameter, which consists of the Protocols and Role properties.

Protocols is used to determine the communication mechanism. For example, if you specify WSS as the protocol, this API produces a secure websocket endpoint. If you specify HTTPS as the protocol, this API generates an HTTPS endpoint.

Role determines the messaging permissions. A MASTER role results in this API generating an endpoint that a client can use to communicate with any of the viewers on the channel. A VIEWER role results in this API generating an endpoint that a client can use to communicate only with a MASTER.

Method Signature

IMPORTING

Required arguments:

iv_channelarn TYPE /AWS1/KNVRESOURCEARN /AWS1/KNVRESOURCEARN

The Amazon Resource Name (ARN) of the signalling channel for which you want to get an endpoint.

Optional arguments:

io_singlemasterchannelendp00 TYPE REF TO /AWS1/CL_KNVSINGLEMASTERCHAN00 /AWS1/CL_KNVSINGLEMASTERCHAN00

A structure containing the endpoint configuration for the SINGLE_MASTER channel type.

RETURNING

oo_output TYPE REF TO /aws1/cl_knvgetsignalingchan01 /AWS1/CL_KNVGETSIGNALINGCHAN01

Domain	/AWS1/RT_ACCOUNT_ID
Primitive Type	NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->/aws1/if_knv~getsignalingchannelendpoint(
  io_singlemasterchannelendp00 = new /aws1/cl_knvsinglemasterchan00(
    it_protocols = VALUE /aws1/cl_knvlistofprotocols_w=>tt_listofprotocols(
      ( new /aws1/cl_knvlistofprotocols_w( |string| ) )
    )
    iv_role = |string|
  )
  iv_channelarn = |string|
).

This is an example of reading all possible response values

LOOP AT lo_result->get_resourceendpointlist( ) into lo_row.
  lv_channelprotocol = lo_row_1->get_protocol( ).
  lv_resourceendpoint = lo_row_1->get_resourceendpoint( ).
ENDLOOP.