001/*
002 * This file is part of the JDrupes non-blocking HTTP Codec
003 * Copyright (C) 2016, 2017  Michael N. Lipp
004 *
005 * This program is free software; you can redistribute it and/or modify it 
006 * under the terms of the GNU Lesser General Public License as published
007 * by the Free Software Foundation; either version 3 of the License, or 
008 * (at your option) any later version.
009 *
010 * This program is distributed in the hope that it will be useful, but 
011 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
012 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 
013 * License for more details.
014 *
015 * You should have received a copy of the GNU Lesser General Public License along 
016 * with this program; if not, see <http://www.gnu.org/licenses/>.
017 */
018
019package org.jdrupes.httpcodec.protocols.websocket;
020
021import java.nio.ByteBuffer;
022import java.util.Optional;
023
024/**
025 * Control frames with binary application data.
026 * 
027 * Note that the application data is modeled as part of the header in the API
028 * although it is handled like payload by the "wire protocol".
029 */
030public abstract class WsDefaultControlFrame extends WsFrameHeader {
031
032        private Optional<ByteBuffer> applicationData;
033        
034        /* (non-Javadoc)
035         * @see org.jdrupes.httpcodec.MessageHeader#isFinal()
036         */
037        @Override
038        public boolean isFinal() {
039                return false;
040        }
041
042        /* (non-Javadoc)
043         * @see org.jdrupes.httpcodec.MessageHeader#hasPayload()
044         */
045        @Override
046        public boolean hasPayload() {
047                return false;
048        }
049
050        /**
051         * Creates a new frame.
052         * 
053         * @param applicationData the application data. May be {@code null}.
054         */
055        public WsDefaultControlFrame(ByteBuffer applicationData) {
056                this.applicationData = Optional.ofNullable(applicationData);
057        }
058
059        /**
060         * 
061         * @return the application data
062         */
063        public Optional<ByteBuffer> applicationData() {
064                return applicationData;
065        }
066}