Share via

AmqpShutdownSignal Class

Package:
com.azure.core.amqp
Maven Artifact:
com.azure:azure-core-amqp:2.11.2
  • java.lang.Object
    • com.azure.core.amqp.AmqpShutdownSignal

public class AmqpShutdownSignal

Represents a signal that caused the AMQP connection to shutdown.

Constructor Summary

Constructor Description
AmqpShutdownSignal(boolean isTransient, boolean isInitiatedByClient, String message)

Creates a new instance of the AmqpShutdownSignal.

Method Summary

Modifier and Type Method and Description
boolean isInitiatedByClient()

Gets whether or not this shutdown signal was initiated by the client.
boolean isTransient()

Gets whether or not this shutdown signal is transient or if it can be restarted.
String toString()

Returns String representing the message of this AmqpShutdownSignal signal.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

AmqpShutdownSignal

public AmqpShutdownSignal(boolean isTransient, boolean isInitiatedByClient, String message)

Creates a new instance of the AmqpShutdownSignal.

Parameters:

isTransient - Whether the shutdown signal can be retried or not.
isInitiatedByClient - true if the shutdown was initiated by the client; false otherwise.
message - Message associated with the shutdown.

Method Details

isInitiatedByClient

public boolean isInitiatedByClient()

Gets whether or not this shutdown signal was initiated by the client.

Returns:

true if the shutdown signal was initiated by the client, false if the shutdown signal occurred in the underlying AMQP layer or from the AMQP message broker.

isTransient

public boolean isTransient()

Gets whether or not this shutdown signal is transient or if it can be restarted.

Returns:

true if the shutdown signal is transient and the connection, session, or link can be recreated. false otherwise.

toString

public String toString()

Returns String representing the message of this AmqpShutdownSignal signal. To write logs, please use com.azure.core.amqp.implementation.AmqpLoggingUtils#addShutdownSignal(LoggingEventBuilder, AmqpShutdownSignal).

Overrides:

AmqpShutdownSignal.toString()

Applies to