org.glassfish.tyrus.spi

Interface ClientEngine

public interface ClientEngine

Facade for handling client operations from containers.

Author:

Pavel Bucek (pavel.bucek at oracle.com)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ClientEngine.TimeoutHandler Indicates to container that handshake timeout was reached.

Method Summary

Methods

Modifier and Type	Method and Description
UpgradeRequest	createUpgradeRequest(URI uri, ClientEngine.TimeoutHandler timeoutHandler) Create upgrade request and register ClientEngine.TimeoutHandler.
Connection	processResponse(UpgradeResponse upgradeResponse, Writer writer, Connection.CloseListener closeListener) Process handshake response.

Method Detail

createUpgradeRequest

UpgradeRequest createUpgradeRequest(URI uri,
                                  ClientEngine.TimeoutHandler timeoutHandler)

Create upgrade request and register ClientEngine.TimeoutHandler.

Parameters:

uri - URI of remote endpoint.

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

Returns:

request to be send on the wire.

processResponse

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

Process handshake response.

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:

Tyrus connection representation. Handles all incoming data.

See Also:

Connection.getReadHandler(), ReadHandler