com.azure.core.amqp.AmqpLink Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of azure-core-amqp Show documentation

This package contains core types for Azure Java AMQP clients.

The newest version!

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

package com.azure.core.amqp;

import com.azure.core.amqp.exception.AmqpException;
import com.azure.core.util.AsyncCloseable;
import reactor.core.Disposable;
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;

/**
 * Represents a unidirectional AMQP link.
 */
public interface AmqpLink extends Disposable, AsyncCloseable {

    /**
     * Gets the name of the link.
     *
     * @return The name of the link.
     */
    String getLinkName();

    /**
     * The remote endpoint path this link is connected to.
     *
     * @return The remote endpoint path this link is connected to.
     */
    String getEntityPath();

    /**
     * The host name of the message broker that this link that is connected to.
     *
     * @return The host name of the message broker that this link that is connected to.
     */
    String getHostname();

    /**
     * Gets the endpoint states for the AMQP link. {@link AmqpException AmqpExceptions} that occur on the link are
     * reported in the connection state. When the stream terminates, the link is closed.
     *
     * @return A stream of endpoint states for the AMQP link.
     */
    Flux getEndpointStates();

    /**
     * Disposes of the AMQP link.
     *
     * @return A mono that completes when the link is disposed.
     */
    default Mono closeAsync() {
        return Mono.fromRunnable(() -> dispose());
    }
}