Show / Hide Table of Contents

    Interface ICommunicationListener

    Defines the base interface and the state machine contract for a communication listener for a Copper Service.

    Namespace: Copper.ServiceFabric.Services.Communication.Runtime
    Assembly: Copper.Fabric.dll
    Syntax
    public interface ICommunicationListener

    Methods

    View Source

    Abort()

    This method causes the communication listener to close. Close is a terminal state and this method causes the transition to close ungracefully. Any outstanding operations (including close) should be canceled when this method is called.

    Declaration
    void Abort()
    View Source

    CloseAsync(CancellationToken)

    This method causes the communication listener to close. Close is a terminal state and this method allows the communication listener to transition to this state in a graceful manner.

    Declaration
    Task CloseAsync(CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.Threading.CancellationToken cancellationToken

    The cancellation token.

    Returns
    Type Description
    System.Threading.Tasks.Task

    A System.Threading.Tasks.Task that represents outstanding operation.

    View Source

    OpenAsync(CancellationToken)

    This method causes the communication listener to be opened. Once the Open completes, the communication listener becomes usable - accepts and sends messages.

    Declaration
    Task<string> OpenAsync(CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.Threading.CancellationToken cancellationToken

    The cancellation token.

    Returns
    Type Description
    System.Threading.Tasks.Task<System.String>

    A System.Threading.Tasks.Task that represents outstanding operation. The result of the Task is the endpoint string.

    • View Source
    Back to top Generated by DocFX