flow - Developer Guide

Flow uses SBT as build system. To get started, include a dependency to flow in your project:
libraryDependencies += "com.github.jodersky" %% "flow" % "2.4.0-M2"
+libraryDependencies += "com.github.jodersky" %% "flow" % "2.4.0"
 
 
 
@@ -109,14 +98,14 @@
 The Easy Way
 In case your OS/architecture combination is present in the “supported platforms” table in the downloads section, add a second dependency to your project:
 
-libraryDependencies += "com.github.jodersky" % "flow-native" % "2.4.0-M2" % "runtime"
+libraryDependencies += "com.github.jodersky" % "flow-native" % "2.4.0" % "runtime"
 
 
 
 This will add a jar to your classpath containing native libraries for various platforms. At run time, the correct library for the current platform is selected, extracted and loaded. This solution enables running applications seamlessly, as if they were pure JVM applications.
 
 Maximum Portability
-First, obtain a copy of the native library, either by building flow or by downloading a precompiled version. In order to work with this version of flow, native libraries need to be of major version 3 and minor version greater or equal to 0.
+First, obtain a copy of the native library, either by building flow or by downloading a precompiled version. In order to work with this version of flow, native libraries need to be of major version 3 and minor version greater or equal to 0.
 
 Second, for every end-user application that relies on flow, manually add the native library for the current platform to the JVM’s library path. This can be achieved through various ways, notably:
 
@@ -285,106 +274,6 @@ the client on new files.
 Requirements
 Flow uses Java’s WatchServices under the hood, therefore a Java runtime of a version of at least 1.7 is required.
 
-
-
-Building from Source
-A complete build of flow involves two parts
-
-
-  
-    Building Scala sources (the front-end), resulting in a platform independent artifact (i.e. a jar file).
-  
-  
-    Building C sources (the back-end), yielding a native library that may only be used on systems resembling the platform for which it was compiled.
-  
-
-
-Both steps are independent, their only interaction being a header file generated by the JDK utility javah (see sbt javah for details), and may therefore be built in any order.
-
-Building Scala Sources
-Run sbt flow-main/packageBin in the base directory. This simply compiles Scala sources as with any standard sbt project and packages the resulting class files in a jar.
-
-Building Native Sources
-The back-end is managed by GNU Autotools and all relevant files are contained in flow-native.
-
-
-  Aside: Autotools Introduction
-  Autotools is a suite of programs constituting a sort of “meta-build system”. It is used to generate a platform-independent build script known as ./configure, which, when run, will analyze the current system (search for a C compiler, required libraries etc) and produce a Makefile. The makefile in turn is system-specific and can be used to create the final binary. In summary the build process is as follows:
-
-  
-    Autotools (specifically the program autoreconf) generates ./configure, this happens on the developer’s machine
-    ./configure is run on the host computer
-    make is run to produce a binary, also on the host computer
-  
-
-  In a typical, source-controlled repository, only a bootstrapping script that calls Autotools is checked into version control. However, source releases include the generated ./configure script. An end-user then downloads a source release and only has to run ./configure && make.
-
-  However, since flow does currently not provide source releases (not to be confused with source repository or Git tags), the developer’s machine is the same as the host machine and so the bootstrapping process always needs to be performed.
-
-
-Build Process
-
-Several steps are involved in producing the native library:
-
-
-  
-    Bootstrap the build (run this once, if ./configure does not exist).
-
-    
-      Check availability of dependencies: autotools and libtool (on Debian-based systems run apt-get install build-essential autoconf automake libtool)
-      Run ./bootstrap
-    
-  
-  
-    Compile
-
-    
-      Check availability of dependencies: C compiler and JDK (1.8 or above)
-      Run ./configure && make.
-Note: should you encounter an error about a missing “jni.h” file, try setting the JAVA_HOME environment variable to point to base path of your JDK installation.
-    
-  
-  
-    Install
-
-    The native library is now ready and can be:
-
-    
-      
-        copied to a local directory: DESTDIR=$(pwd)/<directory> make install
-      
-      
-        installed system-wide: make install
-      
-      
-        put into a “fat” jar, useful for dependency management with SBT (see next section)
-      
-    
-  
-
-
-Creating a Fat Jar
-The native library produced in the previous step may be bundled into a “fat” jar so that it can be included in SBT projects through its regular dependency mechanisms. In this process, SBT basically acts as a wrapper script around Autotools, calling the native build process and packaging generated libraries. Running sbt flow-native/packageBin in the base directory produces the fat jar in flow-native/target.
-
-Note: an important feature of fat jars is to include native libraries for several platforms. To copy binaries compiled on other platforms to the fat jar, place them in a subfolder of flow-native/lib_native. The subfolder should have the name com/github/jodersky/flow/native/$(arch)-$(kernel), where arch and kernel are, respectively, the lower-case values returned by uname -m and uname -s.
-
-Note About Versioning
-The project and package versions follow a semantic pattern: M.m.p, where
-
-
-  
-    M is the major version, representing backwards incompatible changes
-  
-  
-    m is the minor version, indicating backwards compatible changes such as new feature additions
-  
-  
-    p is the patch number, representing internal modifications such as bug-fixes
-  
-
-
-Usually (following most Linux distribution’s conventions), shared libraries produced by a project name of version M.m.p are named libname.so.M.m.p. However, since when accessing shared libraries through the JVM, only the name can be specified and no particular version, the convention adopted by flow is to append M to the library name and always keep the major version at zero. E.g. libflow.so.3.1.2 becomes libflow3.so.0.1.2.
-
 

 
 
