Class: OpenC3::Stream

Inherits:
Object show all
Defined in:
lib/openc3/streams/stream.rb

Overview

Class that implements the following methods: read, write(data), connect, connected? and disconnect. Streams are simply data sources which Protocol classes read and write to. This separation of concerns allows Streams to simply focus on getting and sending raw data while the higher level processing occurs in Protocol.

Direct Known Subclasses

MqttStream, SerialStream, TcpipSocketStream

Instance Method Summary collapse

Instance Method Details

#connect ⇒ Object

Connects the stream



26
27
28
 
# File 'lib/openc3/streams/stream.rb', line 26

def connect
  raise "connect not defined by Stream"
end

#connected? ⇒ Boolean

Returns true if connected or false otherwise.

Returns:

  • (Boolean) —

    true if connected or false otherwise



31
32
33
 
# File 'lib/openc3/streams/stream.rb', line 31

def connected?
  raise "connected? not defined by Stream"
end

#disconnect ⇒ Object

Disconnects the stream Note that streams are not designed to be reconnected and must be recreated



37
38
39
 
# File 'lib/openc3/streams/stream.rb', line 37

def disconnect
  raise "disconnect not defined by Stream"
end

#read ⇒ Object

Expected to return any amount of data on success, or a blank string on closed/EOF, and may raise Timeout::Error, or other errors



43
44
45
 
# File 'lib/openc3/streams/stream.rb', line 43

def read
  raise "read not defined by Stream"
end

#read_nonblock ⇒ Object

Expected to always return immediately with data if available or an empty string. Should not raise errors



49
50
51
 
# File 'lib/openc3/streams/stream.rb', line 49

def read_nonblock
  raise "read_nonblock not defined by Stream"
end

#write(data) ⇒ Object

Expected to write complete set of data. May raise Timeout::Error or other errors.

Parameters:

  • data (String) —

    Binary data to write to the stream



57
58
59
 
# File 'lib/openc3/streams/stream.rb', line 57

def write(data)
  raise "write not defined by Stream"
end