com.pdd.pop.ext.glassfish.tyrus.spi.Writer Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2012-2016 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
* http://glassfish.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 com.pdd.pop.ext.glassfish.tyrus.spi;
import java.io.Closeable;
import java.nio.ByteBuffer;
/**
* Writer class that is used by tyrus runtime to pass outbound websocket data
* for a connection to a transport. Then, the transport actually writes the
* data eventually.
*
* A transport creates implementation of this class and registers the writer
* object using {@link WebSocketEngine.UpgradeInfo#createConnection} after
* a successful upgrade.
*
* @author Pavel Bucek (pavel.bucek at oracle.com)
*/
public abstract class Writer implements Closeable {
/**
* Tyrus runtime calls this method to handover the data for a connection
* to the transport. The transport writes bytes to underlying connection.
* Tyrus runtime must not use the buffer until the write is completed.
*
* @param buffer bytes to write.
* @param completionHandler completion handler to know the write status.
*/
public abstract void write(ByteBuffer buffer, CompletionHandler completionHandler);
}