diff options
author | zpencer <spencerfang@google.com> | 2018-07-12 12:57:10 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2018-07-12 12:57:10 -0700 |
commit | 3181fbcf03bb6d3c16600002d631633fb1819ccb (patch) | |
tree | 13be130956a64486ba82856d9edf4b7700ac91a1 /services | |
parent | 7bb88de26447f2a27c9fb9bed7a3193426a48715 (diff) | |
download | grpc-grpc-java-3181fbcf03bb6d3c16600002d631633fb1819ccb.tar.gz |
services: add javadocs for binlog constructors (#4637)
Diffstat (limited to 'services')
-rw-r--r-- | services/src/main/java/io/grpc/services/BinaryLogs.java | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/services/src/main/java/io/grpc/services/BinaryLogs.java b/services/src/main/java/io/grpc/services/BinaryLogs.java index 310ec3cf9..afe3f2462 100644 --- a/services/src/main/java/io/grpc/services/BinaryLogs.java +++ b/services/src/main/java/io/grpc/services/BinaryLogs.java @@ -22,18 +22,32 @@ import java.io.IOException; @ExperimentalApi("https://github.com/grpc/grpc-java/issues/4017") public final class BinaryLogs { + /** + * Creates a binary log that writes to a temp file. <b>Warning:</b> this implementation is + * not performance optimized, and RPCs will experience back pressure if disk IO does not keep + * up. + */ public static BinaryLog createBinaryLog() throws IOException { return new BinaryLogProviderImpl(); } + /** + * Creates a binary log with a custom {@link BinaryLogSink} for receiving the logged data. + */ public static BinaryLog createBinaryLog(BinaryLogSink sink) throws IOException { return new BinaryLogProviderImpl(sink); } + /** + * Same as {@link #createBinaryLog()} except the call IDs are derived from census. + */ public static BinaryLog createCensusBinaryLog() throws IOException { return new CensusBinaryLogProvider(); } + /** + * Same as {@link #createBinaryLog(BinaryLogSink)} except the call IDs are derived from census. + */ public static BinaryLog createCensusBinaryLog(BinaryLogSink sink) throws IOException { return new CensusBinaryLogProvider(sink); } |