Object

ch.jodersky.flow

Serial

Related Doc: package flow

Permalink

object Serial extends ExtensionKey[SerialExt]

Defines messages used by flow's serial IO layer.

Linear Supertypes
ExtensionKey[SerialExt], ExtensionIdProvider, ExtensionId[SerialExt], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Serial
  2. ExtensionKey
  3. ExtensionIdProvider
  4. ExtensionId
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. trait Command extends Message

    Permalink

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

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

    Permalink

    A command has failed.

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

    Permalink

    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

    Permalink

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

  5. sealed trait Message extends AnyRef

    Permalink

    Base trait for any flow-related messages.

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

    Permalink

    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

    Permalink

    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

    Permalink

    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

    Permalink

    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

    Permalink

    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

    Connected

    Unwatch

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

    Permalink

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

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. object Close extends Command with Product with Serializable

    Permalink

    Request closing of port.

    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.

  5. object Closed extends Event with Product with Serializable

    Permalink

    A port has been closed.

    A port has been closed.

    Event sent from operator, indicating that its port has been closed.

  6. object NoAck extends (Int) ⇒ Event with Product with Serializable

    Permalink

    Special type of acknowledgment that is not sent back.

  7. def apply(system: ActorSystem): SerialExt

    Permalink
    Definition Classes
    ExtensionId
  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def createExtension(system: ExtendedActorSystem): SerialExt

    Permalink
    Definition Classes
    ExtensionKey → ExtensionId
  11. def debug(value: Boolean): Unit

    Permalink

    Sets native debugging mode.

    Sets native debugging mode. If debugging is enabled, detailed error messages are printed (to stderr) from native method calls.

    value

    set to enable debugging

  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. final def equals(other: Any): Boolean

    Permalink
    Definition Classes
    ExtensionId → AnyRef → Any
  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def get(system: ActorSystem): SerialExt

    Permalink
    Definition Classes
    ExtensionId
  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  17. final def hashCode(): Int

    Permalink
    Definition Classes
    ExtensionId → AnyRef → Any
  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  19. def lookup(): ExtensionId[SerialExt]

    Permalink
    Definition Classes
    ExtensionKey → ExtensionIdProvider
  20. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  22. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  23. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  24. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  25. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from ExtensionKey[SerialExt]

Inherited from ExtensionIdProvider

Inherited from ExtensionId[SerialExt]

Inherited from AnyRef

Inherited from Any

Ungrouped