com.couchbase.client.core.io.netty.kv.ChannelAttributes Maven / Gradle / Ivy

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

The official Couchbase JVM Core IO Library

There is a newer version: 3.7.2

/*
 * Copyright (c) 2018 Couchbase, Inc.
 *
 * Licensed 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 com.couchbase.client.core.io.netty.kv;

import com.couchbase.client.core.deps.io.netty.util.AttributeKey;
import com.couchbase.client.core.env.SaslMechanism;

import java.util.List;
import java.util.Set;

/**
 * This class holds all kinds of channel attributes that are in used across
 * the KV channel.
 *
 * @since 2.0.0
 */
public class ChannelAttributes {

  private ChannelAttributes() {}

  /**
   * Holds the negotiated server features in a channel.
   */
  static final AttributeKey> SERVER_FEATURE_KEY =
    AttributeKey.newInstance("ServerFeatures");

  /**
   * Holds the connect timings for a channel.
   */
  static final AttributeKey CONNECT_TIMINGS_KEY =
    AttributeKey.newInstance("ConnectTimings");

  /**
   * Holds the potentially loaded error map in a channel.
   */
  static final AttributeKey ERROR_MAP_KEY =
    AttributeKey.newInstance("ErrorMap");

  /**
   * Holds the channel ID negotiated with KV engine once set.
   */
  public static final AttributeKey CHANNEL_ID_KEY =
    AttributeKey.newInstance("ChannelId");

  /**
   * Holds the SASL mechanisms the server supports.
   */
  public static final AttributeKey> SASL_MECHS_KEY =
    AttributeKey.newInstance("SaslMechs");

}