1 /* 2 * Copyright 2018 Google LLC 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions are 6 * met: 7 * 8 * * Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * * Redistributions in binary form must reproduce the above 11 * copyright notice, this list of conditions and the following disclaimer 12 * in the documentation and/or other materials provided with the 13 * distribution. 14 * * Neither the name of Google LLC nor the names of its 15 * contributors may be used to endorse or promote products derived from 16 * this software without specific prior written permission. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 22 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 23 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 24 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 28 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29 */ 30 package com.google.api.gax.rpc; 31 32 import com.google.api.core.ApiClock; 33 import java.util.concurrent.ScheduledExecutorService; 34 import javax.annotation.Nonnull; 35 import org.threeten.bp.Duration; 36 37 public interface WatchdogProvider { needsClock()38 boolean needsClock(); 39 withClock(@onnull ApiClock clock)40 WatchdogProvider withClock(@Nonnull ApiClock clock); 41 needsCheckInterval()42 boolean needsCheckInterval(); 43 withCheckInterval(Duration checkInterval)44 WatchdogProvider withCheckInterval(Duration checkInterval); 45 needsExecutor()46 boolean needsExecutor(); 47 withExecutor(ScheduledExecutorService executor)48 WatchdogProvider withExecutor(ScheduledExecutorService executor); 49 getWatchdog()50 Watchdog getWatchdog(); 51 52 /** Return true if the watchdog should be automatically unscheduled. */ shouldAutoClose()53 boolean shouldAutoClose(); 54 } 55