Package com.linecorp.armeria.server.websocket

Class WebSocketUpgradeResult

java.lang.Object

com.linecorp.armeria.server.websocket.WebSocketUpgradeResult

public final class WebSocketUpgradeResult
extends Object

The result of a WebSocket upgrade.

Method Summary

Modifier and Type	Method	Description
HttpResponse	fallbackResponse()	Returns the fallback HttpResponse if the upgrade failed.
boolean	isSuccess()	Returns true if the upgrade was successful.
static WebSocketUpgradeResult	ofFailure(HttpResponse fallbackResponse)	Returns a failed WebSocketUpgradeResult with the fallback HttpResponse.
static WebSocketUpgradeResult	ofSuccess()	Returns a successful WebSocketUpgradeResult.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

ofSuccess

public static WebSocketUpgradeResult ofSuccess()

Returns a successful WebSocketUpgradeResult.

ofFailure

public static WebSocketUpgradeResult ofFailure(HttpResponse fallbackResponse)

Returns a failed WebSocketUpgradeResult with the fallback HttpResponse.

isSuccess

public boolean isSuccess()

Returns true if the upgrade was successful.

fallbackResponse

public HttpResponse fallbackResponse()

Returns the fallback HttpResponse if the upgrade failed.

Throws:

IllegalStateException - if the upgrade was successful.

toString

public String toString()

Overrides:

toString in class Object