CloseWebSocketFrame (Armeria 1.26.2 API reference)

All Superinterfaces:: AutoCloseable, Bytes, SafeCloseable, WebSocketFrame

@UnstableApi public interface CloseWebSocketFrame extends WebSocketFrame

A close WebSocketFrame.

See Also:

Close

Method Summary

Modifier and Type

Method

Description

@Nullable String

reasonPhrase()

Returns the text that indicates the reason for closure.

WebSocketCloseStatus

status()

Returns the WebSocketCloseStatus.

Methods inherited from interface com.linecorp.armeria.common.Bytes
array, byteBuf, byteBuf, byteBuf, close, isEmpty, isPooled, length, toInputStream, toReader, toReaderAscii, toReaderUtf8, toString, toStringAscii, toStringUtf8, touch

Methods inherited from interface com.linecorp.armeria.common.websocket.WebSocketFrame
isFinalFragment, text, type

Method Details
- status
  
  WebSocketCloseStatus status()
  
  Returns the WebSocketCloseStatus.
  See Also:
  
  Status Codes
- reasonPhrase
  
  @Nullable @Nullable String reasonPhrase()
  
  Returns the text that indicates the reason for closure.
  See Also:
  
  Status Codes