001/* 002 * Copyright 2002-2014 the original author or authors. 003 * 004 * Licensed under the Apache License, Version 2.0 (the "License"); 005 * you may not use this file except in compliance with the License. 006 * You may obtain a copy of the License at 007 * 008 * https://www.apache.org/licenses/LICENSE-2.0 009 * 010 * Unless required by applicable law or agreed to in writing, software 011 * distributed under the License is distributed on an "AS IS" BASIS, 012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 013 * See the License for the specific language governing permissions and 014 * limitations under the License. 015 */ 016 017package org.springframework.web.socket; 018 019import java.nio.ByteBuffer; 020 021/** 022 * A WebSocket ping message. 023 * 024 * @author Rossen Stoyanchev 025 * @since 4.0 026 */ 027public final class PingMessage extends AbstractWebSocketMessage<ByteBuffer> { 028 029 /** 030 * Create a new ping message with an empty payload. 031 */ 032 public PingMessage() { 033 super(ByteBuffer.allocate(0)); 034 } 035 036 /** 037 * Create a new ping message with the given ByteBuffer payload. 038 * @param payload the non-null payload 039 */ 040 public PingMessage(ByteBuffer payload) { 041 super(payload); 042 } 043 044 045 @Override 046 public int getPayloadLength() { 047 return (getPayload() != null ? getPayload().remaining() : 0); 048 } 049 050 @Override 051 protected String toStringPayload() { 052 return (getPayload() != null ? getPayload().toString() : null); 053 } 054 055}