Class Tcp.Connect

The Connect message is sent to the TCP manager actor, which is obtained via Manager. Either the manager replies with a Tcp.CommandFailed or the actor handling the new connection replies with a Tcp.Connected message.

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

Constructors

| Edit this page View Source

Connect(EndPoint, EndPoint?, IEnumerable<SocketOption>?, TimeSpan?, bool)

Connect to a remote TCP endpoint.

Declaration
public Connect(EndPoint remoteAddress, EndPoint? localAddress = null, IEnumerable<Inet.SocketOption>? options = null, TimeSpan? timeout = null, bool pullMode = false)
Parameters
Type Name Description
EndPoint remoteAddress

The remote endpoint
EndPoint localAddress

An optional local endpoint address to bind to. Most users don't specify this.
IEnumerable<Inet.SocketOption> options

A set of socket options.
TimeSpan? timeout

An optional connect timeout. Will result in a Tcp.CommandFailed message being returned if we exceed this value.
bool pullMode

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

Properties

| 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
| Edit this page View Source

RemoteAddress

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

TcpSettings

Optional - allows you to specify TCP settings for the connection.

Otherwise, the system defaults will be used.

Declaration
public TcpSettings? TcpSettings { get; set; }
Property Value
Type Description
TcpSettings
Examples

var tcpSettings = TcpSettings.Create(ActorSystem); var tcpSettingsWithDifferentBufferSizes = tcpSettings with { SendBufferSize = 8192, ReceiveBufferSize = 8192 };

| Edit this page View Source

Timeout

Declaration
public TimeSpan? Timeout { get; }
Property Value
Type Description
TimeSpan?

Methods

| Edit this page View Source

ToString()

Returns a string that represents the current object.

Declaration
public override string ToString()
Returns
Type Description
string

A string that represents the current object.
Overrides

Implements

Extension Methods