org.apache.activemq.broker.region.policy.SlowConsumerStrategy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of activemq-broker Show documentation

The ActiveMQ Message Broker implementation

There is a newer version: 6.1.4

/**
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.activemq.broker.region.policy;

import org.apache.activemq.broker.Broker;
import org.apache.activemq.broker.ConnectionContext;
import org.apache.activemq.broker.region.Destination;
import org.apache.activemq.broker.region.Subscription;

/**
 * Interface for a strategy for dealing with slow consumers
 */
public interface SlowConsumerStrategy {

    /**
     * Slow consumer event.
     *
     * @param context
     *      Connection context of the subscription.
     * @param subs
     *      The subscription object for the slow consumer.
     */
    void slowConsumer(ConnectionContext context, Subscription subs);

    /**
     * Sets the Broker instance which can provide a Scheduler among other things.
     *
     * @param broker
     *      The running Broker.
     */
    void setBrokerService(Broker broker);

    /**
     * For Strategies that need to examine assigned destination for slow consumers
     * periodically the destination is assigned here.
     *
     * If the strategy doesn't is event driven it can just ignore assigned destination.
     *
     * @param destination
     *      A destination to add to a watch list.
     */
    void addDestination(Destination destination);

}