Search Results for

    Show / Hide Table of Contents

    Class Transport

    TBD

    Inheritance
    object
    Transport
    AbstractTransportAdapter
    TestTransport
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Akka.Remote.Transport
    Assembly: Akka.Remote.dll
    Syntax
    public abstract class Transport

    Properties

    | Edit this page View Source

    Config

    TBD

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

    MaximumPayloadBytes

    TBD

    Declaration
    public virtual long MaximumPayloadBytes { get; protected set; }
    Property Value
    Type Description
    long
    | Edit this page View Source

    SchemeIdentifier

    TBD

    Declaration
    public virtual string SchemeIdentifier { get; protected set; }
    Property Value
    Type Description
    string
    | Edit this page View Source

    System

    TBD

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

    Methods

    | Edit this page 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.

    | Edit this page View Source

    IsResponsibleFor(Address)

    TBD

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

    TBD

    Returns
    Type Description
    bool

    TBD

    | Edit this page View Source

    Listen()

    TBD

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

    TBD

    | Edit this page 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<bool>

    A Task that succeeds when the command was handled or dropped.

    | Edit this page 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<bool>

    Task signaling the completion of the shutdown.

    Extension Methods

    ObjectExtensions.IsDefaultForType<T>(T)
    ObjectExtensions.AsOption<T>(T)
    Extensions.AsInstanceOf<T>(object)
    In this article
    • githubEdit this page
    • View Source
    Back to top
    Contribute
    • Project Chat
    • Discussion Forum
    • Source Code
    Support
    • Akka.NET Support Plans
    • Akka.NET Observability Tools
    • Akka.NET Training & Consulting
    Maintained By
    • Petabridge - The Akka.NET Company
    • Learn Akka.NET