WebSocketClient (openapi-java-sdk 1.4.7 API)

java.lang.Object
- com.tigerbrokers.stock.openapi.client.socket.WebSocketClient

所有已实现的接口:

SubscribeAsyncApi
```
public class WebSocketClient
extends Object
implements SubscribeAsyncApi
```
Description: Created by lijiawen on 2018/05/16.

字段概要

字段
限定符和类型字段和说明

static String STOMP_DECODER

static String STOMP_ENCODER

字段
限定符和类型	字段和说明
`static String`	`STOMP_DECODER`
`static String`	`STOMP_ENCODER`

方法概要

所有方法静态方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`WebSocketClient`	`apiComposeCallback(ApiComposeCallback apiComposeCallback)`
`WebSocketClient`	`authentication(ApiAuthentication authentication)` 已过时。
`String`	`cancelSubscribe(Subject subject)` cancel subscribe trade data , include order / position / asset
`String`	`cancelSubscribeDepthQuote(Set<String> symbols)` cancel subscribe depth data
`String`	`cancelSubscribeFuture(Set<String> symbols)` cancel subscribe futures data
`String`	`cancelSubscribeOption(Set<String> symbols)` cancel subscribe option data
`String`	`cancelSubscribeQuote(Set<String> symbols)` cancel subscribe quote data,include stock / option / futures
`String`	`cancelSubscribeTradeTick(Set<String> symbols)` cancel subscribe stock trade tick data
`WebSocketClient`	`clientConfig(ClientConfig clientConfig)`
`WebSocketClient`	`clientHeartBeatData(ClientHeartBeatData clientHeartBeatData)`
`void`	`closeConnect(boolean sendDisconnectCommand)` close the connection
`void`	`connect()` create the connection (The same tigerId has only one active connection)
`void`	`connectCountDown()`
`void`	`disconnect()` destroy the reconnect thread, then send disconnect command and close the connection Note: Sending the disconnect command will cancel all subscription data
`static WebSocketClient`	`getInstance()` get WebSocketClient instance
`String`	`getSubscribedSymbols()` query subscribed symbol list
`String`	`getUrl()`
`boolean`	`isConnected()`
`WebSocketClient`	`sslProvider(io.netty.handler.ssl.SslProvider sslProvider)` set SslProvider
`String`	`subscribe(String account, Subject subject)` subscribe trade data , include order / position / asset
`String`	`subscribe(String account, Subject subject, List<String> focusKeys)` subscribe trade data , include order / position / asset
`String`	`subscribe(Subject subject)` subscribe trade data , include order / position / asset
`String`	`subscribe(Subject subject, List<String> focusKeys)` subscribe trade data , include order / position / asset
`String`	`subscribeDepthQuote(Set<String> symbols)` subscribe depth data
`String`	`subscribeFuture(Set<String> symbols)` subscribe futures data
`String`	`subscribeOption(Set<String> symbols)` subscribe option data
`String`	`subscribeQuote(Set<String> symbols)` subscrie quote
`String`	`subscribeQuote(Set<String> symbols, List<String> focusKeys)` subscribe quote data
`String`	`subscribeQuote(Set<String> symbols, QuoteKeyType quoteKeyType)` subscribe quote data
`String`	`subscribeTradeTick(Set<String> symbols)` subscribe stock trade tick data
`WebSocketClient`	`url(String url)` 已过时。

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - STOMP_ENCODER
```
public static final String STOMP_ENCODER
```
    另请参阅:
    
    常量字段值
  - STOMP_DECODER
```
public static final String STOMP_DECODER
```
    另请参阅:
    
    常量字段值
- 方法详细资料
  - getInstance
```
public static WebSocketClient getInstance()
```
    get WebSocketClient instance
    
    返回:
    
    WebSocketClient
  - sslProvider
```
public WebSocketClient sslProvider(io.netty.handler.ssl.SslProvider sslProvider)
```
    set SslProvider
    
    参数:
    
    sslProvider -
    
    返回:
    
    WebSocketClient
  - clientConfig
```
public WebSocketClient clientConfig(ClientConfig clientConfig)
```
  - url
```
@Deprecated
public WebSocketClient url(String url)
```
    已过时。
    
    please use clientConfig() method
  - authentication
