1 files changed, 90 insertions, 0 deletions
diff --git a/src/main/java/com/google/devtools/build/lib/buildeventservice/client/BuildEventServiceClient.java b/src/main/java/com/google/devtools/build/lib/buildeventservice/client/BuildEventServiceClient.java
new file mode 100644
index 0000000000..6feb53c808
--- /dev/null
+++ b/src/main/java/com/google/devtools/build/lib/buildeventservice/client/BuildEventServiceClient.java
@@ -0,0 +1,90 @@
+// Copyright 2017 The Bazel Authors. All rights reserved.
+//
+// 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 com.google.devtools.build.lib.buildeventservice.client;
+
+import com.google.common.base.Function;
+import com.google.common.util.concurrent.ListenableFuture;
+import com.google.devtools.build.v1.OrderedBuildEvent;
+import com.google.devtools.build.v1.PublishBuildToolEventStreamResponse;
+import com.google.devtools.build.v1.PublishLifecycleEventRequest;
+import io.grpc.Status;
+
+/** Interface used to abstract both gRPC and Stubby BuildEventServiceBackend. */
+public interface BuildEventServiceClient {
+
+  /**
+   * Makes a synchronous RPC that publishes the specified lifecycle event.
+   *
+   * @param lifecycleEvent Event to be published.
+   * @return Status of the RPC.
+   */
+  Status publish(PublishLifecycleEventRequest lifecycleEvent) throws Exception;
+
+  /**
+   * Starts a new stream with the given ack callback. Throws an {@link IllegalStateException} if the
+   * there is already opened stream. Callers should wait on the returned Future in order to
+   * guarantee that all callback calls have been received.
+   *
+   * @param ackCallback Consumer called every time a ack message is received.
+   * @return Listenable future that blocks until the the onDone callback is called.
+   * @throws Exception
+   */
+  ListenableFuture<Status> openStream(
+      Function<PublishBuildToolEventStreamResponse, Void> ackCallback) throws Exception;
+
+  /**
+   * Sends an event to the most recently opened stream. This method may block due to flow control.
+   *
+   * @param buildEvent Event that should be sent.
+   * @throws Exception
+   */
+  void sendOverStream(OrderedBuildEvent buildEvent) throws Exception;
+
+  /**
+   * Closes the currently opened opened stream. This method does not block. Callers should block on
+   * the Future returned by {@link #openStream(Function)} in order to make sure that all
+   * ackCallback calls have been received.
+   */
+  void closeStream();
+
+  /**
+   * Closes the currently opened stream with error. This method does not block. Callers should block
+   * on the Future returned by {@link #openStream(Function)} if in order to make sure that all
+   * ackCallback calls have been received.
+   */
+  void abortStream(Status status);
+
+  /**
+   * Checks if there is a currently active stream.
+   *
+   * @return True if the current stream is active, false otherwise.
+   */
+  boolean isStreamActive();
+
+  /**
+   * Called once to dispose resources that this client might be holding (such as thread pools). This
+   * should be the last method called on this object.
+   *
+   * @throws InterruptedException
+   */
+  void shutdown() throws InterruptedException;
+
+  /**
+   * If possible, returns a user readable error message for a given {@link Throwable}.
+   *
+   * <p>As a last resort, it's valid to return {@link Throwable#getMessage()}.
+   */
+  String userReadableError(Throwable t);
+}