Package io.grpc.stub

Class ServerCalls.NoopStreamObserver<V>

  • All Implemented Interfaces:
    StreamObserver<V>
    Enclosing class:
    ServerCalls

    static class ServerCalls.NoopStreamObserver<V>
    extends java.lang.Object
    implements StreamObserver<V>
    No-op implementation of StreamObserver. Used in abstract stubs for default implementations of methods which throws UNIMPLEMENTED error and tests.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void onCompleted()
      Receives a notification of successful stream completion.
      void onError​(java.lang.Throwable t)
      Receives a terminating error from the stream.
      void onNext​(V value)
      Receives a value from the stream.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • NoopStreamObserver

        NoopStreamObserver()
    • Method Detail

      • onNext

        public void onNext​(V value)
        Description copied from interface: StreamObserver
        Receives a value from the stream.

        Can be called many times but is never called after StreamObserver.onError(Throwable) or StreamObserver.onCompleted() are called.

        Unary calls must invoke onNext at most once. Clients may invoke onNext at most once for server streaming calls, but may receive many onNext callbacks. Servers may invoke onNext at most once for client streaming calls, but may receive many onNext callbacks.

        If an exception is thrown by an implementation the caller is expected to terminate the stream by calling StreamObserver.onError(Throwable) with the caught exception prior to propagating it.

        Specified by:
        onNext in interface StreamObserver<V>
        Parameters:
        value - the value passed to the stream
      • onCompleted

        public void onCompleted()
        Description copied from interface: StreamObserver
        Receives a notification of successful stream completion.

        May only be called once and if called it must be the last method called. In particular if an exception is thrown by an implementation of onCompleted no further calls to any method are allowed.

        Specified by:
        onCompleted in interface StreamObserver<V>