geronimo-websockets_1.0_spec/src/main/java/javax/websocket/PongMessage.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package javax.websocket;

import java.nio.ByteBuffer;

/**
 * The PongMessage interface represents a web socket pong. PongMessages may be received by using a
 * MessageHandler.Basic<PongMessage>. The payload of the PongMessage is the application data sent by the peer.
 */
public interface PongMessage {

    /**
     * The application data inside the pong message from the peer.
     * 
     * @return the application data.
     */
    ByteBuffer getApplicationData();
}