Wukongim Endpoint
Wukongim Endpoint v0.29.0+ provides a channel message subscription feature based on Wukongim, which passes the subscribed messages to the next node for processing.
TIP
- This component is an extension component and requires an additional extension library: rulego-components (opens new window)
# Type
endpoint/wukongim
# Configuration Parameters
Field | Type | Description | Default Value |
---|---|---|---|
Server | string | Wukongim server address list | tcp://175.27.245.108:15100 |
UID | string | User UID | test1 |
Token | string | Login password | test1 |
ConnectTimeout | int64 | Connection timeout (in seconds) | 5 |
ProtoVersion | int | Protocol version | wkproto.LatestVersion |
PingInterval | int64 | Heartbeat interval (in seconds) | 30 |
Reconnect | bool | Whether to reconnect automatically | true |
AutoAck | bool | Whether to automatically acknowledge messages | true |
# Configuration Example
{
"ruleChain": {
"id": "wGhAZMxoSECp",
"name": "WukongIM Message Subscription",
"debugMode": false,
"root": true,
"disabled": true,
"additionalInfo": {
"createTime": "2025/01/13 10:04:40",
"description": "",
"layoutX": "280",
"layoutY": "280",
"updateTime": "2025/01/13 10:11:24",
"username": "admin"
}
},
"metadata": {
"endpoints": [
{
"id": "node_2",
"additionalInfo": {
"layoutX": 570,
"layoutY": 440
},
"type": "endpoint/wukongim",
"name": "Subscribe",
"debugMode": false,
"configuration": {
"autoAck": true,
"connectTimeout": 5,
"pingInterval": 30,
"protoVersion": 3,
"reconnect": true,
"server": "tcp://175.27.245.108:15100",
"token": "test1",
"uID": "group1"
},
"processors": null,
"routers": [
{
"id": "peywKET4J7YD",
"params": [],
"from": {
"path": "*",
"configuration": null,
"processors": []
},
"to": {
"path": "wGhAZMxoSECp:node_4",
"configuration": null,
"wait": false,
"processors": []
}
}
]
}
],
"nodes": [
{
"id": "node_4",
"additionalInfo": {
"layoutX": 790,
"layoutY": 350
},
"type": "log",
"name": "log",
"debugMode": true,
"configuration": {
"jsScript": "return 'Incoming message:\\n' + JSON.stringify(msg) + '\\nIncoming metadata:\\n' + JSON.stringify(metadata);"
}
}
],
"connections": []
}
}
## Output Parameters
Messages received from the Wukongim server are converted to the RuleMsg format and sent to the rule chain:
data: Message content
dataType: JSON
type: Default is empty
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
Edit this page on GitHub (opens new window)
Last Updated: 2025/01/20, 08:24:31