com.google.cloud.bigtable.gaxx.reframing

Interface Reframer<OuterT,InnerT>

Type Parameters:

InnerT - The type of responses coming from the inner ServerStreamingCallable.

OuterT - The type of responses the outer ResponseObserver expects.

All Known Implementing Classes:

RowMerger

@InternalApi
public interface Reframer<OuterT,InnerT>

Interface for the business logic of a stream transformation. All methods will be called in a synchronized block, so implementations don't need to be thread safe or be concerned with back pressure.

The flow is:

 hasFullFrame?
  -> true -> pop()
  -> false
    -> upstream complete?
      -> true
        -> hasPartialFrame?
          -> true
            => notify error
          -> false
            => notify complete
      -> false
        => push() and restart at hasFullFrame?
 

Method Summary

Modifier and Type	Method and Description
boolean	hasFullFrame() Checks if there is a frame to be popped.
boolean	hasPartialFrame() Checks if there is any incomplete data.
OuterT	pop() Returns and removes the current completed frame.
void	push(InnerT response) Refill internal buffers with inner/upstream response.

Method Detail

push

void push(InnerT response)

Refill internal buffers with inner/upstream response. Should only be invoked if hasFullFrame() returns false.

hasFullFrame

boolean hasFullFrame()

Checks if there is a frame to be popped.

Note that this method might update internal to buffer the next response.

hasPartialFrame

boolean hasPartialFrame()

Checks if there is any incomplete data. Used to check if the stream closed prematurely.

pop

OuterT pop()

Returns and removes the current completed frame. Should only be called if hasFullFrame returns true.