diff --git a/downloads/index.html b/downloads/index.html
index 842b440..a3e4d7b 100644
--- a/downloads/index.html
+++ b/downloads/index.html
@@ -43,7 +43,7 @@
 
 
 
-Latest Version 2.4.0-M2
+Latest Version 2.4.0
 
 
 
@@ -52,31 +52,25 @@
     Add the following tothe build configuration:
 
     //main artifact
-libraryDependencies += "com.github.jodersky" %% "flow" % "2.4.0-M2"
+libraryDependencies += "com.github.jodersky" %% "flow" % "2.4.0"
 
 //(optional) "fat" jar containing native libraries
-libraryDependencies += "com.github.jodersky" % "flow-native" % "2.4.0-M2" % "runtime"
+libraryDependencies += "com.github.jodersky" % "flow-native" % "2.4.0" % "runtime"
+
+    
+
+    Note (as of 2016-01-24 17:00 PST): a dependency (jni-library) is currently awaiting inclusion in the official jcenter repository. Until this is the case, an additional resolver will have to be added to the sbt build configuration:
+
+    resolvers += Resolver.bintrayRepo("jodersky", "maven")
 
     
 
     Archives
 
     
-      
-        Main Jar
-.jar (scala 2.11)
-.asc (signature)
-      
-      
-        Native Jar
-.jar
-.asc (signature)
-      
-      
-        Native Libraries
+      
Native Libraries
 .tar.gz
-.asc (signature)
-      
+.asc (signature)
     
 
   
@@ -109,26 +103,9 @@ Flow is POSIX compatible so it can be built for a lot more platforms.
 Consult the release notes for important changes.
 
 Requirements
-Flow depends on Akka 2.4 and requires a Java runtime version of 1.8.
+Flow depends on Akka 2.4 and requires a Java runtime version of 1.8. It is released for Scala binary versions 2.11 and 2.12.
 
 Previous Versions
-
-2.3.1
-
-
-  
-    Main Jar
-.jar (scala 2.11)
-.asc (signature)
-  
-  
-    Native Jar
-.jar
-.asc (signature)
-  
-
-
-Older Releases
 Archived releases are available in GitHub releases.
 
 
diff --git a/latest/api/com/github/jodersky/flow/AccessDeniedException.html b/latest/api/com/github/jodersky/flow/AccessDeniedException.html
index 0e369cb..476cfb3 100644
--- a/latest/api/com/github/jodersky/flow/AccessDeniedException.html
+++ b/latest/api/com/github/jodersky/flow/AccessDeniedException.html
@@ -49,7 +49,7 @@
       
       
       
-          Permissions are not sufficient to open a serial port.
 Source
Permissions are not sufficient to open a serial port. Sourceexceptions.scala

           Linear Supertypes
           Exception, Throwable, Serializable, AnyRef, Any
diff --git a/latest/api/com/github/jodersky/flow/InvalidSettingsException.html b/latest/api/com/github/jodersky/flow/InvalidSettingsException.html
index ca2ac35..3822791 100644
--- a/latest/api/com/github/jodersky/flow/InvalidSettingsException.html
+++ b/latest/api/com/github/jodersky/flow/InvalidSettingsException.html
@@ -49,7 +49,7 @@
       
       
       
-          The settings specified are invalid.
 Source
The settings specified are invalid. Sourceexceptions.scala

           Linear Supertypes
           Exception, Throwable, Serializable, AnyRef, Any
diff --git a/latest/api/com/github/jodersky/flow/NoSuchPortException.html b/latest/api/com/github/jodersky/flow/NoSuchPortException.html
index 347b495..e5ad05c 100644
--- a/latest/api/com/github/jodersky/flow/NoSuchPortException.html
+++ b/latest/api/com/github/jodersky/flow/NoSuchPortException.html
@@ -49,7 +49,7 @@
       
       
       
-          The requested port could not be found.
 Source
The requested port could not be found. Sourceexceptions.scala

           Linear Supertypes
           Exception, Throwable, Serializable, AnyRef, Any
