Modifier and Type	Class and Description
public static interface	ClientEngine.ClientUpgradeInfo Upgrade process result.
public static enum	ClientEngine.ClientUpgradeStatus Status of upgrade process.
public static interface	ClientEngine.TimeoutHandler Indicates to container that handshake timeout was reached.

Method Summary

Modifier and Type	Method and Description
public UpgradeRequest	Returns: request to be send on the wire or `null`, when the request cannot be created. When `null` is returned, client should free all resources tied to current connection. createUpgradeRequest(ClientEngine.TimeoutHandler handshake timeout handler. `TimeoutHandler#handleTimeout()` is invoked if `processResponse(UpgradeResponse, Writer, Connection.CloseListener)` is not called within handshake timeout. timeoutHandler) Create upgrade request and register `TimeoutHandler`.
public void	processError(Throwable encountered error. t) Process error.
public ClientEngine.ClientUpgradeInfo	Returns: info with upgrade status. processResponse(UpgradeResponse response to be processed. upgradeResponse, final Writer used for sending dataframes from client endpoint. writer, final Connection.CloseListener will be called when connection is closed, will be set as listener of returned `Connection`. closeListener) Process handshake and return `ClientUpgradeInfo` with handshake status (`ClientUpgradeStatus`).

Method Detail

createUpgradeRequest back to summary

createUpgradeRequest	back to summary
public UpgradeRequest createUpgradeRequest(ClientEngine.TimeoutHandler timeoutHandler) Create upgrade request and register `TimeoutHandler`. Parameters timeoutHandler:ClientEngine.TimeoutHandler handshake timeout handler. `TimeoutHandler#handleTimeout()` is invoked if `processResponse(UpgradeResponse, Writer, Connection.CloseListener)` is not called within handshake timeout. Returns:UpgradeRequest request to be send on the wire or `null`, when the request cannot be created. When `null` is returned, client should free all resources tied to current connection.

public UpgradeRequest createUpgradeRequest(ClientEngine.TimeoutHandler timeoutHandler)

Create upgrade request and register TimeoutHandler.

Parameters

timeoutHandler:ClientEngine.TimeoutHandler: handshake timeout handler. TimeoutHandler#handleTimeout() is invoked if processResponse(UpgradeResponse, Writer, Connection.CloseListener) is not called within handshake timeout.

Returns:UpgradeRequest

request to be send on the wire or null, when the request cannot be created. When null is returned, client should free all resources tied to current connection.

processError back to summary

processError	back to summary
public void processError(Throwable t) Process error. This method can be called any time when client encounters an error which cannot be handled in the container before `ClientUpgradeStatus#SUCCESS` is returned from `processResponse(UpgradeResponse, Writer, Connection.CloseListener)`. Parameters t:Throwable encountered error. See Also `processResponse(UpgradeResponse, Writer, Connection.CloseListener)`

public void processError(Throwable t)

Process error.

This method can be called any time when client encounters an error which cannot be handled in the container before ClientUpgradeStatus#SUCCESS is returned from processResponse(UpgradeResponse, Writer, Connection.CloseListener).

Parameters

t:Throwable: encountered error.

processResponse back to summary

processResponse	back to summary
public ClientEngine.ClientUpgradeInfo processResponse(UpgradeResponse upgradeResponse, final Writer writer, final Connection.CloseListener closeListener) Process handshake and return `ClientUpgradeInfo` with handshake status (`ClientUpgradeStatus`). Parameters upgradeResponse:UpgradeResponse response to be processed. writer:Writer used for sending dataframes from client endpoint. closeListener:Connection.CloseListener will be called when connection is closed, will be set as listener of returned `Connection`. Returns:ClientEngine.ClientUpgradeInfo info with upgrade status. See Also `processError(Throwable)`

public ClientEngine.ClientUpgradeInfo processResponse(UpgradeResponse upgradeResponse, final Writer writer, final Connection.CloseListener closeListener)

Process handshake and return ClientUpgradeInfo with handshake status (ClientUpgradeStatus).

Parameters

upgradeResponse:UpgradeResponse: response to be processed.
writer:Writer: used for sending dataframes from client endpoint.
closeListener:Connection.CloseListener: will be called when connection is closed, will be set as listener of returned Connection.

Returns:ClientEngine.ClientUpgradeInfo

info with upgrade status.

See Also

processError(Throwable)

org.glassfish.tyrus.spi back to summary

public Interface ClientEngine.ClientUpgradeInfo

Upgrade process result.

Provides information about upgrade process. There are three possible states which can be reported:

When getUpgradeStatus() returns ClientUpgradeStatus#SUCCESS, client container can create Connection and start processing read events from the underlying connection and report them to Tyrus runtime.

