Skip to content

/AWS1/CL_KNVSINGLEMASTERCHAN00

An object that contains the endpoint configuration for the SINGLE_MASTER channel type.

CONSTRUCTOR

IMPORTING

Optional arguments:

it_protocols TYPE /AWS1/CL_KNVLISTOFPROTOCOLS_W=>TT_LISTOFPROTOCOLS TT_LISTOFPROTOCOLS

This property is used to determine the nature of communication over this SINGLE_MASTER signaling channel. If WSS is specified, this API returns a websocket endpoint. If HTTPS is specified, this API returns an HTTPS endpoint.

iv_role TYPE /AWS1/KNVCHANNELROLE /AWS1/KNVCHANNELROLE

This property is used to determine messaging permissions in this SINGLE_MASTER signaling channel. If MASTER is specified, this API returns an endpoint that a client can use to receive offers from and send answers to any of the viewers on this signaling channel. If VIEWER is specified, this API returns an endpoint that a client can use only to send offers to another MASTER client on this signaling channel.

Queryable Attributes

Protocols

This property is used to determine the nature of communication over this SINGLE_MASTER signaling channel. If WSS is specified, this API returns a websocket endpoint. If HTTPS is specified, this API returns an HTTPS endpoint.

Accessible with the following methods

Method Description
GET_PROTOCOLS() Getter for PROTOCOLS, with configurable default
ASK_PROTOCOLS() Getter for PROTOCOLS w/ exceptions if field has no value
HAS_PROTOCOLS() Determine if PROTOCOLS has a value

Role

This property is used to determine messaging permissions in this SINGLE_MASTER signaling channel. If MASTER is specified, this API returns an endpoint that a client can use to receive offers from and send answers to any of the viewers on this signaling channel. If VIEWER is specified, this API returns an endpoint that a client can use only to send offers to another MASTER client on this signaling channel.

Accessible with the following methods

Method Description
GET_ROLE() Getter for ROLE, with configurable default
ASK_ROLE() Getter for ROLE w/ exceptions if field has no value
HAS_ROLE() Determine if ROLE has a value