diff --git a/latest/api/com/github/jodersky/flow/Parity$.html b/latest/api/com/github/jodersky/flow/Parity$.html
index 1e9bb38..5a1ee85 100644
--- a/latest/api/com/github/jodersky/flow/Parity$.html
+++ b/latest/api/com/github/jodersky/flow/Parity$.html
@@ -49,7 +49,7 @@
       
       
       
-          Specifies available parities used in serial communication.
 Source
Specifies available parities used in serial communication. SourceParity.scala

           Linear Supertypes
           Enumeration, Serializable, Serializable, AnyRef, Any
diff --git a/latest/api/com/github/jodersky/flow/PortClosedException.html b/latest/api/com/github/jodersky/flow/PortClosedException.html
index e675eb8..d13298d 100644
--- a/latest/api/com/github/jodersky/flow/PortClosedException.html
+++ b/latest/api/com/github/jodersky/flow/PortClosedException.html
@@ -49,7 +49,7 @@
       
       
       
-          The specified port has been closed.
 Source
The specified port has been closed. Sourceexceptions.scala

           Linear Supertypes
           Exception, Throwable, Serializable, AnyRef, Any
diff --git a/latest/api/com/github/jodersky/flow/PortInUseException.html b/latest/api/com/github/jodersky/flow/PortInUseException.html
index 8673180..c4eed16 100644
--- a/latest/api/com/github/jodersky/flow/PortInUseException.html
+++ b/latest/api/com/github/jodersky/flow/PortInUseException.html
@@ -49,7 +49,7 @@
       
       
       
-          The requested port is in use by someone else.
 Source
The requested port is in use by someone else. Sourceexceptions.scala

           Linear Supertypes
           Exception, Throwable, Serializable, AnyRef, Any
diff --git a/latest/api/com/github/jodersky/flow/PortInterruptedException.html b/latest/api/com/github/jodersky/flow/PortInterruptedException.html
index 486e73a..c092eef 100644
--- a/latest/api/com/github/jodersky/flow/PortInterruptedException.html
+++ b/latest/api/com/github/jodersky/flow/PortInterruptedException.html
@@ -49,14 +49,14 @@
       
       
       
-          A blocking operation on a port was interrupted, most likely indicating that the port is closing.
 Source
A blocking operation on a port was interrupted, most likely indicating that the port is closing. Sourceexceptions.scala

           Linear Supertypes
           Exception, Throwable, Serializable, AnyRef, Any
         

                 Type Hierarchy
                 Learn more about scaladoc diagrams
-                
+                
               
         
 
diff --git a/latest/api/com/github/jodersky/flow/Serial$$Close$.html b/latest/api/com/github/jodersky/flow/Serial$$Close$.html
index 7dc6edc..670f8f8 100644
--- a/latest/api/com/github/jodersky/flow/Serial$$Close$.html
+++ b/latest/api/com/github/jodersky/flow/Serial$$Close$.html
@@ -51,7 +51,7 @@
       
            Request closing of port.
 Send this command to an operator to close its associated port. The operator will respond
  with a Closed message upon closing the serial port.
-
 Source
 
Source
Serial.scala

           Linear Supertypes
           Serializable, Serializable, Product, Equals, Command, Message, AnyRef, Any
diff --git a/latest/api/com/github/jodersky/flow/Serial$$Closed$.html b/latest/api/com/github/jodersky/flow/Serial$$Closed$.html
index 5b37f32..8181629 100644
--- a/latest/api/com/github/jodersky/flow/Serial$$Closed$.html
+++ b/latest/api/com/github/jodersky/flow/Serial$$Closed$.html
@@ -50,7 +50,7 @@
       
       
           A port has been closed.
Event sent from operator, indicating that its port has been closed.
-
 Source
 
Source
Serial.scala

           Linear Supertypes
           Serializable, Serializable, Product, Equals, Event, Message, AnyRef, Any
diff --git a/latest/api/com/github/jodersky/flow/Serial$$Command.html b/latest/api/com/github/jodersky/flow/Serial$$Command.html
index 3f1d954..1c72c6c 100644
--- a/latest/api/com/github/jodersky/flow/Serial$$Command.html
+++ b/latest/api/com/github/jodersky/flow/Serial$$Command.html
@@ -49,7 +49,7 @@
       
       
       
-          A message extending this trait is to be viewed as a command, an out-bound message issued by the client to flow's API.
 Source
A message extending this trait is to be viewed as a command, an out-bound message issued by the client to flow's API. SourceSerial.scala

           Linear Supertypes
           Message, AnyRef, Any
