Class: OpenC3::SystemEventsWebSocketApi

Inherits:

CmdTlmWebSocketApi

• Object
• WebSocketApi
• CmdTlmWebSocketApi
• OpenC3::SystemEventsWebSocketApi

Defined in:

lib/openc3/script/web_socket_api.rb

Overview

System Events WebSocket

Constant Summary

Constants inherited from WebSocketApi

WebSocketApi::USER_AGENT

Instance Method Summary

• #initialize(history_count: 0, url: nil, write_timeout: 10.0, read_timeout: 10.0, connect_timeout: 5.0, authentication: nil, scope: $openc3_scope) ⇒ SystemEventsWebSocketApi constructor

  A new instance of SystemEventsWebSocketApi.

Methods inherited from CmdTlmWebSocketApi

#generate_url

Methods inherited from WebSocketApi

#connect, #connected?, #disconnect, #generate_auth, #read, #read_message, #subscribe, #unsubscribe, #write, #write_action

Constructor Details

#initialize(history_count: 0, url: nil, write_timeout: 10.0, read_timeout: 10.0, connect_timeout: 5.0, authentication: nil, scope: $openc3_scope) ⇒ SystemEventsWebSocketApi

Returns a new instance of SystemEventsWebSocketApi.

# File 'lib/openc3/script/web_socket_api.rb', line 289

def initialize(history_count: 0, url: nil, write_timeout: 10.0, read_timeout: 10.0, connect_timeout: 5.0, authentication: nil, scope: $openc3_scope)
  @identifier = {
    channel: "SystemEventsChannel",
    history_count: history_count
  }
  super(url: url, write_timeout: write_timeout, read_timeout: read_timeout, connect_timeout: connect_timeout, authentication: authentication, scope: scope)
end