Skip to content

Commit 5f8a3ec

Browse files
发布版本 1.1.3
1 parent d0aa629 commit 5f8a3ec

File tree

1 file changed

+17
-6
lines changed

1 file changed

+17
-6
lines changed

README.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@
1010
> 目前主要针对中国国内市场(CTP & XTP)
1111
1212
## 接口速览
13-
带有文档注释的全内容版本参见 [BrokerApi.kt](https://github.com/ktrader-tech/ktrader-broker-api/blob/master/lib/src/main/kotlin/org/rationalityfrontline/ktrader/broker/api/BrokerApi.kt)
13+
带有文档注释的全内容版本参见 [BrokerApi.kt](https://github.com/ktrader-tech/ktrader-broker-api/blob/master/lib/src/main/kotlin/org/rationalityfrontline/ktrader/broker/api/BrokerApi.kt)
14+
[BrokerEvent.kt](https://github.com/ktrader-tech/ktrader-broker-api/blob/master/lib/src/main/kotlin/org/rationalityfrontline/ktrader/broker/api/BrokerEvent.kt)
1415
```kotlin
1516
abstract class BrokerApi(val config: Map<String, Any>, val kEvent: KEvent) {
1617
abstract val name: String
@@ -22,7 +23,7 @@ abstract class BrokerApi(val config: Map<String, Any>, val kEvent: KEvent) {
2223
val sourceId: String get() = "${name}_${account}_${hashCode()}"
2324

2425
abstract suspend fun connect(connectMd: Boolean = true, connectTd: Boolean = true, extras: Map<String, Any>? = null)
25-
abstract suspend fun close()
26+
abstract fun close()
2627
open fun getTradingDay(): LocalDate
2728
abstract suspend fun subscribeMarketData(codes: Collection<String>, extras: Map<String, Any>? = null)
2829
open suspend fun subscribeMarketData(code: String, extras: Map<String, Any>? = null)
@@ -32,8 +33,8 @@ abstract class BrokerApi(val config: Map<String, Any>, val kEvent: KEvent) {
3233
abstract suspend fun unsubscribeAllMarketData(extras: Map<String, Any>? = null)
3334
abstract suspend fun querySubscriptions(useCache: Boolean = true, extras: Map<String, Any>? = null): List<String>
3435
abstract suspend fun queryLastTick(code: String, useCache: Boolean = true, extras: Map<String, Any>? = null): Tick?
35-
abstract suspend fun querySecurity(code: String, useCache: Boolean = true, extras: Map<String, Any>? = null): Security?
36-
abstract suspend fun queryAllSecurities(useCache: Boolean = true, extras: Map<String, Any>? = null): List<Security>
36+
abstract suspend fun querySecurity(code: String, useCache: Boolean = true, extras: Map<String, Any>? = null): SecurityInfo?
37+
abstract suspend fun queryAllSecurities(useCache: Boolean = true, extras: Map<String, Any>? = null): List<SecurityInfo>
3738
abstract suspend fun queryAssets(useCache: Boolean = true, extras: Map<String, Any>? = null): Assets
3839
abstract suspend fun queryPosition(code: String, direction: Direction, useCache: Boolean = true, extras: Map<String, Any>? = null): Position?
3940
abstract suspend fun queryPositions(code: String? = null, useCache: Boolean = true, extras: Map<String, Any>? = null): List<Position>
@@ -51,6 +52,16 @@ abstract class BrokerApi(val config: Map<String, Any>, val kEvent: KEvent) {
5152
open fun customRequest(method: String, params: Map<String, Any>? = null): Any
5253
open suspend fun customSuspendRequest(method: String, params: Map<String, Any>? = null): Any
5354
}
55+
56+
enum class BrokerEventType {
57+
CUSTOM_EVENT,
58+
LOG,
59+
CONNECTION,
60+
TICK,
61+
ORDER_STATUS,
62+
CANCEL_FAILED,
63+
TRADE_REPORT,
64+
}
5465
```
5566

5667
## 使用说明
@@ -73,7 +84,7 @@ repositories {
7384
}
7485

7586
dependencies {
76-
implementation("org.rationalityfrontline.ktrader:ktrader-broker-api:1.1.2")
87+
implementation("org.rationalityfrontline.ktrader:ktrader-broker-api:1.1.3")
7788
}
7889
```
7990

@@ -83,7 +94,7 @@ dependencies {
8394
<dependency>
8495
<groupId>org.rationalityfrontline.ktrader</groupId>
8596
<artifactId>ktrader-broker-api</artifactId>
86-
<version>1.1.2</version>
97+
<version>1.1.3</version>
8798
</dependency>
8899
```
89100

0 commit comments

Comments
 (0)