org.apache.pulsar.client.api.SubscriptionType Maven / Gradle / Ivy
/**
* 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.pulsar.client.api;
import org.apache.pulsar.common.classification.InterfaceAudience;
import org.apache.pulsar.common.classification.InterfaceStability;
/**
* Types of subscription supported by Pulsar.
*/
@InterfaceAudience.Public
@InterfaceStability.Stable
public enum SubscriptionType {
/**
* There can be only 1 consumer on the same topic with the same subscription name.
*/
Exclusive,
/**
* Multiple consumer will be able to use the same subscription name and the messages will be dispatched
* according to a round-robin rotation between the connected consumers.
*
* In this mode, the consumption order is not guaranteed.
*/
Shared,
/**
* Multiple consumer will be able to use the same subscription name but only 1 consumer will receive the messages.
* If that consumer disconnects, one of the other connected consumers will start receiving messages.
*
*
In failover mode, the consumption ordering is guaranteed.
*
*
In case of partitioned topics, the ordering is guaranteed on a per-partition basis.
* The partitions assignments will be split across the available consumers. On each partition,
* at most one consumer will be active at a given point in time.
*/
Failover,
/**
* Multiple consumer will be able to use the same subscription and all messages with the same key
* will be dispatched to only one consumer.
*
*
Use ordering_key to overwrite the message key for message ordering.
*/
Key_Shared
}