ForwardingServerCall (grpc-api 1.29.0 API)

java.lang.Object
- io.grpc.ServerCall<ReqT,RespT>
- - io.grpc.ForwardingServerCall<ReqT,RespT>

Direct Known Subclasses:

ForwardingServerCall.SimpleForwardingServerCall
```
public abstract class ForwardingServerCall<ReqT,RespT>
extends ServerCall<ReqT,RespT>
```
A ServerCall which forwards all of it's methods to another ServerCall.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ForwardingServerCall.SimpleForwardingServerCall<ReqT,RespT>` A simplified version of `ForwardingServerCall` where subclasses can pass in a `ServerCall` as the delegate.

Nested classes/interfaces inherited from class io.grpc.ServerCall
ServerCall.Listener<ReqT>

Constructor Summary

Constructors
Constructor and Description

ForwardingServerCall()

Constructors
Constructor and Description
`ForwardingServerCall()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close(Status status, Metadata trailers)` Close the call with the provided status.
`protected abstract ServerCall<ReqT,RespT>`	`delegate()` Returns the delegated `ServerCall`.
`Attributes`	`getAttributes()` Returns properties of a single call.
`String`	`getAuthority()` Gets the authority this call is addressed to.
`boolean`	`isCancelled()` Returns `true` when the call is cancelled and the server is encouraged to abort processing to save resources, since the client will not be processing any further methods.
`boolean`	`isReady()` If `true`, indicates that the call is capable of sending additional messages without requiring excessive buffering internally.
`void`	`request(int numMessages)` Requests up to the given number of messages from the call to be delivered to `ServerCall.Listener.onMessage(Object)`.
`void`	`sendHeaders(Metadata headers)` Send response header metadata prior to sending a response message.
`void`	`sendMessage(RespT message)` Send a response message.
`void`	`setCompression(String compressor)` Sets the compression algorithm for this call.
`void`	`setMessageCompression(boolean enabled)` Enables per-message compression, if an encoding type has been negotiated.
`String`	`toString()`

Methods inherited from class io.grpc.ServerCall
getMethodDescriptor

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ForwardingServerCall
```
public ForwardingServerCall()
```
- Method Detail
  - delegate
```
protected abstract ServerCall<ReqT,RespT> delegate()
```
    Returns the delegated ServerCall.
  - sendMessage
```
public void sendMessage(RespT message)
```
    Description copied from class: ServerCall
    
    Send a response message. Messages are the primary form of communication associated with RPCs. Multiple response messages may exist for streaming calls.
    
    Specified by:
    
    sendMessage in class ServerCall<ReqT,RespT>
    
    Parameters:
    
    message - response message.
  - request
```
public void request(int numMessages)
```
    Description copied from class: ServerCall
    
    Requests up to the given number of messages from the call to be delivered to ServerCall.Listener.onMessage(Object). Once numMessages have been delivered no further request messages will be delivered until more messages are requested by calling this method again.
    Servers use this mechanism to provide back-pressure to the client for flow-control.
    This method is safe to call from multiple threads without external synchronization.
    
    Specified by:
    
    request in class ServerCall<ReqT,RespT>
    
    Parameters:
    
    numMessages - the requested number of messages to be delivered to the listener.
  - sendHeaders
```
public void sendHeaders(Metadata headers)
```
    Description copied from class: ServerCall
    
    Send response header metadata prior to sending a response message. This method may only be called once and cannot be called after calls to ServerCall.sendMessage(RespT) or ServerCall.close(io.grpc.Status, io.grpc.Metadata).
    Since Metadata is not thread-safe, the caller must not access (read or write) headers after this point.
    
    Specified by:
    
    sendHeaders in class ServerCall<ReqT,RespT>
    
    Parameters:
    
    headers - metadata to send prior to any response body.
  - isReady
```
public boolean isReady()
```
    Description copied from class: ServerCall
    
    If true, indicates that the call is capable of sending additional messages without requiring excessive buffering internally. This event is just a suggestion and the application is free to ignore it, however doing so may result in excessive buffering within the call.
    If false, ServerCall.Listener.onReady() will be called after isReady() transitions to true.
    This abstract class's implementation always returns true. Implementations generally override the method.
    
    Overrides:
    
    isReady in class ServerCall<ReqT,RespT>
  - close
```
public void close(Status status,
                  Metadata trailers)
```
    Description copied from class: ServerCall
    
    Close the call with the provided status. No further sending or receiving will occur. If Status.isOk() is false, then the call is said to have failed.
    If no errors or cancellations are known to have occurred, then a ServerCall.Listener.onComplete() notification should be expected, independent of status. Otherwise ServerCall.Listener.onCancel() has been or will be called.
    Since Metadata is not thread-safe, the caller must not access (read or write) trailers after this point.
    
    Specified by:
    
    close in class ServerCall<ReqT,RespT>
  - isCancelled
```
public boolean isCancelled()
```
    Description copied from class: ServerCall
    
    Returns true when the call is cancelled and the server is encouraged to abort processing to save resources, since the client will not be processing any further methods. Cancellations can be caused by timeouts, explicit cancel by client, network errors, and similar.
    This method may safely be called concurrently from multiple threads.
    
    Specified by:
    
    isCancelled in class ServerCall<ReqT,RespT>
  - setMessageCompression
```
@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/1703")
public void setMessageCompression(boolean enabled)
```
    Description copied from class: ServerCall
    
    Enables per-message compression, if an encoding type has been negotiated. If no message encoding has been negotiated, this is a no-op. By default per-message compression is enabled, but may not have any effect if compression is not enabled on the call.
    
    Overrides:
    
    setMessageCompression in class ServerCall<ReqT,RespT>
  - setCompression
```
@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/1704")
public void setCompression(String compressor)
```
    Description copied from class: ServerCall
    
    Sets the compression algorithm for this call. If the server does not support the compression algorithm, the call will fail. This method may only be called before ServerCall.sendHeaders(io.grpc.Metadata). The compressor to use will be looked up in the CompressorRegistry. Default gRPC servers support the "gzip" compressor.
    It is safe to call this even if the client does not support the compression format chosen. The implementation will handle negotiation with the client and may fall back to no compression.
    
    Overrides:
    
    setCompression in class ServerCall<ReqT,RespT>
    
    Parameters:
    
    compressor - the name of the compressor to use.
  - getAttributes
```
@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/1779")
public Attributes getAttributes()
```
    Description copied from class: ServerCall
    
    Returns properties of a single call.
    Attributes originate from the transport and can be altered by ServerTransportFilter.
    
    Overrides:
    
    getAttributes in class ServerCall<ReqT,RespT>
    
    Returns:
    
    non-null Attributes container
  - getAuthority
```
public String getAuthority()
```
    Description copied from class: ServerCall
    
    Gets the authority this call is addressed to.
    
    Overrides:
    
    getAuthority in class ServerCall<ReqT,RespT>
    
    Returns:
    
    the authority string. null if not available.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ForwardingServerCall<ReqT,RespT>

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.ServerCall

Constructor Summary

Method Summary

Methods inherited from class io.grpc.ServerCall

Methods inherited from class java.lang.Object

Constructor Detail

ForwardingServerCall

Method Detail

delegate

sendMessage

request

sendHeaders

isReady

close

isCancelled

setMessageCompression

setCompression

getAttributes

getAuthority

toString