packet_io 0.4.0.rc3 → 0.4.0.rc4

data/{README.rdoc → README.markdown}

@@ -1,26 +1,55 @@
-serial_interface
+# packet_io
+
     by Levin Alexander
     http://levinalex.net/
 
-== DESCRIPTION:
+## DESCRIPTION:
 
-serial_interface intends to be a small library that makes it easy
+packet_io is a small library that makes it easy
 to define packet based protocols over a serial link (RS232) in a
 declarative fashion.
 
-== SYNOPSIS:
+## SYNOPSIS:
+
+    require 'packet_io'
+
+    # define your protocol handler, inheriting from PacketIO::Base
+    #
+    # override `read` and `write` to implement your functionality
+    #
+    # this is a simple protocol handler that does nothing.
+    #
+    # see {PacketIO::LineBasedProtocol} for another trivial example
+    #
+    class MyNOPProtocol < PacketIO::Base
+      def receive(packet)
+        forward(packet)
+      end
+
+      def write(data)
+        super(packet)
+      end
+    end
+
+    # use your protocol. It is possible to stack multiple protocol
+    # layers on top of each other
+    #
+    stream = PacketIO.IOListener(File.open("/dev/ttyUSB0"))
+    line_based = PacketIO::LineBasedProtocol.new(stream)
+    my_protocol = MyNOPProtocol.new(line_based)
+
 
-  nothing written yet
+    stream.run!
 
-== INSTALL:
+## INSTALL:
 
-* not yet written
+    gem install packet_io
 
-== LICENSE:
+## LICENSE:
 
 (The MIT License)
 
-Copyright (c) 2006-2008 Levin Alexander
+Copyright (c) 2006-2011 Levin Alexander
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/packet_io/test/mock_server.rb

@@ -1,4 +1,7 @@
 module PacketIO::Test
+
+  # a threaded reader that simulates a remote server to help testing io_listener
+  #
   class MockServer
 
     # create a new server and wire it up with a bidirectional pipe
@@ -13,14 +16,15 @@ module PacketIO::Test
 
     def initialize(read, write)
       @read, @write = read, write
-      @queue = Queue.new
-      @thread = Thread.new do
+      @write_queue = Queue.new
+
+      @writer = Thread.new do
         parse_commands
       end
     end
 
     def write(string)
-      @queue.push [:write, string]
+      @write_queue.push [:write, string]
       self
     end
 
@@ -29,12 +33,12 @@ module PacketIO::Test
     end
 
     def wait(seconds = 0.02)
-      @queue.push [:wait, seconds]
+      @write_queue.push [:wait, seconds]
       self
     end
 
     def eof
-      @queue.push [:close]
+      @write_queue.push [:close]
     end
 
 
@@ -42,7 +46,7 @@ module PacketIO::Test
 
     def parse_commands
       loop do
-        action, data = @queue.pop
+        action, data = @write_queue.pop
 
         case action
         when :close

data/lib/packet_io.rb

@@ -1,6 +1,6 @@
 
 module PacketIO
-  VERSION = '0.4.0.rc3'
+  VERSION = '0.4.0.rc4'
 end
 
 require 'strscan'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: packet_io
 version: !ruby/object:Gem::Version 
-  hash: 977940588
+  hash: 977940589
   prerelease: true
   segments: 
   - 0
   - 4
   - 0
-  - rc3
-  version: 0.4.0.rc3
+  - rc4
+  version: 0.4.0.rc4
 platform: ruby
 authors: 
 - Levin Alexander
@@ -96,7 +96,7 @@ files:
 - .gitignore
 - History.txt
 - LICENSE
-- README.rdoc
+- README.markdown
 - Rakefile
 - lib/packet_io.rb
 - lib/packet_io/io_listener.rb