org.tio.websocket.client

Class WsClient

java.lang.Object

org.tio.websocket.client.WsClient

public class WsClient
extends Object

Method Summary

Modifier and Type	Method and Description
void	close()
WebSocket	connect() connect to server
static WsClient	create(String uri) To create a WsClient.
static WsClient	create(String uri, Map<String,String> additionalHttpHeaders) To create a WsClient.
static WsClient	create(String uri, Map<String,String> additionalHttpHeaders, WsClientConfig config) To create a WsClient.
static WsClient	create(String uri, WsClientConfig config) To create a WsClient.
ClientChannelContext	getClientChannelContext()
WsClientConfig	getConfig()
String	getRawUri()
TioClient	getTioClient()
URI	getUri()
WebSocket	getWs()

Methods inherited from class java.lang.Object

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

Method Detail

create

public static WsClient create(String uri)
                       throws Exception

To create a WsClient.

Parameters:

uri - The uri to connect

Returns:

Throws:

IOException

Exception

create

public static WsClient create(String uri,
                              Map<String,String> additionalHttpHeaders)
                       throws Exception

To create a WsClient.

Parameters:

uri - The uri to connect

additionalHttpHeaders - Additional headers added to the http package sent to the server during the handshake

Returns:

Throws:

IOException

Exception

create

public static WsClient create(String uri,
                              WsClientConfig config)
                       throws Exception

To create a WsClient.

Parameters:

uri - The uri to connect

config - The config of client. If you change the value later, you need to bear the possible consequences.

Returns:

Throws:

IOException

Exception

create

public static WsClient create(String uri,
                              Map<String,String> additionalHttpHeaders,
                              WsClientConfig config)
                       throws Exception

To create a WsClient.

Parameters:

uri - The uri to connect

additionalHttpHeaders - Additional headers added to the http package sent to the server during the handshake

config - The config of client. If you change the value later, you need to bear the possible consequences.

Returns:

Throws:

IOException

Exception

connect

public WebSocket connect()
                  throws Exception

connect to server

Returns:

WebSocket

Throws:

Exception

close

public void close()

getWs

public WebSocket getWs()

getConfig

public WsClientConfig getConfig()

getTioClient

public TioClient getTioClient()

getClientChannelContext

public ClientChannelContext getClientChannelContext()

getUri

public URI getUri()

getRawUri

public String getRawUri()