Skip to content

Commit 64dbc47

Browse files
k33gk33g
committed
📦 updates MDK for v0.0.2
1 parent 96ffa07 commit 64dbc47

File tree

6 files changed

+188
-4
lines changed

6 files changed

+188
-4
lines changed

‎docs/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Capsule Module SDK
22

33
!!! info "What's new?"
4+
- `v0.0.2`: ✨ Redis support
45
- `v0.0.1`: 🎉 first release
56

67
## What is the Capsule Module SDK alias **Capsule MDK**?

‎handle.json.go

-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ package capsule
33
import "github.com/valyala/fastjson"
44

55

6-
76
var handleJSONFunction func(param *fastjson.Value) ([]byte, error)
87

98
// SetHandleJSON sets the handle function

‎hostfunc.redis.go

+184
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,184 @@
1+
package capsule
2+
3+
import "github.com/valyala/fastjson"
4+
5+
// hostRedisSet sets the value of a redis key.
6+
//
7+
// keyPosition: the position of the key in memory.
8+
// keyLength: the length of the key.
9+
// valueStringPosition: the position of the value string in memory.
10+
// valueStringLength: the length of the value string.
11+
// returnValuePosition: the position of the pointer to the return value in memory.
12+
// returnValueLength: the length of the return value.
13+
//
14+
// Returns the new uint32 value.
15+
//export hostRedisSet
16+
func hostRedisSet(
17+
keyPosition, keyLength uint32,
18+
valueStringPosition, valueStringLength uint32,
19+
returnValuePosition **uint32, returnValueLength *uint32) uint32
20+
21+
22+
// RedisSet sends a message to the host to cache a key and its value.
23+
//
24+
// key: the string value of the key to cache.
25+
// value: the byte slice value to cache.
26+
// []byte: a byte slice that contains the response from the host.
27+
func RedisSet(key string, value []byte) ([]byte, error) {
28+
29+
keyPosition, keyLength := getBufferPosSize([]byte(key))
30+
valueStringPosition, valueStringLength := getBufferPosSize(value)
31+
32+
// This will be use to get the response from the host
33+
var responseBufferPtr *uint32
34+
var responseBufferSize uint32
35+
36+
// Send the lessage to the host
37+
hostCacheSet(
38+
keyPosition, keyLength,
39+
valueStringPosition, valueStringLength,
40+
&responseBufferPtr, &responseBufferSize)
41+
42+
bufferResponseFromHost := readBufferFromMemory(responseBufferPtr, responseBufferSize)
43+
44+
// check if success or failure
45+
data, err := Result(bufferResponseFromHost)
46+
47+
return data, err
48+
}
49+
50+
51+
52+
// hostRedisGet retrieves a Redis key-value pair from the host.
53+
//
54+
// keyPosition: the position of the key in memory.
55+
// keyLength: the length of the key in memory.
56+
// returnValuePosition: a pointer to the position of the return value in memory.
57+
// returnValueLength: a pointer to the length of the return value in memory.
58+
//
59+
// Returns the new function.
60+
//export hostRedisGet
61+
func hostRedisGet(
62+
keyPosition, keyLength uint32,
63+
returnValuePosition **uint32, returnValueLength *uint32) uint32
64+
65+
// RedisGet retrieves the value for the given key from Redis.
66+
//
67+
// It takes a single string parameter, `key`, which is used to identify the value
68+
// to retrieve from Redis.
69+
//
70+
// RedisGet returns a slice of bytes containing the retrieved value, and an error
71+
// if the retrieval failed or the key was not found.
72+
func RedisGet(key string) ([]byte, error) {
73+
74+
keyPosition, keyLength := getBufferPosSize([]byte(key))
75+
76+
// This will be use to get the response from the host
77+
var responseBufferPtr *uint32
78+
var responseBufferSize uint32
79+
80+
// Send the lessage to the host
81+
hostCacheGet(
82+
keyPosition, keyLength,
83+
&responseBufferPtr, &responseBufferSize)
84+
85+
bufferResponseFromHost := readBufferFromMemory(responseBufferPtr, responseBufferSize)
86+
87+
// check if success or failure
88+
data, err := Result(bufferResponseFromHost)
89+
if err != nil {
90+
return nil, err // "key not found"
91+
}
92+
return data, nil
93+
}
94+
95+
96+
97+
98+
// hostRedisDel deletes the Redis key stored at the specified position and returns the length of the deleted key.
99+
//
100+
// keyPosition: the position of the key in Redis.
101+
// keyLength: the length of the key.
102+
// returnValuePosition: a pointer to the position of the return value.
103+
// returnValueLength: a pointer to the length of the return value.
104+
//
105+
// Returns: the length of the deleted key.
106+
//export hostRedisDel
107+
func hostRedisDel(
108+
keyPosition, keyLength uint32,
109+
returnValuePosition **uint32, returnValueLength *uint32) uint32
110+
111+
// RedisDel deletes a Redis key and returns the result as a slice of bytes.
112+
// The key parameter is a string representing the key to be deleted.
113+
// The function returns a slice of bytes and an error.
114+
func RedisDel(key string) ([]byte, error) {
115+
116+
keyPosition, keyLength := getBufferPosSize([]byte(key))
117+
118+
// This will be use to get the response from the host
119+
var responseBufferPtr *uint32
120+
var responseBufferSize uint32
121+
122+
// Send the lessage to the host
123+
hostCacheDel(
124+
keyPosition, keyLength,
125+
&responseBufferPtr, &responseBufferSize)
126+
127+
bufferResponseFromHost := readBufferFromMemory(responseBufferPtr, responseBufferSize)
128+
129+
// check if success or failure
130+
data, err := Result(bufferResponseFromHost)
131+
return data, err
132+
}
133+
134+
// hostRedisKeys returns a uint32 representing the new function.
135+
//
136+
// filterPosition: uint32 representing the filter position.
137+
// filterLength: uint32 representing the filter length.
138+
// returnValuePosition: pointer to uint32 representing the return value position.
139+
// returnValueLength: pointer to uint32 representing the return value length.
140+
//
141+
// Returns a uint32 representing the new function.
142+
//export hostRedisKeys
143+
func hostRedisKeys(
144+
filterPosition, filterLength uint32,
145+
returnValuePosition **uint32, returnValueLength *uint32) uint32
146+
147+
// RedisKeys returns an array of Redis keys that match the given filter.
148+
//
149+
// filter: A string used to filter Redis keys.
150+
// Returns an array of strings and an error.
151+
func RedisKeys(filter string) ([]string, error) {
152+
153+
filterPosition, filterLength := getBufferPosSize([]byte(filter))
154+
155+
// This will be use to get the response from the host
156+
var responseBufferPtr *uint32
157+
var responseBufferSize uint32
158+
159+
// Send the lessage to the host
160+
hostCacheKeys(
161+
filterPosition, filterLength,
162+
&responseBufferPtr, &responseBufferSize)
163+
164+
bufferResponseFromHost := readBufferFromMemory(responseBufferPtr, responseBufferSize)
165+
//! 🤚 this is a json string (array json string: `["Hello", "World"]`)
166+
167+
// check if success or failure
168+
data, err := Result(bufferResponseFromHost)
169+
if err != nil {
170+
return nil, err
171+
}
172+
var jsonParser fastjson.Parser
173+
keysArray, err := jsonParser.Parse(string(data))
174+
if err != nil {
175+
return nil, err
176+
}
177+
var keys []string
178+
for _, key := range keysArray.GetArray("keys") {
179+
keys = append(keys, string(key.GetStringBytes()))
180+
//! if it doesn't work, implement my own simple parser
181+
}
182+
return keys, nil
183+
184+
}

‎samples/simple-hello/go.mod

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ module simple-hello
22

33
go 1.20
44

5-
require github.com/bots-garden/capsule-module-sdk v0.0.1
5+
require github.com/bots-garden/capsule-module-sdk v0.0.2
66

77
require github.com/valyala/fastjson v1.6.4 // indirect
88

‎samples/simple-talk/go.mod

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ module simple-talk
22

33
go 1.20
44

5-
require github.com/bots-garden/capsule-module-sdk v0.0.1
5+
require github.com/bots-garden/capsule-module-sdk v0.0.2
66

77
require github.com/valyala/fastjson v1.6.4 // indirect
88

‎samples/simple.json/go.mod

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ module github.com/bots-garden/capsule-module-sdk/samples/simplejson
22

33
go 1.20
44

5-
require github.com/bots-garden/capsule-module-sdk v0.0.0
5+
require github.com/bots-garden/capsule-module-sdk v0.0.2
66

77
require github.com/valyala/fastjson v1.6.4
88

0 commit comments

Comments
 (0)