stream.rb in cosmos-3.1.0

- old
+ new
@@ -1,57 +1,57 @@
-# encoding: ascii-8bit
-
-# Copyright 2014 Ball Aerospace & Technologies Corp.
-# All Rights Reserved.
-#
-# This program is free software; you can modify and/or redistribute it
-# under the terms of the GNU General Public License
-# as published by the Free Software Foundation; version 3 with
-# attribution addendums as found in the LICENSE.txt
-
-require 'timeout' # For Timeout::Error
-
-module Cosmos
-
-  # Interface that implments the following methods: read, write(data),
-  # connected? and disconnect. Streams are simply data sources which
-  # {StreamProtocol} 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 {StreamProtocol}.
-  class Stream
-
-    # @return [RawLoggerPair] Raw logger pair associated with this stream
-    attr_accessor :raw_logger_pair
-
-    # Expected to return any amount of data on success, or a blank string on
-    # closed/EOF, and may raise Timeout::Error, or other errors
-    def read
-      raise "read not defined by Stream"
-    end
-
-    # Expected to always return immediately with data if available or an empty string.
-    # Should not raise errors
-    def read_nonblock
-      raise "read_nonblock not defined by Stream"
-    end
-
-    # Expected to write complete set of data.  May raise Timeout::Error
-    # or other errors.
-    #
-    # @param data [String] Binary data to write to the stream
-    def write(data)
-      raise "write not defined by Stream"
-    end
-
-    # @return [Boolean] true if connected or false otherwise
-    def connected?
-      raise "connected? not defined by Stream"
-    end
-
-    # Disconnects the stream
-    def disconnect
-      raise "disconnect not defined by Stream"
-    end
-
-  end # class Stream
-
-end # module Cosmos
+# encoding: ascii-8bit
+
+# Copyright 2014 Ball Aerospace & Technologies Corp.
+# All Rights Reserved.
+#
+# This program is free software; you can modify and/or redistribute it
+# under the terms of the GNU General Public License
+# as published by the Free Software Foundation; version 3 with
+# attribution addendums as found in the LICENSE.txt
+
+require 'timeout' # For Timeout::Error
+
+module Cosmos
+
+  # Interface that implments the following methods: read, write(data),
+  # connected? and disconnect. Streams are simply data sources which
+  # {StreamProtocol} 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 {StreamProtocol}.
+  class Stream
+
+    # @return [RawLoggerPair] Raw logger pair associated with this stream
+    attr_accessor :raw_logger_pair
+
+    # Expected to return any amount of data on success, or a blank string on
+    # closed/EOF, and may raise Timeout::Error, or other errors
+    def read
+      raise "read not defined by Stream"
+    end
+
+    # Expected to always return immediately with data if available or an empty string.
+    # Should not raise errors
+    def read_nonblock
+      raise "read_nonblock not defined by Stream"
+    end
+
+    # Expected to write complete set of data.  May raise Timeout::Error
+    # or other errors.
+    #
+    # @param data [String] Binary data to write to the stream
+    def write(data)
+      raise "write not defined by Stream"
+    end
+
+    # @return [Boolean] true if connected or false otherwise
+    def connected?
+      raise "connected? not defined by Stream"
+    end
+
+    # Disconnects the stream
+    def disconnect
+      raise "disconnect not defined by Stream"
+    end
+
+  end # class Stream
+
+end # module Cosmos