flasn4nt
/
grpc-java
mirror of https://github.com/grpc/grpc-java.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Make thread-safety ownership of Metadata explicit

This commit is contained in:
Eric Anderson 2016-02-11 10:57:51 -08:00
parent 48b30291ee
commit ad301c7e4d
2 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
core/src/main/java/io/grpc/ClientCall.java
View File

@ -124,7 +124,8 @@ public abstract class ClientCall<ReqT, RespT> {
/** /**
* Start a call, using {@code responseListener} for processing response messages. * Start a call, using {@code responseListener} for processing response messages.
* *
* <p>It must be called prior to any other method on this class. * <p>It must be called prior to any other method on this class. Since {@link Metadata} is not
* thread-safe, the caller must not access {@code headers} after this point.
* *
* @param responseListener receives response messages * @param responseListener receives response messages
* @param headers which can contain extra call metadata, e.g. authentication credentials. * @param headers which can contain extra call metadata, e.g. authentication credentials.

6
core/src/main/java/io/grpc/ServerCall.java
View File

@ -119,6 +119,9 @@ public abstract class ServerCall<RespT> {
* Send response header metadata prior to sending a response message. This method may * Send response header metadata prior to sending a response message. This method may
* only be called once and cannot be called after calls to {@link #sendMessage} or {@link #close}. * only be called once and cannot be called after calls to {@link #sendMessage} or {@link #close}.
* *
* <p>Since {@link Metadata} is not thread-safe, the caller must not access {@code headers} after
* this point.
*
* @param headers metadata to send prior to any response body. * @param headers metadata to send prior to any response body.
* @throws IllegalStateException if {@code close} has been called, a message has been sent, or * @throws IllegalStateException if {@code close} has been called, a message has been sent, or
* headers have already been sent * headers have already been sent
@ -154,6 +157,9 @@ public abstract class ServerCall<RespT> {
* notification should be expected, independent of {@code status}. Otherwise {@link * notification should be expected, independent of {@code status}. Otherwise {@link
* Listener#onCancel} has been or will be called. * Listener#onCancel} has been or will be called.
* *
* <p>Since {@link Metadata} is not thread-safe, the caller must not access {@code trailers} after
* this point.
*
* @throws IllegalStateException if call is already {@code close}d * @throws IllegalStateException if call is already {@code close}d
*/ */
public abstract void close(Status status, Metadata trailers); public abstract void close(Status status, Metadata trailers);