Package: PongMessage

PongMessage

Coverage

1: /*
2: * Copyright (c) 2018, 2019 Oracle and/or its affiliates and others.
3: * All rights reserved.
4: *
5: * This program and the accompanying materials are made available under the
6: * terms of the Eclipse Public License v. 2.0, which is available at
7: * http://www.eclipse.org/legal/epl-2.0.
8: *
9: * This Source Code may also be made available under the following Secondary
10: * Licenses when the conditions for such availability set forth in the
11: * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
12: * version 2 with the GNU Classpath Exception, which is available at
13: * https://www.gnu.org/software/classpath/license.html.
14: *
15: * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
16: */
17:
18: package jakarta.websocket;
19:
20: import java.nio.ByteBuffer;
21:
22: /**
23: * The PongMessage interface represents a web socket pong. PongMessages may be received by using a
24: * {@code MessageHandler.Basic<PongMessage>}. The payload of the PongMessage is the application data sent by the peer.
25: *
26: * @author dannycoward
27: */
28: public interface PongMessage {
29:
30: /**
31: * The application data inside the pong message from the peer.
32: *
33: * @return the application data.
34: */
35: ByteBuffer getApplicationData();
36: }