Package io.servicetalk.transport.api

Interface ConnectionObserver.WriteObserver

All Known Implementing Classes:
NoopTransportObserver.NoopWriteObserver
Enclosing interface:
ConnectionObserver
public static interface ConnectionObserver.WriteObserver
An observer interface that provides visibility into write events.

Either writeComplete() or writeFailed(Throwable) will be invoked to signal when a write operation terminates. writeCancelled() is also a terminal signal for the write operation, however it may be invoked concurrently with writeComplete() or writeFailed(Throwable).

  • Method Details

    • requestedToWrite

      void requestedToWrite(long n)
      Callback when new items are requested to write.
      Parameters:
      n - number of requested items to write

    • itemReceived

      @Deprecated default void itemReceived()
      Deprecated.
      Use {itemReceived(Object)}
      Callback when an item is received and ready to be written.

      Content of the received items should be inspected at the higher level API when these items are produced.

    • itemReceived

      void itemReceived(@Nullable Object item)
      Callback when an item is received and ready to be written.
      Parameters:
      item - received item

    • onFlushRequest

      void onFlushRequest()
      Callback when flush operation is requested.

    • itemWritten

      @Deprecated default void itemWritten()
      Deprecated.
      Use itemWritten(Object)
      Callback when an item is written to the transport.

      Content of the written items should be inspected at the higher level API when these items are produced.

    • itemWritten

      void itemWritten(@Nullable Object item)
      Callback when an item is serialized and written to the socket.
      Parameters:
      item - written item

    • itemFlushed

      void itemFlushed()
      Callback when an item is flushed to the network. Items are flushed in order they have been written.

    • writeFailed

      void writeFailed(Throwable cause)
      Callback when the write operation fails with an error.
      Parameters:
      cause - Throwable that terminated the write

    • writeComplete

      void writeComplete()
      Callback when the entire write operation completes successfully.

    • writeCancelled

      void writeCancelled()
      Callback when the write operation is cancelled.