CloseFrame (Jetty :: Project 9.4.56.v20240826 API)

java.lang.Object
- org.eclipse.jetty.websocket.common.WebSocketFrame
- - org.eclipse.jetty.websocket.common.frames.ControlFrame
  - - org.eclipse.jetty.websocket.common.frames.CloseFrame

All Implemented Interfaces:: Frame

public class CloseFrame
extends ControlFrame

Nested Class Summary
- Nested classes/interfaces inherited from interface org.eclipse.jetty.websocket.api.extensions.Frame
  Frame.Type

Field Summary
- Fields inherited from class org.eclipse.jetty.websocket.common.frames.ControlFrame
  MAX_CONTROL_PAYLOAD
- Fields inherited from class org.eclipse.jetty.websocket.common.WebSocketFrame
  data, finRsvOp, mask, masked

Constructor Summary

Constructors
Constructor Description

CloseFrame()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Frame.Type`	`getType()`
`static java.lang.String`	`truncate(java.lang.String reason)`	Truncate arbitrary reason into something that will fit into the CloseFrame limits.

Methods inherited from class org.eclipse.jetty.websocket.common.frames.ControlFrame
assertValid, equals, getPayload, isControlFrame, isDataFrame, setPayload

Methods inherited from class org.eclipse.jetty.websocket.common.WebSocketFrame
copy, copyHeaders, copyHeaders, getMask, getOpCode, getPayloadAsUTF8, getPayloadLength, hashCode, hasPayload, isFin, isLast, isMasked, isRsv1, isRsv2, isRsv3, reset, setFin, setMask, setMasked, setOpCode, setRsv1, setRsv2, setRsv3, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CloseFrame
```
public CloseFrame()
```
- Method Detail
  - getType
```
public Frame.Type getType()
```
    Specified by:
    
    getType in interface Frame
    
    Overrides:
    
    getType in class WebSocketFrame
  - truncate
```
public static java.lang.String truncate(java.lang.String reason)
```
    Truncate arbitrary reason into something that will fit into the CloseFrame limits.
    
    Parameters:
    
    reason - the arbitrary reason to possibly truncate.
    
    Returns:
    
    the possibly truncated reason string.