com.couchbase.client.core.msg.chunk.ChunkedResponse Maven / Gradle / Ivy

/*
 * Copyright (c) 2019 Couchbase, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.couchbase.client.core.msg.chunk;

import com.couchbase.client.core.msg.Response;
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;

/**
 * Describes a full chunked response with its required sections.
 *
 * @param  the type of the chunk header.
 * @param  the type of the chunk row.
 * @param  the type of the chunk trailer.
 */
public interface ChunkedResponse
  extends Response {

  /**
   * Returns the header for this response, immediately available.
   */
  H header();

  /**
   * Returns the rows for this response, available pushed as they come streaming in.
   */
  Flux rows();

  /**
   * Returns the trailer for this response, available at the end of the response eventually.
   */
  Mono trailer();

}