```
@Deprecated
public WebSocketClient authentication(ApiAuthentication authentication)
```
    已过时。
    
    please use clientConfig() method
  - apiComposeCallback
```
public WebSocketClient apiComposeCallback(ApiComposeCallback apiComposeCallback)
```
  - clientHeartBeatData
```
public WebSocketClient clientHeartBeatData(ClientHeartBeatData clientHeartBeatData)
```
  - connectCountDown
```
public void connectCountDown()
```
  - connect
```
public void connect()
```
    create the connection (The same tigerId has only one active connection)
  - getUrl
```
public String getUrl()
```
  - disconnect
```
public void disconnect()
```
    destroy the reconnect thread, then send disconnect command and close the connection
    Note: Sending the disconnect command will cancel all subscription data
  - closeConnect
```
public void closeConnect(boolean sendDisconnectCommand)
```
    close the connection
  - isConnected
```
public boolean isConnected()
```
  - subscribe
```
public String subscribe(Subject subject,
                        List<String> focusKeys)
```
    从接口复制的说明: SubscribeAsyncApi
    
    subscribe trade data , include order / position / asset
    
    指定者:
    
    subscribe 在接口中 SubscribeAsyncApi
    
    参数:
    
    subject - trade subject
    
    focusKeys - focus keys
    
    返回:
    
    string id
  - subscribe
```
public String subscribe(Subject subject)
```
    从接口复制的说明: SubscribeAsyncApi
    
    subscribe trade data , include order / position / asset
    
    指定者:
    
    subscribe 在接口中 SubscribeAsyncApi
    
    参数:
    
    subject - trade subject
    
    返回:
    
    string id
  - subscribe
```
public String subscribe(String account,
                        Subject subject)
```
    从接口复制的说明: SubscribeAsyncApi
    
    subscribe trade data , include order / position / asset
    
    指定者:
    
    subscribe 在接口中 SubscribeAsyncApi
    
    参数:
    
    account - subscribe account
    
    subject - trade subject
    
    返回:
    
    string id
  - subscribe
```
public String subscribe(String account,
                        Subject subject,
                        List<String> focusKeys)
```
    从接口复制的说明: SubscribeAsyncApi
    
    subscribe trade data , include order / position / asset
    
    指定者:
    
    subscribe 在接口中 SubscribeAsyncApi
    
    参数:
    
    account - account
    
    subject - subject
    
    focusKeys - focus keys
    
    返回:
    
    string id
  - cancelSubscribe
```
public String cancelSubscribe(Subject subject)
```
    从接口复制的说明: SubscribeAsyncApi
    
    cancel subscribe trade data , include order / position / asset
    
    指定者:
    
    cancelSubscribe 在接口中 SubscribeAsyncApi
    
    参数:
    
    subject - trade subject
    
    返回:
    
    string id
  - subscribeQuote
```
public String subscribeQuote(Set<String> symbols)
```
    从接口复制的说明: SubscribeAsyncApi
    
    subscrie quote
    
    指定者:
    
    subscribeQuote 在接口中 SubscribeAsyncApi
    
    参数:
    
    symbols - symbol list
    
    返回:
    
    string id
  - subscribeQuote
```
public String subscribeQuote(Set<String> symbols,
                             QuoteKeyType quoteKeyType)
```
    从接口复制的说明: SubscribeAsyncApi
    
    subscribe quote data
    
    指定者:
    
    subscribeQuote 在接口中 SubscribeAsyncApi
    
    参数:
    
    symbols - symbol list
    
    quoteKeyType - quote key type
    
    返回:
    
    string id
  - subscribeQuote
```
public String subscribeQuote(Set<String> symbols,
                             List<String> focusKeys)
```
    从接口复制的说明: SubscribeAsyncApi
    
    subscribe quote data
    
    指定者:
    
    subscribeQuote 在接口中 SubscribeAsyncApi
    
    参数:
    
    symbols - symbol list
    
    focusKeys - focus keys
    
    返回:
    
    string id
  - cancelSubscribeQuote
