org.glassfish.tyrus.client

Class TyrusClientEngine

java.lang.Object

org.glassfish.tyrus.client.TyrusClientEngine

All Implemented Interfaces:

ClientEngine

public class TyrusClientEngine
extends Object
implements ClientEngine

Tyrus ClientEngine implementation.

Author:

Pavel Bucek (pavel.bucek at oracle.com)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TyrusClientEngine.ClientHandshakeListener Called when response is received from the server.

Nested classes/interfaces inherited from interface org.glassfish.tyrus.spi.ClientEngine

ClientEngine.ClientUpgradeInfo, ClientEngine.ClientUpgradeStatus, ClientEngine.TimeoutHandler

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_INCOMING_BUFFER_SIZE Default incoming buffer size for client container.

Method Summary

Methods

Modifier and Type	Method and Description
UpgradeRequest	createUpgradeRequest(ClientEngine.TimeoutHandler timeoutHandler) Create upgrade request and register ClientEngine.TimeoutHandler.
ClientEngine.TimeoutHandler	getTimeoutHandler() Get TimeoutHandler associated with current ClientEngine instance.
void	processError(Throwable t) Process error.
ClientEngine.ClientUpgradeInfo	processResponse(UpgradeResponse upgradeResponse, Writer writer, Connection.CloseListener closeListener) Process handshake and return ClientEngine.ClientUpgradeInfo with handshake status (ClientEngine.ClientUpgradeStatus).

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_INCOMING_BUFFER_SIZE

public static final int DEFAULT_INCOMING_BUFFER_SIZE

Default incoming buffer size for client container.

See Also:

Constant Field Values

Method Detail

createUpgradeRequest

public UpgradeRequest createUpgradeRequest(ClientEngine.TimeoutHandler timeoutHandler)

Description copied from interface: ClientEngine

Create upgrade request and register ClientEngine.TimeoutHandler.

Specified by:

createUpgradeRequest in interface ClientEngine

Parameters:

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

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.

processResponse

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

Description copied from interface: ClientEngine

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

Specified by:

processResponse in interface ClientEngine

Parameters:

upgradeResponse - response to be processed.

writer - used for sending dataframes from client endpoint.

closeListener - will be called when connection is closed, will be set as listener of returned Connection.

Returns:

info with upgrade status.

See Also:

ClientEngine.processError(Throwable)

processError

public void processError(Throwable t)

Description copied from interface: ClientEngine

Process error.

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

Specified by:

processError in interface ClientEngine

Parameters:

t - encountered error.

See Also:

ClientEngine.processResponse(UpgradeResponse, Writer, Connection.CloseListener)

getTimeoutHandler

public ClientEngine.TimeoutHandler getTimeoutHandler()

Get TimeoutHandler associated with current ClientEngine instance.

Returns:

timeout handler instance or null when not present.