Class Transport

TBD

Inheritance
Object
Transport
AbstractTransportAdapter
TestTransport
Inherited Members
Namespace: Akka.Remote.Transport
Assembly: Akka.Remote.dll
Syntax
public abstract class Transport

Properties

| Improve this Doc View Source

Config

TBD

Declaration
public Config Config { get; protected set; }
Property Value
Type Description
Config
| Improve this Doc View Source

MaximumPayloadBytes

TBD

Declaration
public virtual long MaximumPayloadBytes { get; protected set; }
Property Value
Type Description
Int64
| Improve this Doc View Source

SchemeIdentifier

TBD

Declaration
public virtual string SchemeIdentifier { get; protected set; }
Property Value
Type Description
String
| Improve this Doc View Source

System

TBD

Declaration
public ActorSystem System { get; protected set; }
Property Value
Type Description
ActorSystem

Methods

| Improve this Doc View Source

Associate(Address)

Asynchronously opens a logical duplex link between two Transport entities over a network. It could be backed with a real transport layer connection (TCP), socketless connections provided over datagram protocols (UDP), and more.

This call returns a Task of an AssociationHandle. A faulted Task indicates that the association attempt was unsuccessful. If the exception is InvalidAssociationException then the association request was invalid and it's impossible to recover.

Declaration
public abstract Task<AssociationHandle> Associate(Address remoteAddress)
Parameters
Type Name Description
Address remoteAddress

The address of the remote transport entity.
Returns
Type Description
Task<AssociationHandle>

A status representing the failure or success containing an AssociationHandle.
| Improve this Doc View Source

IsResponsibleFor(Address)

TBD

Declaration
public abstract bool IsResponsibleFor(Address remote)
Parameters
Type Name Description
Address remote

TBD
Returns
Type Description
Boolean

TBD
| Improve this Doc View Source

Listen()

TBD

Declaration
public abstract Task<(Address, TaskCompletionSource<IAssociationEventListener>)> Listen()
Returns
Type Description
Task<System.ValueTuple<Address, TaskCompletionSource<IAssociationEventListener>>>

TBD
| Improve this Doc View Source

ManagementCommand(Object)

This method allows upper layers to send management commands to the transport. It is the responsibility of the sender to send appropriate commands to different transport implementations. Unknown commands will be ignored.

Declaration
public virtual Task<bool> ManagementCommand(object message)
Parameters
Type Name Description
Object message

Command message to send to the transport.
Returns
Type Description
Task<Boolean>

A Task that succeeds when the command was handled or dropped.
| Improve this Doc View Source

Shutdown()

Shuts down the transport layer and releases all of the corresponding resources. Shutdown is asynchronous and is signaled by the result of the returned Task.

The transport SHOULD try flushing pending writes before becoming completely closed.

Declaration
public abstract Task<bool> Shutdown()
Returns
Type Description
Task<Boolean>

Task signaling the completion of the shutdown.

Extension Methods