diff --git a/latest/api/com/github/jodersky/flow/Serial$$CommandFailed.html b/latest/api/com/github/jodersky/flow/Serial$$CommandFailed.html
index 85f7c6d..63ef5d8 100644
--- a/latest/api/com/github/jodersky/flow/Serial$$CommandFailed.html
+++ b/latest/api/com/github/jodersky/flow/Serial$$CommandFailed.html
@@ -49,7 +49,7 @@
       
       
       
-          A command has failed.
 Source
A command has failed. SourceSerial.scala

           Linear Supertypes
           Serializable, Serializable, Product, Equals, Event, Message, AnyRef, Any
diff --git a/latest/api/com/github/jodersky/flow/Serial$$Connected.html b/latest/api/com/github/jodersky/flow/Serial$$Connected.html
index d87caf4..50be49a 100644
--- a/latest/api/com/github/jodersky/flow/Serial$$Connected.html
+++ b/latest/api/com/github/jodersky/flow/Serial$$Connected.html
@@ -50,7 +50,7 @@
       
       
           A new port (i.e. file) has been detected.
-
port
the absolute file name of the connected port
 Source
port
the absolute file name of the connected port
 SourceSerial.scala

           Linear Supertypes
           Serializable, Serializable, Product, Equals, Event, Message, AnyRef, Any
diff --git a/latest/api/com/github/jodersky/flow/Serial$$Event.html b/latest/api/com/github/jodersky/flow/Serial$$Event.html
index 0975df5..2857796 100644
--- a/latest/api/com/github/jodersky/flow/Serial$$Event.html
+++ b/latest/api/com/github/jodersky/flow/Serial$$Event.html
@@ -49,7 +49,7 @@
       
       
       
-          A message extending this trait is to be viewed as an event, an in-bound message issued by flow to the client.
 Source
A message extending this trait is to be viewed as an event, an in-bound message issued by flow to the client. SourceSerial.scala

           Linear Supertypes
           Message, AnyRef, Any
diff --git a/latest/api/com/github/jodersky/flow/Serial$$Message.html b/latest/api/com/github/jodersky/flow/Serial$$Message.html
index 1e97a05..3fe9359 100644
--- a/latest/api/com/github/jodersky/flow/Serial$$Message.html
+++ b/latest/api/com/github/jodersky/flow/Serial$$Message.html
@@ -49,7 +49,7 @@
       
       
       
-          Base trait for any flow-related messages.
 Source
Base trait for any flow-related messages. SourceSerial.scala

           Linear Supertypes
           AnyRef, Any
diff --git a/latest/api/com/github/jodersky/flow/Serial$$NoAck$.html b/latest/api/com/github/jodersky/flow/Serial$$NoAck$.html
index 943d79d..6dcc4a9 100644
--- a/latest/api/com/github/jodersky/flow/Serial$$NoAck$.html
+++ b/latest/api/com/github/jodersky/flow/Serial$$NoAck$.html
@@ -50,7 +50,7 @@
       
       
            Special type of acknowledgment that is not sent back.
-
 Source
 
Source
Serial.scala

           Linear Supertypes
           Serializable, Serializable, Product, Equals, (Int) ⇒ Event, AnyRef, Any
diff --git a/latest/api/com/github/jodersky/flow/Serial$$Open.html b/latest/api/com/github/jodersky/flow/Serial$$Open.html
index 5f07e65..7b79169 100644
--- a/latest/api/com/github/jodersky/flow/Serial$$Open.html
+++ b/latest/api/com/github/jodersky/flow/Serial$$Open.html
@@ -53,7 +53,7 @@
 attempt to open a serial port with the specified parameters and, if successful, create a SerialOperator actor associated to the port.
 The operator actor acts as an intermediate to the underlying native serial port, dealing with threading issues and dispatching messages.
In case the port is successfully opened, the operator will respond with an Opened message.
 In case the port cannot be opened, the manager will respond with a CommandFailed message.
-
port
name of serial port to open
settings
settings of serial port to open
bufferSize
maximum read and write buffer sizes
 Source
port
name of serial port to open
settings
settings of serial port to open
bufferSize
maximum read and write buffer sizes
 SourceSerial.scala

           Linear Supertypes
           Serializable, Serializable, Product, Equals, Command, Message, AnyRef, Any
diff --git a/latest/api/com/github/jodersky/flow/Serial$$Opened.html b/latest/api/com/github/jodersky/flow/Serial$$Opened.html
index d012ec4..d94932f 100644
--- a/latest/api/com/github/jodersky/flow/Serial$$Opened.html
+++ b/latest/api/com/github/jodersky/flow/Serial$$Opened.html
@@ -51,7 +51,7 @@
       
           A port has been successfully opened.
Event sent by a port operator, indicating that a serial port was successfully opened. The sender
 of this message is the operator associated to the given serial port.
-
port
name of opened serial port
 Source
