|
|
package com.github.jodersky.flow
import akka.actor.ActorRef
import akka.actor.ExtensionKey
import akka.util.ByteString
/** Defines messages used by flow's serial IO layer. */
object Serial extends ExtensionKey[SerialExt] {
/** A message extending this trait is to be viewed as a command, that is an out-bound message. */
trait Command
/** A message extending this trait is to be viewed as an event, that is an in-bound message. */
trait Event
/**
* Open a new serial port. Send this command to the serial manager to request the opening of a serial port. The manager will
* 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 the such. It will send any events
* to the sender of this message.
* The manager will respond with an `OpenFailed` in case the port could not be opened, or the operator will respond with `Opened`.
* @param port name of serial port
* @param baud baud rate to use with serial port
* @param characterSize size of a character of the data sent through the serial port
* @param twoStopBits set to use two stop bits instead of one
* @param parity type of parity to use with serial port
*/
case class Open(port: String, baud: Int, characterSize: Int = 8, twoStopBits: Boolean = false, parity: Parity.Parity = Parity.None) extends Command
/**
* Event sent from 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.
* @param port name of serial port
* @param baud baud rate to use with serial port
* @param characterSize size of a character of the data sent through the serial port
* @param twoStopBits set to use two stop bits instead of one
* @param parity type of parity to use with serial port
*/
case class Opened(port: String, baud: Int, characterSize: Int, twoStopBits: Boolean, parity: Parity.Parity) extends Event
/**
* Event sent from the serial manager, indicating that a serial port could not be opened.
* @param reason throwable containing reason to why the requested port could not be opened
* @param port name of serial port
* @param baud baud rate to use with serial port
* @param characterSize size of a character of the data sent through the serial port
* @param twoStopBits set to use two stop bits instead of one
* @param parity type of parity to use with serial port
*/
case class OpenFailed(reason: Throwable, port: String, baud: Int, characterSize: Int, twoStopBits: Boolean, parity: Parity.Parity) extends Event
/**
* Event sent by operator, indicating that data was received from the operator's serial port.
* @param data data received by port
*/
case class Received(data: ByteString) extends Event
/**
* Write data to serial port. Send this command to an operator to write the given data to its associated serial port.
* @param data data to be written to port
* @param ack acknowledgment sent back to sender once data has been enqueued in kernel for sending
*/
case class Write(data: ByteString, ack: Event = NoAck) extends Command
/** Special type of acknowledgment that is not sent back. */
case object NoAck extends Event
/** Request closing of port. Send this command to an operator to close its associated port. */
case object Close extends Command
/**
* Event sent from operator, indicating that its port has been closed. An optional reason explains the error (if any) that caused the closing of the port.
* @param reason Some(exception) explaining the exception that caused the closing, None if the port was closed by sending a `Close` message.
*/
case class Closed(reason: Option[Exception]) extends Event
}
|
