ClientEngine.ClientUpgradeInfo (Tyrus 2.1.5 API)

Enclosing interface:

ClientEngine
```
public static interface ClientEngine.ClientUpgradeInfo
```
Upgrade process result.
Provides information about upgrade process. There are three possible states which can be reported:
When getUpgradeStatus() returns ClientEngine.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 ClientEngine.ClientUpgradeStatus.UPGRADE_REQUEST_FAILED, client container HAS TO close all resources related to currently processed UpgradeResponse.
When getUpgradeStatus() returns ClientEngine.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 ClientEngine.createUpgradeRequest(TimeoutHandler).

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Connection`	`createConnection()`	Create new `Connection` when `getUpgradeStatus()` returns `ClientEngine.ClientUpgradeStatus.SUCCESS`.
`ClientEngine.ClientUpgradeStatus`	`getUpgradeStatus()`	Get `ClientEngine.ClientUpgradeStatus`.

- Method Detail
  - getUpgradeStatus
```
ClientEngine.ClientUpgradeStatus getUpgradeStatus()
```
    Get ClientEngine.ClientUpgradeStatus.
    
    Returns:
    
    ClientEngine.ClientUpgradeStatus.
  - createConnection
```
Connection createConnection()
```
    Create new Connection when getUpgradeStatus() returns ClientEngine.ClientUpgradeStatus.SUCCESS.
    
    Returns:
    
    new Connection instance or null, when getUpgradeStatus() does not return ClientEngine.ClientUpgradeStatus.