port
name of opened serial port
 SourceSerial.scala

           Linear Supertypes
           Serializable, Serializable, Product, Equals, Event, Message, AnyRef, Any
diff --git a/latest/api/com/github/jodersky/flow/Serial$$Received.html b/latest/api/com/github/jodersky/flow/Serial$$Received.html
index a05f0d9..75b9cca 100644
--- a/latest/api/com/github/jodersky/flow/Serial$$Received.html
+++ b/latest/api/com/github/jodersky/flow/Serial$$Received.html
@@ -50,7 +50,7 @@
       
       
           Data has been received.
Event sent by an operator, indicating that data was received on the operator's serial port.
-
data
data received on the port
 Source
data
data received on the port
 SourceSerial.scala

           Linear Supertypes
           Serializable, Serializable, Product, Equals, Event, Message, AnyRef, Any
diff --git a/latest/api/com/github/jodersky/flow/Serial$$Unwatch.html b/latest/api/com/github/jodersky/flow/Serial$$Unwatch.html
index 1a0ecce..143a3d5 100644
--- a/latest/api/com/github/jodersky/flow/Serial$$Unwatch.html
+++ b/latest/api/com/github/jodersky/flow/Serial$$Unwatch.html
@@ -50,7 +50,7 @@
       
       
           Stop receiving notifications about a previously watched directory.
-
directory
the directory to unwatch
 Source
directory
the directory to unwatch
 SourceSerial.scala

           Linear Supertypes
           Serializable, Serializable, Product, Equals, Command, Message, AnyRef, Any
diff --git a/latest/api/com/github/jodersky/flow/Serial$$Watch.html b/latest/api/com/github/jodersky/flow/Serial$$Watch.html
index 2808e5d..b99db9c 100644
--- a/latest/api/com/github/jodersky/flow/Serial$$Watch.html
+++ b/latest/api/com/github/jodersky/flow/Serial$$Watch.html
@@ -52,7 +52,7 @@
           Watch a directory for new ports.
Send this command to the manager to get notifications when a new port (i.e. file) is created in
 the given directory.
 In case the given directory cannot be watched, the manager responds with a CommandFailed message.
Note: the sender is also notified of currently existing ports.
-
directory
the directory to watch
skipInitial
don't get notified of already existing ports
 Source
directory
the directory to watch
skipInitial
don't get notified of already existing ports
 SourceSerial.scala
See also
ConnectedUnwatch

           Linear Supertypes
           Serializable, Serializable, Product, Equals, Command, Message, AnyRef, Any
diff --git a/latest/api/com/github/jodersky/flow/Serial$$Write.html b/latest/api/com/github/jodersky/flow/Serial$$Write.html
index 560489d..188349a 100644
--- a/latest/api/com/github/jodersky/flow/Serial$$Write.html
+++ b/latest/api/com/github/jodersky/flow/Serial$$Write.html
@@ -55,7 +55,7 @@ Note that a successful write does not guarantee the actual transmission of data
 it merely guarantees that the data has been stored in the operating system's kernel buffer, ready to
 be transmitted.
 
data
data to be written to port
ack
acknowledgment sent back to sender once data has been enqueued in kernel for sending (the acknowledgment
-is a function 'number of bytes written => event')
 Source
 
Source
Serial.scala

           Linear Supertypes
           Serializable, Serializable, Product, Equals, Command, Message, AnyRef, Any
diff --git a/latest/api/com/github/jodersky/flow/Serial$.html b/latest/api/com/github/jodersky/flow/Serial$.html
index 5e23eaf..ca52c09 100644
--- a/latest/api/com/github/jodersky/flow/Serial$.html
+++ b/latest/api/com/github/jodersky/flow/Serial$.html
@@ -49,7 +49,7 @@
       
       
       
-          Defines messages used by flow's serial IO layer.
 Source
Defines messages used by flow's serial IO layer. SourceSerial.scala

           Linear Supertypes
           ExtensionKey[SerialExt], ExtensionIdProvider, ExtensionId[SerialExt], AnyRef, Any
diff --git a/latest/api/com/github/jodersky/flow/SerialExt.html b/latest/api/com/github/jodersky/flow/SerialExt.html
index 01a0fd3..71f316f 100644
--- a/latest/api/com/github/jodersky/flow/SerialExt.html
+++ b/latest/api/com/github/jodersky/flow/SerialExt.html
@@ -49,7 +49,7 @@
       
       
       
-          Provides the serial IO manager.
 Source
Provides the serial IO manager. SourceSerialExt.scala

           Linear Supertypes
           Extension, Extension, AnyRef, Any
diff --git a/latest/api/com/github/jodersky/flow/SerialManager$.html b/latest/api/com/github/jodersky/flow/SerialManager$.html
index f79c6b9..ae6f91b 100644
--- a/latest/api/com/github/jodersky/flow/SerialManager$.html
+++ b/latest/api/com/github/jodersky/flow/SerialManager$.html
@@ -51,7 +51,7 @@
       
       
       
