001/*
002 *
003 * Licensed to the Apache Software Foundation (ASF) under one
004 * or more contributor license agreements.  See the NOTICE file
005 * distributed with this work for additional information
006 * regarding copyright ownership.  The ASF licenses this file
007 * to you under the Apache License, Version 2.0 (the
008 * "License"); you may not use this file except in compliance
009 * with the License.  You may obtain a copy of the License at
010 *
011 *     http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing, software
014 * distributed under the License is distributed on an "AS IS" BASIS,
015 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
016 * See the License for the specific language governing permissions and
017 * limitations under the License.
018 */
019
020package org.apache.hadoop.hbase.namequeues;
021
022import org.apache.hadoop.hbase.ipc.RpcCall;
023import org.apache.yetus.audience.InterfaceAudience;
024
025
026/**
027 * An envelope to carry payload in the ring buffer that serves as online buffer
028 * to provide latest events
029 */
030@InterfaceAudience.Private
031final class RingBufferEnvelope {
032
033  private NamedQueuePayload namedQueuePayload;
034
035  /**
036   * Load the Envelope with {@link RpcCall}
037   *
038   * @param namedQueuePayload all details of rpc call that would be useful for ring buffer
039   *   consumers
040   */
041  public void load(NamedQueuePayload namedQueuePayload) {
042    this.namedQueuePayload = namedQueuePayload;
043  }
044
045  /**
046   * Retrieve current namedQueue payload {@link NamedQueuePayload} available on Envelope and
047   * free up the Envelope
048   *
049   * @return Retrieve rpc log details
050   */
051  public NamedQueuePayload getPayload() {
052    final NamedQueuePayload namedQueuePayload = this.namedQueuePayload;
053    this.namedQueuePayload = null;
054    return namedQueuePayload;
055  }
056
057}