akka.io

Class Tcp.WriteFile

java.lang.Object

akka.io.Tcp.WriteCommand

akka.io.Tcp.SimpleWriteCommand

akka.io.Tcp.WriteFile

All Implemented Interfaces:

NoSerializationVerificationNeeded, SelectionHandler.HasFailureMessage, Tcp.Command, Tcp.Message, java.io.Serializable, scala.Equals, scala.Product

Enclosing class:

Tcp

public static final class Tcp.WriteFile
extends Tcp.SimpleWriteCommand
implements scala.Product, scala.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 Tcp.CommandFailed message if the write could not be enqueued. If Tcp.SimpleWriteCommand.wantsAck() returns true, the connection actor will reply with the supplied Tcp.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.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
WriteFile(java.lang.String filePath, long position, long count, Tcp.Event ack)

Method Summary

Modifier and Type	Method and Description
Tcp.Event	ack() The acknowledgment token associated with this write command.
long	count()
java.lang.String	filePath()
long	position()

Methods inherited from class akka.io.Tcp.SimpleWriteCommand

append, wantsAck

Methods inherited from class akka.io.Tcp.WriteCommand

prepend, prepend

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface scala.Product

$init$, productArity, productElement, productIterator, productPrefix

Methods inherited from interface scala.Equals

canEqual, equals

Methods inherited from interface akka.io.Tcp.Command

failureMessage

Constructor Detail

WriteFile

public WriteFile(java.lang.String filePath,
                 long position,
                 long count,
                 Tcp.Event ack)

Method Detail

filePath

public java.lang.String filePath()

position

public long position()

count

public long count()

ack

public Tcp.Event ack()

Description copied from class: Tcp.SimpleWriteCommand

The acknowledgment token associated with this write command.

Specified by:

ack in class Tcp.SimpleWriteCommand

Returns:

(undocumented)