Type Members

1.  trait Command extends Message

   A message extending this trait is to be viewed as a command, an out-bound message issued by the client to akka-serial's API.

2.  case class CommandFailed(command: Command, reason: Throwable) extends Event with Product with Serializable

   A command has failed.

3.  case class Connected(port: String) extends Event with Product with Serializable

   A new port (i.e.

   A new port (i.e. file) has been detected.

   port

   the absolute file name of the connected port

4.  trait Event extends Message

   A message extending this trait is to be viewed as an event, an in-bound message issued by akka-serial to the client.

5.  sealed trait Message extends AnyRef

   Base trait for any akka-serial-related messages.

6.  case class Open(port: String, settings: SerialSettings, bufferSize: Int = 1024) extends Command with Product with Serializable

   Open a new serial port.

   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 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

7.  case class Opened(port: String) extends Event with Product with Serializable

   A port has been successfully opened.

   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

8.  case class Received(data: ByteString) extends Event with Product with Serializable

   Data has been received.

   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

9.  case class Unwatch(directory: String = "/dev") extends Command with Product with Serializable

   Stop receiving notifications about a previously watched directory.

   Stop receiving notifications about a previously watched directory.

   directory

   the directory to unwatch

10.  case class Watch(directory: String = "/dev", skipInitial: Boolean = false) extends Command with Product with Serializable

    Watch a directory for new ports.

    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

    See also

    Unwatch

    Connected

11.  case class Write(data: ByteString, ack: (Int) => Event = NoAck) extends Command with Product with Serializable

    Write data to a serial port.

    Write data to a serial port.

    Send this command to an operator to write the given data to its associated serial port. An acknowledgment may be set, in which case it is sent back to the sender on a successful write. Note that a successful write does not guarantee the actual transmission of data through the serial port, 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')