org.glassfish.grizzly.spdy.SessionOutputSink Maven / Gradle / Ivy

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2014 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package org.glassfish.grizzly.spdy;

import java.util.ArrayList;
import java.util.List;
import org.glassfish.grizzly.Buffer;
import org.glassfish.grizzly.CompletionHandler;
import org.glassfish.grizzly.WriteHandler;
import org.glassfish.grizzly.WriteResult;
import org.glassfish.grizzly.asyncqueue.MessageCloner;
import org.glassfish.grizzly.spdy.frames.DataFrame;
import org.glassfish.grizzly.spdy.frames.SpdyFrame;

/**
 * Class represents an output sink associated with specific {@link SpdySession}
 * and is responsible for session (connection) level flow control.
 * 
 * @author Alexey Stashok
 */
public abstract class SessionOutputSink {
    protected final SpdySession session;

    public SessionOutputSink(SpdySession session) {
        this.session = session;
    }

    public void close() {
    }

    protected void writeDownStream(final SpdyFrame frame) {
        writeDownStream(frame, null);
    }
    
    protected void writeDownStream(final SpdyFrame frame,
            final CompletionHandler completionHandler) {
        
        session.getDownstreamChain().write(session.getConnection(),
                null, frame, completionHandler, (MessageCloner) null);        
    }

    protected  void writeDownStream(final K anyMessage,
            final CompletionHandler completionHandler,
            final MessageCloner messageCloner) {
        
        session.getDownstreamChain().write(session.getConnection(),
                null, anyMessage, completionHandler, messageCloner);        
    }

    protected void writeDataDownStream(final SpdyStream spdyStream,
            final SpdyFrame headerFrame,
            final Buffer data,
            final CompletionHandler completionHandler,
            final MessageCloner messageCloner,
            final boolean isLast) {
        
        if (data == null) {
            writeDownStream(headerFrame, completionHandler, messageCloner);
            return;
        }
        
        final DataFrame dataFrame = DataFrame.builder()
                .streamId(spdyStream.getStreamId())
                .data(data).last(isLast)
                .build();

        final Object msg;
        if (headerFrame != null) {
            final List tmpList = new ArrayList(2);
            tmpList.add(headerFrame);
            tmpList.add(dataFrame);
            msg = tmpList;
        } else {
            msg = dataFrame;
        }

        writeDownStream(msg, completionHandler, messageCloner);
    }
        
    protected abstract void onPeerWindowUpdate(int delta) throws SpdyStreamException;

    protected abstract boolean canWrite();

    protected abstract void notifyCanWrite(WriteHandler writeHandler);

    protected abstract int getAvailablePeerConnectionWindowSize();
}