org.jdrupes.httpcodec.protocols.websocket.WsMessageHeader Maven / Gradle / Ivy

Go to download

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

HTTP coders and decoders for non-blocking I/O

There is a newer version: 3.1.0

/*
 * This file is part of the JDrupes non-blocking HTTP Codec
 * Copyright (C) 2016, 2017  Michael N. Lipp
 *
 * This program is free software; you can redistribute it and/or modify it 
 * under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation; either version 3 of the License, or 
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but 
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License along 
 * with this program; if not, see .
 */

package org.jdrupes.httpcodec.protocols.websocket;

/**
 * The Websocket message header.
 */
public class WsMessageHeader extends WsFrameHeader {

	private boolean textMode;
	private boolean hasPayload;

	/**
	 * Creates a new message header.
	 * 
	 * @param textMode indicates whether the data is sent as text
	 * @param hasPayload indicates that the message has a payload
	 */
	public WsMessageHeader(boolean textMode, boolean hasPayload) {
		super();
		this.textMode = textMode;
		this.hasPayload = hasPayload;
	}

	/* (non-Javadoc)
	 * @see org.jdrupes.httpcodec.MessageHeader#isFinal()
	 */
	@Override
	public boolean isFinal() {
		return false;
	}

	/**
	 * @return whether the data is sent as text
	 */
	public boolean isTextMode() {
		return textMode;
	}

	@Override
	public boolean hasPayload() {
		return hasPayload;
	}

	/* (non-Javadoc)
	 * @see java.lang.Object#toString()
	 */
	@Override
	public String toString() {
		StringBuilder builder = new StringBuilder();
		builder.append("WsMessageHeader [textMode=");
		builder.append(textMode);
		builder.append(", hasPayload=");
		builder.append(hasPayload);
		builder.append("]");
		return builder.toString();
	}
	
}