When getUpgradeStatus() returns ClientUpgradeStatus#UPGRADE_REQUEST_FAILED, client container HAS TO close all resources related to currently processed UpgradeResponse.

When getUpgradeStatus() returns ClientUpgradeStatus#ANOTHER_UPGRADE_REQUEST_REQUIRED, client container HAS TO close all resources related to currently processed UpgradeResponse, open new TCP connection and send UpgradeRequest obtained from method createUpgradeRequest(TimeoutHandler).

Method Summary

Modifier and Type	Method and Description
public Connection	Returns: new `Connection` instance or `null`, when `getUpgradeStatus()` does not return `ClientUpgradeStatus`. createConnection() Create new `Connection` when `getUpgradeStatus()` returns `ClientUpgradeStatus#SUCCESS`.
public ClientEngine.ClientUpgradeStatus	Returns: `ClientUpgradeStatus`. getUpgradeStatus() Get `ClientUpgradeStatus`.

Method Detail

createConnection back to summary

createConnection	back to summary
public Connection createConnection() Create new `Connection` when `getUpgradeStatus()` returns `ClientUpgradeStatus#SUCCESS`. Returns:Connection new `Connection` instance or `null`, when `getUpgradeStatus()` does not return `ClientUpgradeStatus`.

public Connection createConnection()

Create new Connection when getUpgradeStatus() returns ClientUpgradeStatus#SUCCESS.

Returns:Connection: new Connection instance or null, when getUpgradeStatus() does not return ClientUpgradeStatus.

getUpgradeStatus back to summary

getUpgradeStatus	back to summary
public ClientEngine.ClientUpgradeStatus getUpgradeStatus() Get `ClientUpgradeStatus`. Returns:ClientEngine.ClientUpgradeStatus `ClientUpgradeStatus`.

public ClientEngine.ClientUpgradeStatus getUpgradeStatus()

Get ClientUpgradeStatus.

Returns:ClientEngine.ClientUpgradeStatus: ClientUpgradeStatus.

org.glassfish.tyrus.spi back to summary

public final Enum ClientEngine.ClientUpgradeStatus

Class Inheritance

extends Enum<ClientEngine.ClientUpgradeStatus>

java.lang.Object
java.lang.Enum
org.glassfish.tyrus.spi.ClientEngine.ClientUpgradeStatus

Status of upgrade process.

Returned by processResponse(UpgradeResponse, Writer, Connection.CloseListener).

Field Summary

Modifier and Type	Field and Description
public static final ClientEngine.ClientUpgradeStatus	ANOTHER_UPGRADE_REQUEST_REQUIRED Client engine needs to send another request.
public static final ClientEngine.ClientUpgradeStatus	SUCCESS Upgrade process was successful.
public static final ClientEngine.ClientUpgradeStatus	UPGRADE_REQUEST_FAILED Upgrade process failed.

Constructor Summary

Access	Constructor and Description
private	ClientUpgradeStatus()

Method Summary

Modifier and Type	Method and Description
public static ClientEngine.ClientUpgradeStatus	valueOf(String name)
public static ClientEngine.ClientUpgradeStatus[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ANOTHER_UPGRADE_REQUEST_REQUIRED back to summary

ANOTHER_UPGRADE_REQUEST_REQUIRED	back to summary
public static final ClientEngine.ClientUpgradeStatus ANOTHER_UPGRADE_REQUEST_REQUIRED Client engine needs to send another request. See Also `createUpgradeRequest(TimeoutHandler)`

public static final ClientEngine.ClientUpgradeStatus ANOTHER_UPGRADE_REQUEST_REQUIRED

Client engine needs to send another request.

See Also: createUpgradeRequest(TimeoutHandler)

SUCCESS back to summary

SUCCESS	back to summary
public static final ClientEngine.ClientUpgradeStatus SUCCESS Upgrade process was successful. See Also `ClientUpgradeInfo#createConnection()`

public static final ClientEngine.ClientUpgradeStatus SUCCESS

Upgrade process was successful.

See Also: ClientUpgradeInfo#createConnection()

UPGRADE_REQUEST_FAILED	back to summary
public static final ClientEngine.ClientUpgradeStatus UPGRADE_REQUEST_FAILED Upgrade process failed.

Constructor Detail

ClientUpgradeStatus	back to summary
private ClientUpgradeStatus()

Method Detail

valueOf	back to summary
public static ClientEngine.ClientUpgradeStatus valueOf(String name)

values	back to summary
public static ClientEngine.ClientUpgradeStatus[] values()

public Interface ClientEngine

Nested and Inner Type Summary

Method Summary

Method Detail

public Interface ClientEngine.ClientUpgradeInfo

Method Summary

Method Detail

public final Enum ClientEngine.ClientUpgradeStatus

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface ClientEngine.TimeoutHandler

Method Summary

Method Detail