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