Class TcpSettings

TBD

Inheritance
object
TcpSettings
Inherited Members
Namespace: Akka.IO
Assembly: Akka.dll
Syntax
public class TcpSettings

Constructors

| Edit this page View Source

TcpSettings(string, int, bool, int, TimeSpan?, int, string, string, int, int, bool, int)

Declaration
public TcpSettings(string bufferPoolConfigPath, int initialSocketAsyncEventArgs, bool traceLogging, int batchAcceptLimit, TimeSpan? registerTimeout, int receivedMessageSizeLimit, string managementDispatcher, string fileIoDispatcher, int transferToLimit, int finishConnectRetries, bool outgoingSocketForceIpv4, int writeCommandsQueueMaxSize)
Parameters
Type Name Description
string bufferPoolConfigPath
int initialSocketAsyncEventArgs
bool traceLogging
int batchAcceptLimit
TimeSpan? registerTimeout
int receivedMessageSizeLimit
string managementDispatcher
string fileIoDispatcher
int transferToLimit
int finishConnectRetries
bool outgoingSocketForceIpv4
int writeCommandsQueueMaxSize

Properties

| Edit this page View Source

BatchAcceptLimit

The maximum number of connection that are accepted in one go, higher numbers decrease latency, lower numbers increase fairness on the worker-dispatcher

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

BufferPoolConfigPath

A config path to the section defining which byte buffer pool to use. Buffer pools are used to mitigate GC-pressure made by potential allocation and deallocation of byte buffers used for writing/receiving data from sockets.

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

FileIODispatcher

Fully qualified config path which holds the dispatcher configuration on which file IO tasks are scheduled

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

FinishConnectRetries

The number of times to retry the finishConnect call after being notified about OP_CONNECT. Retries are needed if the OP_CONNECT notification doesn't imply that finishConnect will succeed, which is the case on Android.

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

InitialSocketAsyncEventArgs

The initial number of SocketAsyncEventArgs to be preallocated. This value will grow infinitely if needed.

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

ManagementDispatcher

Fully qualified config path which holds the dispatcher configuration for the selector management actors

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

OutgoingSocketForceIpv4

Enforce outgoing socket connection to use IPv4 address family. Required in scenario when IPv6 is not available, for example in Azure Web App sandbox. When set to true it is required to set akka.io.dns.inet-address.use-ipv6 to false in cases when DnsEndPoint is used to describe the remote address

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

ReceivedMessageSizeLimit

The maximum number of bytes delivered by a Received message. Before more data is read from the network the connection actor will try to do other work. The purpose of this setting is to impose a smaller limit than the configured receive buffer size. When using value 'unlimited' it will try to read all from the receive buffer.

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

RegisterTimeout

The duration a connection actor waits for a Register message from its commander before aborting the connection.

Declaration
public TimeSpan? RegisterTimeout { get; }
Property Value
Type Description
TimeSpan?
| Edit this page View Source

TraceLogging

Enable fine grained logging of what goes on inside the implementation. Be aware that this may log more than once per message sent to the actors of the tcp implementation.

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

TransferToLimit

The maximum number of bytes (or "unlimited") to transfer in one batch when using WriteFile command which uses FileChannel.transferTo to pipe files to a TCP socket. On some OS like Linux FileChannel.transferTo may block for a long time when network IO is faster than file IO. Decreasing the value may improve fairness while increasing may improve throughput.

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

WriteCommandsQueueMaxSize

Limits maximum size of internal queue, used in Akka.IO.TcpIncomingConnection connection actor to store pending write commands. To allow unlimited size, set to -1.

Declaration
public int WriteCommandsQueueMaxSize { get; }
Property Value
Type Description
int

Methods

| Edit this page View Source

Create(ActorSystem)

Creates a new instance of TcpSettings class and fills it with values parsed from akka.io.tcp HOCON path found in actor system.

Declaration
public static TcpSettings Create(ActorSystem system)
Parameters
Type Name Description
ActorSystem system
Returns
Type Description
TcpSettings
| Edit this page View Source

Create(Config)

Creates a new instance of TcpSettings class and fills it with values parsed from provided HOCON config.

Declaration
public static TcpSettings Create(Config config)
Parameters
Type Name Description
Config config

TBD
Returns
Type Description
TcpSettings

Extension Methods