Top Description Constructors Methods
org.springframework.web.socket

public final Class PingMessage

extends AbstractWebSocketMessage<ByteBuffer>
Class Inheritance
Imports
java.nio.ByteBuffer

A WebSocket ping message.
Author
Rossen Stoyanchev
Since
4.0

Constructor Summary

AccessConstructor and Description
public
PingMessage()

Create a new ping message with an empty payload.

public
PingMessage(ByteBuffer
the non-null payload
payload
)

Create a new ping message with the given ByteBuffer payload.

Method Summary

Modifier and TypeMethod and Description
public int
getPayloadLength()

Implements org.springframework.web.socket.WebSocketMessage.getPayloadLength.

Return the number of bytes contained in the message.

protected String
Inherited from org.springframework.web.socket.AbstractWebSocketMessage:
equalsgetPayloadhashCodeisLasttoString

Constructor Detail

PingMessageback to summary
public PingMessage()

Create a new ping message with an empty payload.

PingMessageback to summary
public PingMessage(ByteBuffer payload)

Create a new ping message with the given ByteBuffer payload.

Parameters
payload:ByteBuffer

the non-null payload

Method Detail

getPayloadLengthback to summary
public int getPayloadLength()

Implements org.springframework.web.socket.WebSocketMessage.getPayloadLength.

Doc from org.springframework.web.socket.WebSocketMessage.getPayloadLength.

Return the number of bytes contained in the message.

Annotations
@Override
toStringPayloadback to summary
protected String toStringPayload()

Implements abstract org.springframework.web.socket.AbstractWebSocketMessage.toStringPayload.

Annotations
@Override