org.reaktivity.nukleus.http2.internal.WriteScheduler Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of nukleus-http2 Show documentation
HTTP/2 Nukleus Implementation
The newest version!
/**
 * Copyright 2016-2019 The Reaktivity Project
 *
 * The Reaktivity Project licenses this file to you 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 org.reaktivity.nukleus.http2.internal;

import org.agrona.DirectBuffer;
import org.reaktivity.nukleus.http2.internal.types.ArrayFW;
import org.reaktivity.nukleus.http2.internal.types.HttpHeaderFW;
import org.reaktivity.nukleus.http2.internal.types.stream.Http2ErrorCode;

/*
 * Writes HTTP2 frames to a connection. There are multiple streams multiplexed in
 * a connection, there are different ways to send data on the connection
 * (when there is a window). For e.g some implementations are:
 *
 * 1. HTTP2 streams are selected randomly
 * 2. HTTP2 streams are selected based on the priority of streams
 * 3. HTTP2 streams are selected in a round-robin way
 ...
 */
public interface WriteScheduler
{

    boolean windowUpdate(int streamId, int update);

    boolean pingAck(DirectBuffer buffer, int offset, int length);

    boolean goaway(int lastStreamId, Http2ErrorCode errorCode);

    boolean rst(int streamId, Http2ErrorCode errorCode);

    boolean settings(int maxConcurrentStreams, int initialWindowSize);

    boolean settingsAck();

    boolean headers(long traceId, int streamId, byte flags, ArrayFW headers);

    boolean trailers(long traceId, int streamId, byte flags, ArrayFW headers);

    boolean pushPromise(long traceId, int streamId, int promisedStreamId, ArrayFW headers);

    boolean data(long traceId, int streamId, DirectBuffer buffer, int offset, int length);

    boolean dataEos(long traceId, int streamId);

    void doEnd();

    void onWindow();

    void onHttp2Window();

    void onHttp2Window(int streamId);

    interface Entry
    {
    }

}