org.springframework.web.socket

Class PingMessage

java.lang.Object

org.springframework.web.socket.AbstractWebSocketMessage<java.nio.ByteBuffer>

org.springframework.web.socket.PingMessage

All Implemented Interfaces:

WebSocketMessage<java.nio.ByteBuffer>

public final class PingMessage
extends AbstractWebSocketMessage<java.nio.ByteBuffer>

A WebSocket ping message.

Since:

4.0

Author:

Rossen Stoyanchev

Constructor Summary

Constructors

Constructor and Description
PingMessage() Create a new ping message with an empty payload.
PingMessage(java.nio.ByteBuffer payload) Create a new ping message with the given ByteBuffer payload.

Method Summary

Modifier and Type	Method and Description
int	getPayloadLength() Return the number of bytes contained in the message.
protected java.lang.String	toStringPayload()

Methods inherited from class org.springframework.web.socket.AbstractWebSocketMessage

equals, getPayload, hashCode, isLast, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PingMessage

public PingMessage()

Create a new ping message with an empty payload.

PingMessage

public PingMessage(java.nio.ByteBuffer payload)

Create a new ping message with the given ByteBuffer payload.

Parameters:

payload - the non-null payload

Method Detail

getPayloadLength

public int getPayloadLength()

Description copied from interface: WebSocketMessage

Return the number of bytes contained in the message.

toStringPayload

protected java.lang.String toStringPayload()

Specified by:

toStringPayload in class AbstractWebSocketMessage<java.nio.ByteBuffer>