Package org.apache.pekko.io
Class Tcp.Register
- java.lang.Object
-
- org.apache.pekko.io.Tcp.Register
-
- All Implemented Interfaces:
java.io.Serializable
,NoSerializationVerificationNeeded
,org.apache.pekko.io.SelectionHandler.HasFailureMessage
,Tcp.Command
,Tcp.Message
,scala.Equals
,scala.Product
- Enclosing class:
- Tcp
public static final class Tcp.Register extends java.lang.Object implements Tcp.Command, scala.Product, java.io.Serializable
This message must be sent to a TCP connection actor after receiving theTcp.Connected
message. The connection will not read any data from the socket until this message is received, because this message defines the actor which will receive all inbound data.param: handler The actor which will receive all incoming data and which will be informed when the connection is closed.
param: keepOpenOnPeerClosed If this is set to true then the connection is not automatically closed when the peer closes its half, requiring an explicit
Tcp.CloseCommand
from our side when finished.param: useResumeWriting If this is set to true then the connection actor will refuse all further writes after issuing a
Tcp.CommandFailed
notification untilResumeWriting
is received. This can be used to implement NACK-based write backpressure.- See Also:
- Serialized Form
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
canEqual(java.lang.Object x$1)
Tcp.Register
copy(ActorRef handler, boolean keepOpenOnPeerClosed, boolean useResumeWriting)
ActorRef
copy$default$1()
boolean
copy$default$2()
boolean
copy$default$3()
boolean
equals(java.lang.Object x$1)
ActorRef
handler()
int
hashCode()
boolean
keepOpenOnPeerClosed()
int
productArity()
java.lang.Object
productElement(int x$1)
java.lang.String
productElementName(int x$1)
scala.collection.Iterator<java.lang.Object>
productIterator()
java.lang.String
productPrefix()
java.lang.String
toString()
boolean
useResumeWriting()
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.pekko.io.Tcp.Command
failureMessage
-
-
-
-
Constructor Detail
-
Register
public Register(ActorRef handler, boolean keepOpenOnPeerClosed, boolean useResumeWriting)
-
-
Method Detail
-
handler
public ActorRef handler()
-
keepOpenOnPeerClosed
public boolean keepOpenOnPeerClosed()
-
useResumeWriting
public boolean useResumeWriting()
-
copy
public Tcp.Register copy(ActorRef handler, boolean keepOpenOnPeerClosed, boolean useResumeWriting)
-
copy$default$1
public ActorRef copy$default$1()
-
copy$default$2
public boolean copy$default$2()
-
copy$default$3
public boolean copy$default$3()
-
productPrefix
public java.lang.String productPrefix()
- Specified by:
productPrefix
in interfacescala.Product
-
productArity
public int productArity()
- Specified by:
productArity
in interfacescala.Product
-
productElement
public java.lang.Object productElement(int x$1)
- Specified by:
productElement
in interfacescala.Product
-
productIterator
public scala.collection.Iterator<java.lang.Object> productIterator()
- Specified by:
productIterator
in interfacescala.Product
-
canEqual
public boolean canEqual(java.lang.Object x$1)
- Specified by:
canEqual
in interfacescala.Equals
-
productElementName
public java.lang.String productElementName(int x$1)
- Specified by:
productElementName
in interfacescala.Product
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object x$1)
- Specified by:
equals
in interfacescala.Equals
- Overrides:
equals
in classjava.lang.Object
-
-