Package org.apache.pekko.io

Class Tcp.Bind

java.lang.Object

org.apache.pekko.io.Tcp.Bind

All Implemented Interfaces:

Serializable, NoSerializationVerificationNeeded, org.apache.pekko.io.SelectionHandler.HasFailureMessage, Tcp.Command, Tcp.Message, scala.Equals, scala.Product

Enclosing class:

Tcp

public static final class Tcp.Bind
extends Object
implements Tcp.Command, scala.Product, Serializable

The Bind message is send to the TCP manager actor, which is obtained via TcpExt.manager() in order to bind to a listening socket. The manager replies either with a Tcp.CommandFailed or the actor handling the listen socket replies with a Tcp.Bound message. If the local port is set to 0 in the Bind message, then the Tcp.Bound message should be inspected to find the actual port which was bound to.

param: handler The actor which will receive all incoming connection requests in the form of Tcp.Connected messages.

param: localAddress The socket address to bind to; use port zero for automatic assignment (i.e. an ephemeral port, see Tcp.Bound)

param: backlog This specifies the number of unaccepted connections the O/S kernel will hold for this port before refusing connections.

param: options Please refer to the Tcp.SO object for a list of all supported options.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Bind(ActorRef handler, InetSocketAddress localAddress, int backlog, scala.collection.immutable.Iterable<Inet.SocketOption> options, boolean pullMode)

Method Summary

Modifier and Type	Method	Description
int	backlog()
boolean	canEqual(Object x$1)
Tcp.Bind	copy(ActorRef handler, InetSocketAddress localAddress, int backlog, scala.collection.immutable.Iterable<Inet.SocketOption> options, boolean pullMode)
ActorRef	copy$default$1()
InetSocketAddress	copy$default$2()
int	copy$default$3()
scala.collection.immutable.Iterable<Inet.SocketOption>	copy$default$4()
boolean	copy$default$5()
boolean	equals(Object x$1)
ActorRef	handler()
int	hashCode()
InetSocketAddress	localAddress()
scala.collection.immutable.Iterable<Inet.SocketOption>	options()
int	productArity()
Object	productElement(int x$1)
String	productElementName(int x$1)
scala.collection.Iterator<Object>	productIterator()
String	productPrefix()
boolean	pullMode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface scala.Product

productElementNames

Methods inherited from interface org.apache.pekko.io.Tcp.Command

failureMessage

Constructor Details

Bind

public Bind(ActorRef handler,
 InetSocketAddress localAddress,
 int backlog,
 scala.collection.immutable.Iterable<Inet.SocketOption> options,
 boolean pullMode)

Method Details

handler

public ActorRef handler()

localAddress

public InetSocketAddress localAddress()

backlog

public int backlog()

options

public scala.collection.immutable.Iterable<Inet.SocketOption> options()

pullMode

public boolean pullMode()

copy

public Tcp.Bind copy(ActorRef handler,
 InetSocketAddress localAddress,
 int backlog,
 scala.collection.immutable.Iterable<Inet.SocketOption> options,
 boolean pullMode)

copy$default$1

public ActorRef copy$default$1()

copy$default$2

public InetSocketAddress copy$default$2()

copy$default$3

public int copy$default$3()

copy$default$4

public scala.collection.immutable.Iterable<Inet.SocketOption> copy$default$4()

copy$default$5

public boolean copy$default$5()

productPrefix

public String productPrefix()

Specified by:

productPrefix in interface scala.Product

productArity

public int productArity()

Specified by:

productArity in interface scala.Product

productElement

public Object productElement(int x$1)

Specified by:

productElement in interface scala.Product

productIterator

public scala.collection.Iterator<Object> productIterator()

Specified by:

productIterator in interface scala.Product

canEqual

public boolean canEqual(Object x$1)

Specified by:

canEqual in interface scala.Equals

productElementName

public String productElementName(int x$1)

Specified by:

productElementName in interface scala.Product

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object x$1)

Specified by:

equals in interface scala.Equals

Overrides:

equals in class Object