aboutsummaryrefslogtreecommitdiff
path: root/flow-main/src/main/java
diff options
context:
space:
mode:
authorJakob Odersky <jodersky@gmail.com>2013-06-27 19:27:57 +0200
committerJakob Odersky <jodersky@gmail.com>2013-06-27 19:27:57 +0200
commit719978035732a55261b753bbc33570d3c1f53785 (patch)
treede110fafce8b2ca11f7061f4c8f4b93a4baf548a /flow-main/src/main/java
parentf21d2de9405d5dd36f108a380f558cab930c1205 (diff)
downloadakka-serial-719978035732a55261b753bbc33570d3c1f53785.tar.gz
akka-serial-719978035732a55261b753bbc33570d3c1f53785.tar.bz2
akka-serial-719978035732a55261b753bbc33570d3c1f53785.zip
refactor build to a more generic structure
Diffstat (limited to 'flow-main/src/main/java')
-rw-r--r--flow-main/src/main/java/com/github/jodersky/flow/internal/NativeSerial.java68
1 files changed, 68 insertions, 0 deletions
diff --git a/flow-main/src/main/java/com/github/jodersky/flow/internal/NativeSerial.java b/flow-main/src/main/java/com/github/jodersky/flow/internal/NativeSerial.java
new file mode 100644
index 0000000..dba3f44
--- /dev/null
+++ b/flow-main/src/main/java/com/github/jodersky/flow/internal/NativeSerial.java
@@ -0,0 +1,68 @@
+package com.github.jodersky.flow.internal;
+
+import com.github.jodersky.flow.internal.NativeLoader;
+
+/** Thin layer on top of native code. */
+class NativeSerial {
+
+ static {
+ NativeLoader.load();
+ }
+
+ final static int E_IO = -1;
+ final static int E_ACCESS_DENIED = -2;
+ final static int E_BUSY = -3;
+ final static int E_INVALID_BAUD = -4;
+ final static int E_INTERRUPT = -5;
+ final static int E_NO_PORT = -6;
+
+ /**Opens a serial port and allocates memory for storing configuration. Note: if this function fails,
+ * any internally allocated resources will be freed.
+ * @param port_name name of port
+ * @param baud baud rate
+ * @param serial pointer to memory that will be allocated with a serial structure
+ * @return 0 on success
+ * @return E_NO_PORT if the given port does not exist
+ * @return E_ACCESS_DENIED if permissions are not sufficient to open port
+ * @return E_BUSY if port is already in use
+ * @return E_INVALID_BAUD if specified baudrate is non-standard
+ * @return E_IO on other error */
+ native static int open(String device, int baud, long[] serial);
+
+ /**Starts a blocking read from a previously opened serial port. The read is blocking, however it may be
+ * interrupted by calling 'serial_interrupt' on the given serial port.
+ * @param serial pointer to serial configuration from which to read
+ * @param buffer buffer into which data is read
+ * @param size maximum buffer size
+ * @return n>0 the number of bytes read into buffer
+ * @return E_INTERRUPT if the call to this function was interrupted
+ * @return E_IO on IO error */
+ native static int read(long serial, byte[] buffer);
+
+ /**Writes data to a previously opened serial port.
+ * @param serial pointer to serial configuration to which to write
+ * @param data data to write
+ * @param size number of bytes to write from data
+ * @return n>0 the number of bytes written
+ * @return E_IO on IO error */
+ native static int write(long serial, byte[] buffer);
+
+ /**Interrupts a blocked read call.
+ * @param serial_config the serial port to interrupt
+ * @return 0 on success
+ * @return E_IO on error */
+ native static int interrupt(long serial);
+
+ /**Closes a previously opened serial port and frees memory containing the configuration. Note: after a call to
+ * this function, the 'serial' pointer will become invalid, make sure you only call it once. This function is NOT
+ * thread safe, make sure no read or write is in prgress when this function is called (the reason is that per
+ * close manual page, close should not be called on a file descriptor that is in use by another thread).
+ * @param serial pointer to serial configuration that is to be closed (and freed)
+ * @return 0 on success
+ * @return E_IO on error */
+ native static int close(long serial);
+
+ /**Sets debugging option. If debugging is enabled, detailed error message are printed from method calls. */
+ native static void debug(boolean value);
+
+}