Class: OpenC3::HttpServerInterface
- Defined in:
- lib/openc3/interfaces/http_server_interface.rb
Constant Summary
Constants included from Api
Api::DELAY_METRICS, Api::DURATION_METRICS, Api::SUBSCRIPTION_DELIMITER, Api::SUM_METRICS
Constants included from ApiShared
ApiShared::DEFAULT_TLM_POLLING_RATE
Constants included from Extract
Extract::SCANNING_REGULAR_EXPRESSION
Instance Attribute Summary
Attributes inherited from Interface
#auto_reconnect, #bytes_read, #bytes_written, #cmd_routers, #cmd_target_names, #config_params, #connect_on_startup, #disable_disconnect, #interfaces, #name, #num_clients, #options, #packet_log_writer_pairs, #protocol_info, #read_count, #read_protocols, #read_queue_size, #read_raw_data, #read_raw_data_time, #reconnect_delay, #routers, #scheduler, #secrets, #state, #stored_packet_log_writer_pairs, #stream_log_pair, #target_names, #tlm_target_names, #write_count, #write_protocols, #write_queue_size, #written_raw_data, #written_raw_data_time
Instance Method Summary collapse
-
#connect ⇒ Object
Connects the interface to its target(s).
- #connected? ⇒ Boolean
-
#convert_data_to_packet(data, extra = nil) ⇒ Packet
Called to convert the read data into a OpenC3 Packet object.
-
#convert_packet_to_data(packet) ⇒ Object
Called to convert a packet into the data to send.
-
#disconnect ⇒ Object
Disconnects the interface from its target(s).
-
#initialize(port = 80) ⇒ HttpServerInterface
constructor
A new instance of HttpServerInterface.
-
#read_interface ⇒ Object
Reads from the socket if the read_port is defined.
-
#write_interface(data, extra = nil) ⇒ Object
Writes to the socket.
Methods inherited from Interface
#_write, #add_protocol, #as_json, #copy_to, #interface_cmd, #protocol_cmd, #read, #read_allowed?, #read_interface_base, #set_option, #start_raw_logging, #stop_raw_logging, #write, #write_allowed?, #write_interface_base, #write_raw, #write_raw_allowed?
Methods included from Api
#_build_cmd_output_string, #_cmd_implementation, #_get_item, #_limits_group, #_set_tlm_process_args, #_tlm_process_args, #_validate_tlm_type, #build_command, #cmd, #cmd_no_checks, #cmd_no_hazardous_check, #cmd_no_range_check, #cmd_raw, #cmd_raw_no_checks, #cmd_raw_no_hazardous_check, #cmd_raw_no_range_check, #config_tool_names, #connect_interface, #connect_router, #delete_config, #disable_limits, #disable_limits_group, #disconnect_interface, #disconnect_router, #enable_limits, #enable_limits_group, #get_all_command_names, #get_all_commands, #get_all_interface_info, #get_all_router_info, #get_all_settings, #get_all_target_info, #get_all_telemetry, #get_all_telemetry_names, #get_cmd_buffer, #get_cmd_cnt, #get_cmd_cnts, #get_cmd_hazardous, #get_cmd_time, #get_cmd_value, #get_command, #get_interface, #get_interface_names, #get_item, #get_limits, #get_limits_events, #get_limits_groups, #get_limits_set, #get_limits_sets, #get_metrics, #get_out_of_limits, #get_overall_limits_state, #get_overrides, #get_packet_derived_items, #get_packets, #get_parameter, #get_router, #get_router_names, #get_setting, #get_settings, #get_target, #get_target_interfaces, #get_target_names, #get_telemetry, #get_tlm_buffer, #get_tlm_cnt, #get_tlm_cnts, #get_tlm_packet, #get_tlm_values, #inject_tlm, #interface_cmd, #interface_protocol_cmd, #limits_enabled?, #list_configs, #list_settings, #load_config, #map_target_to_interface, #normalize_tlm, #offline_access_needed, #override_tlm, #router_cmd, #router_protocol_cmd, #save_config, #send_raw, #set_limits, #set_limits_set, #set_offline_access, #set_setting, #set_tlm, #start_raw_logging_interface, #start_raw_logging_router, #stash_all, #stash_delete, #stash_get, #stash_keys, #stash_set, #stop_raw_logging_interface, #stop_raw_logging_router, #subscribe_packets, #tlm, #tlm_formatted, #tlm_raw, #tlm_variable, #tlm_with_units
Constructor Details
#initialize(port = 80) ⇒ HttpServerInterface
Returns a new instance of HttpServerInterface.
27 28 29 30 31 32 |
# File 'lib/openc3/interfaces/http_server_interface.rb', line 27 def initialize(port = 80) super() @port = Integer(port) @server = nil @request_queue = Queue.new end |
Instance Method Details
#connect ⇒ Object
Connects the interface to its target(s)
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 |
# File 'lib/openc3/interfaces/http_server_interface.rb', line 35 def connect @server = WEBrick::HTTPServer.new :Port => @port @request_queue = Queue.new # Create a response hook for every command packet @target_names.each do |target_name| System.commands.packets(target_name).each do |packet_name, packet| packet.restore_defaults path = nil begin path = packet.read('HTTP_PATH') rescue => err # No HTTP_PATH is an error Logger.error("HttpServerInterface Packet #{target_name} #{packet_name} unable to read HTTP_PATH\n#{err.formatted}") end if path @server.mount_proc path do |req, res| # Build the Response begin status = packet.read('HTTP_STATUS') if status res.status = status end rescue # No HTTP_STATUS - Leave at default end if packet.extra headers = packet.extra['HTTP_HEADERS'] if headers headers.each do |key, value| res[key] = value end end end res.body = packet.buffer # Save the Request packet_name = nil begin packet_name = packet.read('HTTP_PACKET') rescue # No packet name means dont save the request as telemetry end if packet_name data = req.body.to_s.dup # Dup to remove frozen extra = {} extra['HTTP_REQUEST_TARGET_NAME'] = target_name extra['HTTP_REQUEST_PACKET_NAME'] = packet_name headers = req.header if headers extra['HTTP_HEADERS'] = {} headers.each do |key, value| extra['HTTP_HEADERS'][key.downcase] = value end end queries = req.query if queries extra['HTTP_QUERIES'] = {} queries.each do |key, value| extra['HTTP_QUERIES'][key] = value end end @request_queue << [data, extra] end end end end end super() Thread.new do # This blocks, but will be unblocked by server.shutdown called in disconnect() @server.start end end |
#connected? ⇒ Boolean
117 118 119 120 121 122 123 |
# File 'lib/openc3/interfaces/http_server_interface.rb', line 117 def connected? if @server return true else return false end end |
#convert_data_to_packet(data, extra = nil) ⇒ Packet
Called to convert the read data into a OpenC3 Packet object
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 |
# File 'lib/openc3/interfaces/http_server_interface.rb', line 156 def convert_data_to_packet(data, extra = nil) packet = Packet.new(nil, nil, :BIG_ENDIAN, nil, data.to_s) packet.accessor = HttpAccessor.new(packet) if extra # Identify the response request_target_name = extra['HTTP_REQUEST_TARGET_NAME'] request_packet_name = extra['HTTP_REQUEST_PACKET_NAME'] if request_target_name and request_packet_name packet.target_name = request_target_name.to_s.upcase packet.packet_name = request_packet_name.to_s.upcase end extra.delete("HTTP_REQUEST_TARGET_NAME") extra.delete("HTTP_REQUEST_PACKET_NAME") packet.extra = extra end return packet end |
#convert_packet_to_data(packet) ⇒ Object
Called to convert a packet into the data to send
179 180 181 |
# File 'lib/openc3/interfaces/http_server_interface.rb', line 179 def convert_packet_to_data(packet) raise "Commands cannot be sent to HttpServerInterface" end |
#disconnect ⇒ Object
Disconnects the interface from its target(s)
126 127 128 129 130 131 132 133 134 |
# File 'lib/openc3/interfaces/http_server_interface.rb', line 126 def disconnect @server.shutdown if @server @server = nil while @request_queue.length > 0 @request_queue.pop end super() @request_queue.push(nil) end |
#read_interface ⇒ Object
Reads from the socket if the read_port is defined
137 138 139 140 141 142 143 144 |
# File 'lib/openc3/interfaces/http_server_interface.rb', line 137 def read_interface # Get the Faraday Response data, extra = @request_queue.pop return nil if data.nil? read_interface_base(data, extra) return data, extra end |
#write_interface(data, extra = nil) ⇒ Object
Writes to the socket
148 149 150 |
# File 'lib/openc3/interfaces/http_server_interface.rb', line 148 def write_interface(data, extra = nil) raise "Commands cannot be sent to HttpServerInterface" end |