Class/Object

akka.serial.sync

SerialConnection

Related Docs: object SerialConnection | package sync

Permalink

class SerialConnection extends AnyRef

Represents a serial connection in a more secure and object-oriented style than UnsafeSerial. 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.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SerialConnection
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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. final def asInstanceOf[T0]: T0

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. def close(): Unit

    Permalink

    Closes the underlying serial connection.

    Closes the underlying serial connection. Any callers blocked on read or write will return. A call of this method has no effect if the serial port is already closed.

    Exceptions thrown

    IOException on IO error

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

    Permalink
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    AnyRef → Any
  12. def isClosed: Boolean

    Permalink

    Checks if this serial port is closed.

  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  17. val port: String

    Permalink
  18. def read(buffer: ByteBuffer): Int

    Permalink

    Reads data from underlying serial connection into a ByteBuffer.

    Reads data from underlying serial connection into a ByteBuffer. Note that data is read into the buffer's memory, starting at the first position. The buffer's limit is set to the number of bytes read.

    A call to this method is blocking, however it is interrupted if the connection is closed.

    This method works only for direct buffers.

    buffer

    a ByteBuffer into which data is read

    returns

    the actual number of bytes read

    Exceptions thrown

    IOException on IO error

    PortInterruptedException if port is closed while reading

  19. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. def write(buffer: ByteBuffer): Int

    Permalink

    Writes data from a ByteBuffer to underlying serial connection.

    Writes data from a ByteBuffer to underlying serial connection. Note that data is read from the buffer's memory, its attributes such as position and limit are not modified.

    The write is non-blocking, this function returns as soon as the data is copied into the kernel's transmission buffer.

    This method works only for direct buffers.

    buffer

    a ByteBuffer from which data is taken

    returns

    the actual number of bytes written

    Exceptions thrown

    IOException on IO error

Inherited from AnyRef

Inherited from Any

Ungrouped