Share via

WebSocketOptions interface

  • Reference
Package:
@azure/event-hubs

Options to configure the channelling of the AMQP connection over Web Sockets.

Properties

webSocket

The WebSocket constructor used to create an AMQP connection over a WebSocket. This option should be provided in the below scenarios:

  • The TCP port 5671 which is that is used by the AMQP connection to Event Hubs is blocked in your environment.
  • Your application needs to be run behind a proxy server.
  • Your application needs to run in the browser and you want to provide your own choice of Websocket implementation instead of the built-in WebSocket in the browser.
webSocketConstructorOptions

Options to be passed to the WebSocket constructor when the underlying rhea library instantiates the WebSocket.

Property Details

webSocket

The WebSocket constructor used to create an AMQP connection over a WebSocket. This option should be provided in the below scenarios:

  • The TCP port 5671 which is that is used by the AMQP connection to Event Hubs is blocked in your environment.
  • Your application needs to be run behind a proxy server.
  • Your application needs to run in the browser and you want to provide your own choice of Websocket implementation instead of the built-in WebSocket in the browser.
webSocket?: WebSocketImpl

Property Value

WebSocketImpl

webSocketConstructorOptions

Options to be passed to the WebSocket constructor when the underlying rhea library instantiates the WebSocket.

webSocketConstructorOptions?: any

Property Value

any