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
- Alphabetic
- By Inheritance
- WritePath
- Serializable
- Product
- Equals
- SimpleWriteCommand
- WriteCommand
- Command
- HasFailureMessage
- Message
- NoSerializationVerificationNeeded
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- 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
- def +:(other: SimpleWriteCommand): CompoundWrite
Prepends this command with another
Write
orWriteFile
to form aCompoundWrite
.Prepends this command with another
Write
orWriteFile
to form aCompoundWrite
.- Definition Classes
- WriteCommand
- def ->[B](y: B): (WritePath, B)
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val ack: Event
The acknowledgment token associated with this write command.
The acknowledgment token associated with this write command.
- Definition Classes
- WritePath → SimpleWriteCommand
- def append(that: WriteCommand): CompoundWrite
Java API: appends this command with another
WriteCommand
to form aCompoundWrite
.Java API: appends this command with another
WriteCommand
to form aCompoundWrite
.- Definition Classes
- SimpleWriteCommand
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- val count: Long
- def ensuring(cond: (WritePath) => Boolean, msg: => Any): WritePath
- def ensuring(cond: (WritePath) => Boolean): WritePath
- def ensuring(cond: Boolean, msg: => Any): WritePath
- def ensuring(cond: Boolean): WritePath
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def failureMessage: CommandFailed
- Definition Classes
- Command → HasFailureMessage
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val path: Path
- val position: Long
- 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
- def prepend(that: SimpleWriteCommand): CompoundWrite
Java API: prepends this command with another
Write
orWriteFile
to form aCompoundWrite
.Java API: prepends this command with another
Write
orWriteFile
to form aCompoundWrite
.- Definition Classes
- WriteCommand
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- 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
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
- 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 ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
- 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.