diff options
Diffstat (limited to 'base/src/main/java/bjc/utils/cli/Terminal.java')
| -rw-r--r-- | base/src/main/java/bjc/utils/cli/Terminal.java | 38 |
1 files changed, 37 insertions, 1 deletions
diff --git a/base/src/main/java/bjc/utils/cli/Terminal.java b/base/src/main/java/bjc/utils/cli/Terminal.java index a10d82e..e8b3029 100644 --- a/base/src/main/java/bjc/utils/cli/Terminal.java +++ b/base/src/main/java/bjc/utils/cli/Terminal.java @@ -1,6 +1,9 @@ package bjc.utils.cli; import java.util.*; +import java.util.concurrent.TimeUnit; + +import bjc.data.Either; /** * A terminal with support for asking multiple questions, and retrieving the @@ -17,6 +20,7 @@ public interface Terminal { * Submit a request to the terminal * * @param req The body of the request + * * @return The ID of the request */ long submitRequest(String req); @@ -26,15 +30,32 @@ public interface Terminal { * response is available. * * @param id The ID of the request + * * @return The response to that request + * * @throws InterruptedException If we are interrupted waiting for the reply */ String awaitReply(long id) throws InterruptedException; + + /** + * Await a reply for a given request. Will block the current thread until a + * response is available or the specified timeout occurs. + * + * @param id The ID of the request + * @param unit The unit of time to wait + * @param delay The amount of units to wait before timing out + * + * @return The response to that request, or an empty optional if it timed out + * + * @throws InterruptedException If we are interrupted waiting for the reply + */ + Optional<String> awaitReply(long id, TimeUnit unit, long delay) throws InterruptedException; /** * Check if a reply for a request is available, without blocking. * * @param id The ID of the request + * * @return The reply to the request if one is available, and empty otherwise */ Optional<String> checkReply(long id); @@ -47,5 +68,20 @@ public interface Terminal { * @return The reply to the request * @throws InterruptedException If we are interrupted waiting for the reply */ - String submitRequestSync(String req) throws InterruptedException;; + String submitRequestSync(String req) throws InterruptedException; + + /** + * Submit a request and await the reply to it. Will block the current thread + * until a response is received or the timeout occurs. + * + * @param req The request to submit + * @param unit The unit of time to wait + * @param delay The amount of units to wait before timing out + * + * @return The reply to the request, or the ID of the request if the timeout occurred + * + * @throws InterruptedException If we are interrupted waiting for the reply + */ + Either<String, Long> submitRequestSync(String req, TimeUnit unit, long delay) throws InterruptedException; + }
\ No newline at end of file |