org.bitcoinj.net.AbstractTimeoutHandler Maven / Gradle / Ivy
/*
* Copyright 2013 Google 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 org.bitcoinj.net;
import java.time.Duration;
/**
* A base class which provides basic support for socket timeouts. It is used instead of integrating timeouts into the
* NIO select thread both for simplicity and to keep code shared between NIO and blocking sockets as much as possible.
*
* @deprecated Don't extend this class, implement {@link TimeoutHandler} using {@link SocketTimeoutTask} instead
*/
@Deprecated
public abstract class AbstractTimeoutHandler implements TimeoutHandler {
private final SocketTimeoutTask timeoutTask;
public AbstractTimeoutHandler() {
timeoutTask = new SocketTimeoutTask(this::timeoutOccurred);
}
/**
*
Enables or disables the timeout entirely. This may be useful if you want to store the timeout value but wish
* to temporarily disable/enable timeouts.
*
* The default is for timeoutEnabled to be true but timeout to be set to {@link Duration#ZERO} (ie disabled).
*
* This call will reset the current progress towards the timeout.
*/
@Override
public synchronized final void setTimeoutEnabled(boolean timeoutEnabled) {
timeoutTask.setTimeoutEnabled(timeoutEnabled);
}
/**
* Sets the receive timeout, automatically killing the connection if no
* messages are received for this long
*
* A timeout of 0{@link Duration#ZERO} is interpreted as no timeout.
*
* The default is for timeoutEnabled to be true but timeout to be set to {@link Duration#ZERO} (ie disabled).
*
* This call will reset the current progress towards the timeout.
*/
@Override
public synchronized final void setSocketTimeout(Duration timeout) {
timeoutTask.setSocketTimeout(timeout);
}
/**
* Resets the current progress towards timeout to 0.
*/
protected synchronized void resetTimeout() {
timeoutTask.resetTimeout();
}
protected abstract void timeoutOccurred();
}