```
public String cancelSubscribeQuote(Set<String> symbols)
```
    从接口复制的说明: SubscribeAsyncApi
    
    cancel subscribe quote data,include stock / option / futures
    
    指定者:
    
    cancelSubscribeQuote 在接口中 SubscribeAsyncApi
    
    参数:
    
    symbols - symbol list
    
    返回:
    
    string id
  - subscribeTradeTick
```
public String subscribeTradeTick(Set<String> symbols)
```
    从接口复制的说明: SubscribeAsyncApi
    
    subscribe stock trade tick data
    
    指定者:
    
    subscribeTradeTick 在接口中 SubscribeAsyncApi
    
    参数:
    
    symbols - symbol list
    
    返回:
    
    string id
  - cancelSubscribeTradeTick
```
public String cancelSubscribeTradeTick(Set<String> symbols)
```
    从接口复制的说明: SubscribeAsyncApi
    
    cancel subscribe stock trade tick data
    
    指定者:
    
    cancelSubscribeTradeTick 在接口中 SubscribeAsyncApi
    
    参数:
    
    symbols - symbol list
    
    返回:
    
    string id
  - subscribeOption
```
public String subscribeOption(Set<String> symbols)
```
    从接口复制的说明: SubscribeAsyncApi
    
    subscribe option data
    
    指定者:
    
    subscribeOption 在接口中 SubscribeAsyncApi
    
    参数:
    
    symbols - symbol list
    
    返回:
    
    string id
  - cancelSubscribeOption
```
public String cancelSubscribeOption(Set<String> symbols)
```
    从接口复制的说明: SubscribeAsyncApi
    
    cancel subscribe option data
    
    指定者:
    
    cancelSubscribeOption 在接口中 SubscribeAsyncApi
    
    参数:
    
    symbols - symbol list
    
    返回:
    
    string id
  - subscribeFuture
```
public String subscribeFuture(Set<String> symbols)
```
    从接口复制的说明: SubscribeAsyncApi
    
    subscribe futures data
    
    指定者:
    
    subscribeFuture 在接口中 SubscribeAsyncApi
    
    参数:
    
    symbols - symbol list
    
    返回:
    
    string id
  - cancelSubscribeFuture
```
public String cancelSubscribeFuture(Set<String> symbols)
```
    从接口复制的说明: SubscribeAsyncApi
    
    cancel subscribe futures data
    
    指定者:
    
    cancelSubscribeFuture 在接口中 SubscribeAsyncApi
    
    参数:
    
    symbols - symbol list
    
    返回:
    
    string id
  - subscribeDepthQuote
```
public String subscribeDepthQuote(Set<String> symbols)
```
    从接口复制的说明: SubscribeAsyncApi
    
    subscribe depth data
    
    指定者:
    
    subscribeDepthQuote 在接口中 SubscribeAsyncApi
    
    参数:
    
    symbols - symbol list
    
    返回:
    
    string id
  - cancelSubscribeDepthQuote
```
public String cancelSubscribeDepthQuote(Set<String> symbols)
```
    从接口复制的说明: SubscribeAsyncApi
    
    cancel subscribe depth data
    
    指定者:
    
    cancelSubscribeDepthQuote 在接口中 SubscribeAsyncApi
    
    参数:
    
    symbols - symbol list
    
    返回:
    
    string id
  - getSubscribedSymbols
```
public String getSubscribedSymbols()
```
    从接口复制的说明: SubscribeAsyncApi
    
    query subscribed symbol list
    
    指定者:
    
    getSubscribedSymbols 在接口中 SubscribeAsyncApi
    
    返回:
    
    string id

类 WebSocketClient

字段概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

STOMP_ENCODER

STOMP_DECODER

方法详细资料

getInstance

sslProvider

clientConfig

url

authentication

apiComposeCallback

clientHeartBeatData

connectCountDown

connect

getUrl

disconnect

closeConnect

isConnected

subscribe

subscribe

subscribe

subscribe

cancelSubscribe

subscribeQuote

subscribeQuote

subscribeQuote

cancelSubscribeQuote

subscribeTradeTick

cancelSubscribeTradeTick

subscribeOption

cancelSubscribeOption

subscribeFuture

cancelSubscribeFuture

subscribeDepthQuote

cancelSubscribeDepthQuote

getSubscribedSymbols