-           Source
 SourceSerialManager.scala

           Linear Supertypes
           AnyRef, Any
diff --git a/latest/api/com/github/jodersky/flow/SerialManager.html b/latest/api/com/github/jodersky/flow/SerialManager.html
index 49b80e8..8c8926c 100644
--- a/latest/api/com/github/jodersky/flow/SerialManager.html
+++ b/latest/api/com/github/jodersky/flow/SerialManager.html
@@ -52,7 +52,7 @@
       
       
           Entry point to the serial API. Actor that manages serial port creation. Once opened, a serial port is handed over to
-a dedicated operator actor that acts as an intermediate between client code and the native system serial port.
 Source
 
Source
SerialManager.scala
See also
SerialOperator

           Linear Supertypes
           ActorLogging, Actor, AnyRef, Any
diff --git a/latest/api/com/github/jodersky/flow/SerialOperator$.html b/latest/api/com/github/jodersky/flow/SerialOperator$.html
index 39add17..0803656 100644
--- a/latest/api/com/github/jodersky/flow/SerialOperator$.html
+++ b/latest/api/com/github/jodersky/flow/SerialOperator$.html
@@ -51,7 +51,7 @@
       
       
       
-           Source
 SourceSerialOperator.scala

           Linear Supertypes
           AnyRef, Any
diff --git a/latest/api/com/github/jodersky/flow/SerialOperator.html b/latest/api/com/github/jodersky/flow/SerialOperator.html
index 6131685..aebec40 100644
--- a/latest/api/com/github/jodersky/flow/SerialOperator.html
+++ b/latest/api/com/github/jodersky/flow/SerialOperator.html
@@ -51,7 +51,7 @@
       
       
       
-          Operator associated to an open serial port. All communication with a port is done via an operator. Operators are created though the serial manager.
 Source
Operator associated to an open serial port. All communication with a port is done via an operator. Operators are created though the serial manager. SourceSerialOperator.scala
See also
SerialManager

           Linear Supertypes
           ActorLogging, Actor, AnyRef, Any
diff --git a/latest/api/com/github/jodersky/flow/SerialSettings.html b/latest/api/com/github/jodersky/flow/SerialSettings.html
index 9cae130..6934c22 100644
--- a/latest/api/com/github/jodersky/flow/SerialSettings.html
+++ b/latest/api/com/github/jodersky/flow/SerialSettings.html
@@ -49,7 +49,7 @@
       
       
       
-          Groups settings used in communication over a serial port.
baud
baud rate to use with serial port
characterSize
size of a character of the data sent through the serial port
twoStopBits
set to use two stop bits instead of one
parity
type of parity to use with serial port
 Source
Groups settings used in communication over a serial port.
baud
baud rate to use with serial port
characterSize
size of a character of the data sent through the serial port
twoStopBits
set to use two stop bits instead of one
parity
type of parity to use with serial port SourceSerialSettings.scala

           Linear Supertypes
           Serializable, Serializable, Product, Equals, AnyRef, Any
diff --git a/latest/api/com/github/jodersky/flow/internal/NativeLoader$.html b/latest/api/com/github/jodersky/flow/internal/NativeLoader$.html
index 87240a4..a5658c8 100644
--- a/latest/api/com/github/jodersky/flow/internal/NativeLoader$.html
+++ b/latest/api/com/github/jodersky/flow/internal/NativeLoader$.html
@@ -49,7 +49,7 @@
       
       
       
-          Handles loading of the current platform's native library for flow.
 Source
Handles loading of the current platform's native library for flow. SourceNativeLoader.scala

           Linear Supertypes
           AnyRef, Any
diff --git a/latest/api/com/github/jodersky/flow/internal/Reader.html b/latest/api/com/github/jodersky/flow/internal/Reader.html
index 8d31466..3cb974b 100644
--- a/latest/api/com/github/jodersky/flow/internal/Reader.html
+++ b/latest/api/com/github/jodersky/flow/internal/Reader.html
@@ -49,7 +49,7 @@
       
       
       
-           Source
 SourceReader.scala

           Linear Supertypes
           Thread, Runnable, AnyRef, Any
diff --git a/latest/api/com/github/jodersky/flow/internal/SerialConnection$.html b/latest/api/com/github/jodersky/flow/internal/SerialConnection$.html
index 3809e60..2a0855c 100644
--- a/latest/api/com/github/jodersky/flow/internal/SerialConnection$.html
+++ b/latest/api/com/github/jodersky/flow/internal/SerialConnection$.html
@@ -51,7 +51,7 @@
       
       
       
