akka.io

Class Tcp.Bind

java.lang.Object

akka.io.Tcp.Bind

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.Bind
extends java.lang.Object
implements Tcp.Command, scala.Product, scala.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 and Description
Bind(ActorRef handler, java.net.InetSocketAddress localAddress, int backlog, scala.collection.immutable.Traversable<Inet.SocketOption> options, boolean pullMode)

Method Summary

Modifier and Type	Method and Description
int	backlog()
ActorRef	handler()
java.net.InetSocketAddress	localAddress()
scala.collection.immutable.Traversable<Inet.SocketOption>	options()
boolean	pullMode()

Methods inherited from class java.lang.Object

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

Methods inherited from interface akka.io.Tcp.Command

failureMessage

Methods inherited from interface scala.Product

$init$, productArity, productElement, productIterator, productPrefix

Methods inherited from interface scala.Equals

canEqual, equals

Constructor Detail

Bind

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

Method Detail

handler

public ActorRef handler()

localAddress

public java.net.InetSocketAddress localAddress()

backlog

public int backlog()

options

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

pullMode

public boolean pullMode()