Packages

final case class WritePath(path: Path, position: Long, count: Long, ack: Event) extends SimpleWriteCommand with Product with Serializable

Write count bytes starting at position from file at filePath to the connection. The count must be > 0. The connection actor will reply with a CommandFailed message if the write could not be enqueued. If SimpleWriteCommand#wantsAck returns true, the connection actor will reply with the supplied SimpleWriteCommand#ack token once the write has been successfully enqueued to the O/S kernel. Note that this does not in any way guarantee that the data will be or have been sent! Unfortunately there is no way to determine whether a particular write has been sent by the O/S.

Source
Tcp.scala
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WritePath
  2. Serializable
  3. Product
  4. Equals
  5. SimpleWriteCommand
  6. WriteCommand
  7. Command
  8. HasFailureMessage
  9. Message
  10. NoSerializationVerificationNeeded
  11. AnyRef
  12. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new WritePath(path: Path, position: Long, count: Long, ack: Event)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from WritePath toany2stringadd[WritePath] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ++:(writes: Iterable[WriteCommand]): WriteCommand

    Prepends this command with a number of other writes.

    Prepends this command with a number of other writes. The first element of the given Iterable becomes the first sub write of a potentially created CompoundWrite.

    Definition Classes
    WriteCommand
  5. def +:(other: SimpleWriteCommand): CompoundWrite

    Prepends this command with another Write or WriteFile to form a CompoundWrite.

    Prepends this command with another Write or WriteFile to form a CompoundWrite.

    Definition Classes
    WriteCommand
  6. def ->[B](y: B): (WritePath, B)
    Implicit
    This member is added by an implicit conversion from WritePath toArrowAssoc[WritePath] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  7. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. val ack: Event

    The acknowledgment token associated with this write command.

    The acknowledgment token associated with this write command.

    Definition Classes
    WritePathSimpleWriteCommand
  9. def append(that: WriteCommand): CompoundWrite

    Java API: appends this command with another WriteCommand to form a CompoundWrite.

    Java API: appends this command with another WriteCommand to form a CompoundWrite.

    Definition Classes
    SimpleWriteCommand
  10. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  12. val count: Long
  13. def ensuring(cond: (WritePath) => Boolean, msg: => Any): WritePath
    Implicit
    This member is added by an implicit conversion from WritePath toEnsuring[WritePath] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: (WritePath) => Boolean): WritePath
    Implicit
    This member is added by an implicit conversion from WritePath toEnsuring[WritePath] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean, msg: => Any): WritePath
    Implicit
    This member is added by an implicit conversion from WritePath toEnsuring[WritePath] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean): WritePath
    Implicit
    This member is added by an implicit conversion from WritePath toEnsuring[WritePath] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def failureMessage: CommandFailed
    Definition Classes
    Command → HasFailureMessage
  19. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  24. val path: Path
  25. val position: Long
  26. def prepend(writes: Iterable[WriteCommand]): WriteCommand

    Java API: prepends this command with a number of other writes.

    Java API: prepends this command with a number of other writes. The first element of the given Iterable becomes the first sub write of a potentially created CompoundWrite.

    Definition Classes
    WriteCommand
  27. def prepend(that: SimpleWriteCommand): CompoundWrite

    Java API: prepends this command with another Write or WriteFile to form a CompoundWrite.

    Java API: prepends this command with another Write or WriteFile to form a CompoundWrite.

    Definition Classes
    WriteCommand
  28. def productElementNames: Iterator[String]
    Definition Classes
    Product
  29. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  32. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  33. def wantsAck: Boolean

    An acknowledgment is only sent if this write command “wants an ack”, which is equivalent to the #ack token not being a of type NoAck.

    An acknowledgment is only sent if this write command “wants an ack”, which is equivalent to the #ack token not being a of type NoAck.

    Definition Classes
    SimpleWriteCommand

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from WritePath toStringFormat[WritePath] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def [B](y: B): (WritePath, B)
    Implicit
    This member is added by an implicit conversion from WritePath toArrowAssoc[WritePath] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from SimpleWriteCommand

Inherited from WriteCommand

Inherited from Command

Inherited from HasFailureMessage

Inherited from Message

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromWritePath to any2stringadd[WritePath]

Inherited by implicit conversion StringFormat fromWritePath to StringFormat[WritePath]

Inherited by implicit conversion Ensuring fromWritePath to Ensuring[WritePath]

Inherited by implicit conversion ArrowAssoc fromWritePath to ArrowAssoc[WritePath]

Ungrouped