Class: OpenC3::Stream
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
Instance Method Summary collapse
-
#connect ⇒ Object
Connects the stream.
-
#connected? ⇒ Boolean
True if connected or false otherwise.
-
#disconnect ⇒ Object
Disconnects the stream Note that streams are not designed to be reconnected and must be recreated.
-
#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.
-
#read_nonblock ⇒ Object
Expected to always return immediately with data if available or an empty string.
-
#write(data) ⇒ Object
Expected to write complete set of data.
Instance Method Details
#connect ⇒ Object
Connects the stream
51 52 53 |
# File 'lib/openc3/streams/stream.rb', line 51 def connect raise "connect not defined by Stream" end |
#connected? ⇒ Boolean
Returns true if connected or false otherwise.
56 57 58 |
# File 'lib/openc3/streams/stream.rb', line 56 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
62 63 64 |
# File 'lib/openc3/streams/stream.rb', line 62 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
32 33 34 |
# File 'lib/openc3/streams/stream.rb', line 32 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
38 39 40 |
# File 'lib/openc3/streams/stream.rb', line 38 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.
46 47 48 |
# File 'lib/openc3/streams/stream.rb', line 46 def write(data) raise "write not defined by Stream" end |