io.gravitee.gateway.api.stream.WriteStream Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gravitee-gateway-api Show documentation

There is a newer version: 3.9.0-alpha.26

/**
 * Copyright (C) 2015 The Gravitee team (http://gravitee.io)
 *
 * 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 io.gravitee.gateway.api.stream;

import io.gravitee.gateway.api.handler.Handler;

/**
 * Stream writer.
 *
 * Mainly inspired from Vertx.io
 * @see io.vertx.core.streams.WriteStream
 *
 * @author David BRASSELY (david at gravitee.io)
 * @author GraviteeSource Team
 */
public interface WriteStream {

    WriteStream write(T content);

    void end();

    default void end(T t) {
        write(t);
        end();
    }

    default WriteStream drainHandler(Handler drainHandler) { return this; }

    default boolean writeQueueFull() { return false; }
}