Class Tcp.Bind

The Bind message is send to the TCP manager actor, which is obtained via 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.

Inheritance
object
Tcp.Message
Tcp.Command
Tcp.Bind
Implements
Inherited Members
Namespace: Akka.IO
Assembly: Akka.dll
Syntax
public class Tcp.Bind : Tcp.Command, INoSerializationVerificationNeeded

Constructors

| Edit this page View Source

Bind(IActorRef, EndPoint, int, IEnumerable<SocketOption>, bool)

Bind a TCP listener to a local endpoint.

Declaration
public Bind(IActorRef handler, EndPoint localAddress, int backlog = 1024, IEnumerable<Inet.SocketOption> options = null, bool pullMode = false)
Parameters
Type Name Description
IActorRef handler

The actor who will be handling the TCP listener.
EndPoint localAddress

The local endpoint we are binding to.
int backlog

TCP backlog - the number of pending connections that the queue will hold. Defaults to 1024.
IEnumerable<Inet.SocketOption> options

A set of socket options.
bool pullMode

Specifies whether we're running in "pull mode" or not.

Properties

| Edit this page View Source

Backlog

Declaration
public int Backlog { get; }
Property Value
Type Description
int
| Edit this page View Source

Handler

Declaration
public IActorRef Handler { get; }
Property Value
Type Description
IActorRef
| Edit this page View Source

LocalAddress

Declaration
public EndPoint LocalAddress { get; }
Property Value
Type Description
EndPoint
| Edit this page View Source

Options

Declaration
public IEnumerable<Inet.SocketOption> Options { get; }
Property Value
Type Description
IEnumerable<Inet.SocketOption>
| Edit this page View Source

PullMode

Declaration
public bool PullMode { get; }
Property Value
Type Description
bool

Methods

| Edit this page View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides

Implements

Extension Methods