com.twitter.distributedlog.BKTransmitPacket 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 com.twitter.distributedlog;
import com.twitter.util.Await;
import com.twitter.util.Duration;
import com.twitter.util.FutureEventListener;
import com.twitter.util.Promise;
import java.util.concurrent.TimeUnit;
class BKTransmitPacket {
private final EntryBuffer recordSet;
private final long transmitTime;
private final Promise transmitComplete;
BKTransmitPacket(EntryBuffer recordSet) {
this.recordSet = recordSet;
this.transmitTime = System.nanoTime();
this.transmitComplete = new Promise();
}
EntryBuffer getRecordSet() {
return recordSet;
}
Promise getTransmitFuture() {
return transmitComplete;
}
/**
* Complete the transmit with result code transmitRc.
* It would notify all the waiters that are waiting via {@link #awaitTransmitComplete(long, TimeUnit)}
* or {@link #addTransmitCompleteListener(FutureEventListener)}.
*
* @param transmitResult
* transmit result code.
*/
public void notifyTransmitComplete(int transmitResult) {
transmitComplete.setValue(transmitResult);
}
/**
* Register a transmit complete listener.
*
The listener will be triggered with transmit result when transmit completes.
* The method should be non-blocking.
*
* @param transmitCompleteListener
* listener on transmit completion
* @see #awaitTransmitComplete(long, TimeUnit)
*/
void addTransmitCompleteListener(FutureEventListener transmitCompleteListener) {
transmitComplete.addEventListener(transmitCompleteListener);
}
/**
* Await for the transmit to be complete
*
* @param timeout
* wait timeout
* @param unit
* wait timeout unit
*/
int awaitTransmitComplete(long timeout, TimeUnit unit)
throws Exception {
return Await.result(transmitComplete,
Duration.fromTimeUnit(timeout, unit));
}
public long getTransmitTime() {
return transmitTime;
}
}