org.jboss.netty.handler.codec.spdy.SpdySynStreamFrame Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of netty Show documentation

The Netty project is an effort to provide an asynchronous event-driven network application framework and tools for rapid development of maintainable high performance and high scalability protocol servers and clients. In other words, Netty is a NIO client server framework which enables quick and easy development of network applications such as protocol servers and clients. It greatly simplifies and streamlines network programming such as TCP and UDP socket server.

There is a newer version: 4.0.0.Alpha8

Show newest version

/*
 * Copyright 2012 The Netty Project
 *
 * The Netty 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.jboss.netty.handler.codec.spdy;

/**
 * A SPDY Protocol SYN_STREAM Control Frame
 */
public interface SpdySynStreamFrame extends SpdyHeaderBlock {

    /**
     * @deprecated Use {@link #getStreamId()} instead.
     */
    @Deprecated
    int getStreamID();

    /**
     * Returns the Stream-ID of this frame.
     */
    int getStreamId();

    /**
     * @deprecated Use {@link #setStreamId(int)} instead.
     */
    @Deprecated
    void setStreamID(int streamID);

    /**
     * Sets the Stream-ID of this frame.  The Stream-ID must be positive.
     */
    void setStreamId(int streamId);

    /**
     * @deprecated Use {@link #getAssociatedToStreamId()} instead.
     */
    @Deprecated
    int getAssociatedToStreamID();

    /**
     * Returns the Associated-To-Stream-ID of this frame.
     */
    int getAssociatedToStreamId();

    /**
     * @deprecated Use {@link #setAssociatedToStreamId(int)} instead.
     */
    @Deprecated
    void setAssociatedToStreamID(int associatedToStreamId);

    /**
     * Sets the Associated-To-Stream-ID of this frame.
     * The Associated-To-Stream-ID cannot be negative.
     */
    void setAssociatedToStreamId(int associatedToStreamId);

    /**
     * Returns the priority of the stream.
     */
    byte getPriority();

    /**
     * Sets the priority of the stream.
     * The priority must be between 0 and 7 inclusive.
     */
    void setPriority(byte priority);

    /**
     * Returns {@code true} if this frame is the last frame to be transmitted
     * on the stream.
     */
    boolean isLast();

    /**
     * Sets if this frame is the last frame to be transmitted on the stream.
     */
    void setLast(boolean last);

    /**
     * Returns {@code true} if the stream created with this frame is to be
     * considered half-closed to the receiver.
     */
    boolean isUnidirectional();

    /**
     * Sets if the stream created with this frame is to be considered
     * half-closed to the receiver.
     */
    void setUnidirectional(boolean unidirectional);
}