akka.io.Tcp

WriteFile

Related Doc: package Tcp

case class WriteFile(filePath: String, 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 WriteCommand#wantsAck returns true, the connection actor will reply with the supplied WriteCommand#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
Linear Supertypes
Serializable, Serializable, Product, Equals, SimpleWriteCommand, WriteCommand, Command, HasFailureMessage, Message, NoSerializationVerificationNeeded, AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. WriteFile
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. SimpleWriteCommand
  7. WriteCommand
  8. Command
  9. HasFailureMessage
  10. Message
  11. NoSerializationVerificationNeeded
  12. AnyRef
  13. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new WriteFile(filePath: String, 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 information
    This member is added by an implicit conversion from WriteFile to any2stringadd[WriteFile] 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): (WriteFile, B)

    Implicit information
    This member is added by an implicit conversion from WriteFile to ArrowAssoc[WriteFile] 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
    WriteFile → SimpleWriteCommand

  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[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  12. val count: Long

  13. def ensuring(cond: (WriteFile) ⇒ Boolean, msg: ⇒ Any): WriteFile

    Implicit information
    This member is added by an implicit conversion from WriteFile to Ensuring[WriteFile] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  14. def ensuring(cond: (WriteFile) ⇒ Boolean): WriteFile

    Implicit information
    This member is added by an implicit conversion from WriteFile to Ensuring[WriteFile] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  15. def ensuring(cond: Boolean, msg: ⇒ Any): WriteFile

    Implicit information
    This member is added by an implicit conversion from WriteFile to Ensuring[WriteFile] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  16. def ensuring(cond: Boolean): WriteFile

    Implicit information
    This member is added by an implicit conversion from WriteFile to Ensuring[WriteFile] 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. val filePath: String

  20. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  21. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from WriteFile to StringFormat[WriteFile] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  22. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  23. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  24. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  25. final def notify(): Unit

    Definition Classes
    AnyRef

  26. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  27. val position: Long

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

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

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

    Definition Classes
    AnyRef

  31. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  32. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  33. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

  35. def →[B](y: B): (WriteFile, B)

    Implicit information
    This member is added by an implicit conversion from WriteFile to ArrowAssoc[WriteFile] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Serializable

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 NoSerializationVerificationNeeded

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from WriteFile to any2stringadd[WriteFile]

Inherited by implicit conversion StringFormat from WriteFile to StringFormat[WriteFile]

Inherited by implicit conversion Ensuring from WriteFile to Ensuring[WriteFile]

Inherited by implicit conversion ArrowAssoc from WriteFile to ArrowAssoc[WriteFile]

Ungrouped