-           Source
 SourceSerialConnection.scala

           Linear Supertypes
           AnyRef, Any
diff --git a/latest/api/com/github/jodersky/flow/internal/SerialConnection.html b/latest/api/com/github/jodersky/flow/internal/SerialConnection.html
index 73592e8..ebcd959 100644
--- a/latest/api/com/github/jodersky/flow/internal/SerialConnection.html
+++ b/latest/api/com/github/jodersky/flow/internal/SerialConnection.html
@@ -54,7 +54,7 @@
           Represents a serial connection in a more secure and object-oriented style than NativeSerial. In contrast
 to the latter, this class encapsulates and secures any pointers used to communicate with the native
 backend and is thread-safe.
The underlying serial port is assumed open when this class is initialized.
-
 Source
 
Source
SerialConnection.scala

           Linear Supertypes
           AnyRef, Any
diff --git a/latest/api/com/github/jodersky/flow/internal/ThreadDied.html b/latest/api/com/github/jodersky/flow/internal/ThreadDied.html
index 41e5c36..ad87d22 100644
--- a/latest/api/com/github/jodersky/flow/internal/ThreadDied.html
+++ b/latest/api/com/github/jodersky/flow/internal/ThreadDied.html
@@ -49,7 +49,7 @@
       
       
       
-           Source
 SourceThreadDied.scala

           Linear Supertypes
           Serializable, Serializable, Product, Equals, AnyRef, Any
diff --git a/latest/api/com/github/jodersky/flow/internal/Watcher$.html b/latest/api/com/github/jodersky/flow/internal/Watcher$.html
index 248f1f9..6d52195 100644
--- a/latest/api/com/github/jodersky/flow/internal/Watcher$.html
+++ b/latest/api/com/github/jodersky/flow/internal/Watcher$.html
@@ -51,7 +51,7 @@
       
       
       
-           Source
 SourceWatcher.scala

           Linear Supertypes
           AnyRef, Any
diff --git a/latest/api/com/github/jodersky/flow/internal/Watcher.html b/latest/api/com/github/jodersky/flow/internal/Watcher.html
index 8b8832d..cd1c4e0 100644
--- a/latest/api/com/github/jodersky/flow/internal/Watcher.html
+++ b/latest/api/com/github/jodersky/flow/internal/Watcher.html
@@ -51,7 +51,7 @@
       
       
       
-           Source
 SourceWatcher.scala

           Linear Supertypes
           Actor, AnyRef, Any
diff --git a/latest/api/com/github/jodersky/flow/samples/terminal/ConsoleReader$$ConsoleInput.html b/latest/api/com/github/jodersky/flow/samples/terminal/ConsoleReader$$ConsoleInput.html
index aac8707..af12d2d 100644
--- a/latest/api/com/github/jodersky/flow/samples/terminal/ConsoleReader$$ConsoleInput.html
+++ b/latest/api/com/github/jodersky/flow/samples/terminal/ConsoleReader$$ConsoleInput.html
@@ -49,7 +49,7 @@
       
       
       
-           Source
 SourceConsoleReader.scala

           Linear Supertypes
           Serializable, Serializable, Product, Equals, AnyRef, Any
diff --git a/latest/api/com/github/jodersky/flow/samples/terminal/ConsoleReader$$EOT$.html b/latest/api/com/github/jodersky/flow/samples/terminal/ConsoleReader$$EOT$.html
index 6bbb803..d6f0136 100644
--- a/latest/api/com/github/jodersky/flow/samples/terminal/ConsoleReader$$EOT$.html
+++ b/latest/api/com/github/jodersky/flow/samples/terminal/ConsoleReader$$EOT$.html
@@ -49,7 +49,7 @@
       
       
       
-           Source
 SourceConsoleReader.scala

           Linear Supertypes
           Serializable, Serializable, Product, Equals, AnyRef, Any
diff --git a/latest/api/com/github/jodersky/flow/samples/terminal/ConsoleReader$$Read$.html b/latest/api/com/github/jodersky/flow/samples/terminal/ConsoleReader$$Read$.html
index 01be739..6fa18c9 100644
--- a/latest/api/com/github/jodersky/flow/samples/terminal/ConsoleReader$$Read$.html
+++ b/latest/api/com/github/jodersky/flow/samples/terminal/ConsoleReader$$Read$.html
@@ -49,7 +49,7 @@
       
       
       
-           Source
 SourceConsoleReader.scala

           Linear Supertypes
           Serializable, Serializable, Product, Equals, AnyRef, Any
diff --git a/latest/api/com/github/jodersky/flow/samples/terminal/ConsoleReader$.html b/latest/api/com/github/jodersky/flow/samples/terminal/ConsoleReader$.html
index edf6f77..6530c8b 100644
--- a/latest/api/com/github/jodersky/flow/samples/terminal/ConsoleReader$.html
+++ b/latest/api/com/github/jodersky/flow/samples/terminal/ConsoleReader$.html
@@ -51,7 +51,7 @@
       
       
       
