io.ktor.http.cio.websocket

Class CloseReason

io.ktor.http.cio.websocket.CloseReason

public class CloseReason

Websocket close reason

Constructor Summary

Constructors

Constructor and Description
CloseReason(short code, java.lang.String message) Websocket close reason
CloseReason(CloseReason.Codes code, java.lang.String message)

Method Summary

Modifier and Type	Method and Description
short	component1() close reason code as per RFC 6455, recommended to be one of enum CloseReason.Codes
java.lang.String	component2() a close reason message, could be empty
CloseReason	copy(short code, java.lang.String message) Websocket close reason
boolean	equals(java.lang.Object p)
short	getCode() close reason code as per RFC 6455, recommended to be one of enum CloseReason.Codes
CloseReason.Codes	getKnownReason() A enum value for this code or null if the code is not listed in enum CloseReason.Codes
java.lang.String	getMessage() a close reason message, could be empty
int	hashCode()
java.lang.String	toString()

Constructor Detail

CloseReason

public CloseReason(short code,
                   java.lang.String message)

Websocket close reason

Parameters:

code -

• close reason code as per RFC 6455, recommended to be one of enum CloseReason.Codes

message -

• a close reason message, could be empty

CloseReason

public CloseReason(CloseReason.Codes code,
                   java.lang.String message)

Method Detail

getKnownReason

public CloseReason.Codes getKnownReason()

A enum value for this code or null if the code is not listed in enum CloseReason.Codes

See Also:

enum CloseReason.Codes

toString

public java.lang.String toString()

getCode

public short getCode()

• close reason code as per RFC 6455, recommended to be one of enum CloseReason.Codes

See Also:

enum CloseReason.Codes

getMessage

public java.lang.String getMessage()

• a close reason message, could be empty

component1

public short component1()

• close reason code as per RFC 6455, recommended to be one of enum CloseReason.Codes

See Also:

enum CloseReason.Codes

component2

public java.lang.String component2()

• a close reason message, could be empty

copy

public CloseReason copy(short code,
                        java.lang.String message)

Websocket close reason

hashCode

public int hashCode()

equals

public boolean equals(java.lang.Object p)