Interface FederationConsumerInternal
-
- All Superinterfaces:
FederationConsumer
- All Known Implementing Classes:
AMQPFederationAddressConsumer,AMQPFederationQueueConsumer
public interface FederationConsumerInternal extends FederationConsumer
Internal federated consumer API that is subject to change without notice.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidclose()Close the federation consumer instance and cleans up its resources.FederationConsumerInternalsetRemoteClosedHandler(Consumer<FederationConsumerInternal> handler)Provides and event point for notification of the consumer having been closed by the remote.voidstart()Starts the consumer instance which includes creating the remote resources and performing any internal initialization needed to fully establish the consumer instance.-
Methods inherited from interface org.apache.activemq.artemis.protocol.amqp.federation.FederationConsumer
getConsumerInfo, getFederation
-
-
-
-
Method Detail
-
start
void start()
Starts the consumer instance which includes creating the remote resources and performing any internal initialization needed to fully establish the consumer instance. This call should not block and any errors encountered on creation of the backing consumer resources should utilize the error handling mechanisms of thisFederationinstance.
-
close
void close()
Close the federation consumer instance and cleans up its resources. This method should not block and the actual resource shutdown work should occur asynchronously.
-
setRemoteClosedHandler
FederationConsumerInternal setRemoteClosedHandler(Consumer<FederationConsumerInternal> handler)
Provides and event point for notification of the consumer having been closed by the remote.- Parameters:
handler- The handler that will be invoked when the remote closes this consumer.- Returns:
- this consumer instance.
-
-