-           Source
 SourceConsoleReader.scala

           Linear Supertypes
           AnyRef, Any
diff --git a/latest/api/com/github/jodersky/flow/samples/terminal/ConsoleReader.html b/latest/api/com/github/jodersky/flow/samples/terminal/ConsoleReader.html
index 6eed367..bf80d99 100644
--- a/latest/api/com/github/jodersky/flow/samples/terminal/ConsoleReader.html
+++ b/latest/api/com/github/jodersky/flow/samples/terminal/ConsoleReader.html
@@ -51,7 +51,7 @@
       
       
       
-           Source
 SourceConsoleReader.scala

           Linear Supertypes
           Actor, AnyRef, Any
diff --git a/latest/api/com/github/jodersky/flow/samples/terminal/Main$.html b/latest/api/com/github/jodersky/flow/samples/terminal/Main$.html
index 9586926..e90d230 100644
--- a/latest/api/com/github/jodersky/flow/samples/terminal/Main$.html
+++ b/latest/api/com/github/jodersky/flow/samples/terminal/Main$.html
@@ -49,7 +49,7 @@
       
       
       
-           Source
 SourceMain.scala

           Linear Supertypes
           AnyRef, Any
diff --git a/latest/api/com/github/jodersky/flow/samples/terminal/Terminal$$Wrote.html b/latest/api/com/github/jodersky/flow/samples/terminal/Terminal$$Wrote.html
index facdae4..528048d 100644
--- a/latest/api/com/github/jodersky/flow/samples/terminal/Terminal$$Wrote.html
+++ b/latest/api/com/github/jodersky/flow/samples/terminal/Terminal$$Wrote.html
@@ -49,7 +49,7 @@
       
       
       
-           Source
 SourceTerminal.scala

           Linear Supertypes
           Serializable, Serializable, Product, Equals, Event, Message, AnyRef, Any
diff --git a/latest/api/com/github/jodersky/flow/samples/terminal/Terminal$.html b/latest/api/com/github/jodersky/flow/samples/terminal/Terminal$.html
index dca851f..10b4055 100644
--- a/latest/api/com/github/jodersky/flow/samples/terminal/Terminal$.html
+++ b/latest/api/com/github/jodersky/flow/samples/terminal/Terminal$.html
@@ -51,7 +51,7 @@
       
       
       
-           Source
 SourceTerminal.scala

           Linear Supertypes
           AnyRef, Any
diff --git a/latest/api/com/github/jodersky/flow/samples/terminal/Terminal.html b/latest/api/com/github/jodersky/flow/samples/terminal/Terminal.html
index cf3386c..88b111b 100644
--- a/latest/api/com/github/jodersky/flow/samples/terminal/Terminal.html
+++ b/latest/api/com/github/jodersky/flow/samples/terminal/Terminal.html
@@ -51,7 +51,7 @@
       
       
       
-           Source
 SourceTerminal.scala

           Linear Supertypes
           ActorLogging, Actor, AnyRef, Any
diff --git a/latest/api/com/github/jodersky/flow/samples/watcher/Main$.html b/latest/api/com/github/jodersky/flow/samples/watcher/Main$.html
index 80853e1..993dd6a 100644
--- a/latest/api/com/github/jodersky/flow/samples/watcher/Main$.html
+++ b/latest/api/com/github/jodersky/flow/samples/watcher/Main$.html
@@ -49,7 +49,7 @@
       
       
       
-           Source
 Sourcemain.scala

           Linear Supertypes
           AnyRef, Any
diff --git a/latest/api/com/github/jodersky/flow/samples/watcher/Watcher.html b/latest/api/com/github/jodersky/flow/samples/watcher/Watcher.html
index 6af9d56..dc6ea30 100644
--- a/latest/api/com/github/jodersky/flow/samples/watcher/Watcher.html
+++ b/latest/api/com/github/jodersky/flow/samples/watcher/Watcher.html
@@ -49,7 +49,7 @@
       
       
       
-           Source
 Sourcemain.scala

           Linear Supertypes
           ActorLogging, Actor, AnyRef, Any
-- 
cgit v1.2.3
Building from Source

Building Scala Sources

Building Native Sources

Build Process

Creating a Fat Jar

Note About Versioning

Publishing and Releasing

Help

Getting Started

The Easy Way

Maximum Portability

Requirements

Building from Source

Building Scala Sources

Building Native Sources

Build Process

Creating a Fat Jar

Note About Versioning

Latest Version 2.4.0-M2

Latest Version 2.4.0

Archives

Requirements

Previous Versions

2.3.1

Older Releases
