Skip to content
This repository was archived by the owner on Jan 14, 2022. It is now read-only.

Commit 5c9c018

Browse files
authored
Allow to create custom Request & Response (#6)
The only blocking point when creating custom request & response is that Client.sendRequest() and getMessageID() are private.
1 parent 9047116 commit 5c9c018

15 files changed

+186
-186
lines changed

client.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,8 @@ func SetReceiveTimeout(timeout time.Duration) {
6666
receiveTimeout = timeout
6767
}
6868

69-
// getMessageID generates a string that the client has not yet used.
70-
func getMessageID() string {
69+
// GetMessageID generates a string that the client has not yet used.
70+
func GetMessageID() string {
7171
lock.Lock()
7272
messageID++
7373
id := strconv.Itoa(messageID)

client_requests.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ var (
1414
ErrReceiveTimeout = errors.New("receive timed out")
1515
)
1616

17-
// sendRequest sends a request to the WebSocket server.
18-
func (c *Client) sendRequest(req Request) (chan map[string]interface{}, error) {
17+
// SendRequest sends a request to the WebSocket server.
18+
func (c *Client) SendRequest(req Request) (chan map[string]interface{}, error) {
1919
if !c.connected {
2020
return nil, ErrNotConnected
2121
}

codegen/protocol.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ def gen_request(data: Dict) -> str:
137137
if r.sent {{
138138
return ErrAlreadySent
139139
}}
140-
future, err := c.sendRequest(r)
140+
future, err := c.SendRequest(r)
141141
if err != nil {{
142142
return err
143143
}}
@@ -226,7 +226,7 @@ def gen_request_new(request: Dict):
226226
variables = go_variables(request.get("params", []), export=False)
227227
default_args = f"""
228228
_request{{
229-
ID_: getMessageID(),
229+
ID_: GetMessageID(),
230230
Type_: "{request["name"]}",
231231
err: make(chan error, 1),
232232
}},

requests_general.go

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ type GetVersionRequest struct {
2222
func NewGetVersionRequest() GetVersionRequest {
2323
return GetVersionRequest{
2424
_request{
25-
ID_: getMessageID(),
25+
ID_: GetMessageID(),
2626
Type_: "GetVersion",
2727
err: make(chan error, 1),
2828
},
@@ -35,7 +35,7 @@ func (r *GetVersionRequest) Send(c Client) error {
3535
if r.sent {
3636
return ErrAlreadySent
3737
}
38-
future, err := c.sendRequest(r)
38+
future, err := c.SendRequest(r)
3939
if err != nil {
4040
return err
4141
}
@@ -124,7 +124,7 @@ type GetAuthRequiredRequest struct {
124124
func NewGetAuthRequiredRequest() GetAuthRequiredRequest {
125125
return GetAuthRequiredRequest{
126126
_request{
127-
ID_: getMessageID(),
127+
ID_: GetMessageID(),
128128
Type_: "GetAuthRequired",
129129
err: make(chan error, 1),
130130
},
@@ -137,7 +137,7 @@ func (r *GetAuthRequiredRequest) Send(c Client) error {
137137
if r.sent {
138138
return ErrAlreadySent
139139
}
140-
future, err := c.sendRequest(r)
140+
future, err := c.SendRequest(r)
141141
if err != nil {
142142
return err
143143
}
@@ -222,7 +222,7 @@ func NewAuthenticateRequest(auth string) AuthenticateRequest {
222222
return AuthenticateRequest{
223223
auth,
224224
_request{
225-
ID_: getMessageID(),
225+
ID_: GetMessageID(),
226226
Type_: "Authenticate",
227227
err: make(chan error, 1),
228228
},
@@ -235,7 +235,7 @@ func (r *AuthenticateRequest) Send(c Client) error {
235235
if r.sent {
236236
return ErrAlreadySent
237237
}
238-
future, err := c.sendRequest(r)
238+
future, err := c.SendRequest(r)
239239
if err != nil {
240240
return err
241241
}
@@ -313,7 +313,7 @@ func NewSetHeartbeatRequest(enable bool) SetHeartbeatRequest {
313313
return SetHeartbeatRequest{
314314
enable,
315315
_request{
316-
ID_: getMessageID(),
316+
ID_: GetMessageID(),
317317
Type_: "SetHeartbeat",
318318
err: make(chan error, 1),
319319
},
@@ -326,7 +326,7 @@ func (r *SetHeartbeatRequest) Send(c Client) error {
326326
if r.sent {
327327
return ErrAlreadySent
328328
}
329-
future, err := c.sendRequest(r)
329+
future, err := c.SendRequest(r)
330330
if err != nil {
331331
return err
332332
}
@@ -404,7 +404,7 @@ func NewSetFilenameFormattingRequest(filenameFormatting string) SetFilenameForma
404404
return SetFilenameFormattingRequest{
405405
filenameFormatting,
406406
_request{
407-
ID_: getMessageID(),
407+
ID_: GetMessageID(),
408408
Type_: "SetFilenameFormatting",
409409
err: make(chan error, 1),
410410
},
@@ -417,7 +417,7 @@ func (r *SetFilenameFormattingRequest) Send(c Client) error {
417417
if r.sent {
418418
return ErrAlreadySent
419419
}
420-
future, err := c.sendRequest(r)
420+
future, err := c.SendRequest(r)
421421
if err != nil {
422422
return err
423423
}
@@ -491,7 +491,7 @@ type GetFilenameFormattingRequest struct {
491491
func NewGetFilenameFormattingRequest() GetFilenameFormattingRequest {
492492
return GetFilenameFormattingRequest{
493493
_request{
494-
ID_: getMessageID(),
494+
ID_: GetMessageID(),
495495
Type_: "GetFilenameFormatting",
496496
err: make(chan error, 1),
497497
},
@@ -504,7 +504,7 @@ func (r *GetFilenameFormattingRequest) Send(c Client) error {
504504
if r.sent {
505505
return ErrAlreadySent
506506
}
507-
future, err := c.sendRequest(r)
507+
future, err := c.SendRequest(r)
508508
if err != nil {
509509
return err
510510
}
@@ -581,7 +581,7 @@ type GetStatsRequest struct {
581581
func NewGetStatsRequest() GetStatsRequest {
582582
return GetStatsRequest{
583583
_request{
584-
ID_: getMessageID(),
584+
ID_: GetMessageID(),
585585
Type_: "GetStats",
586586
err: make(chan error, 1),
587587
},
@@ -594,7 +594,7 @@ func (r *GetStatsRequest) Send(c Client) error {
594594
if r.sent {
595595
return ErrAlreadySent
596596
}
597-
future, err := c.sendRequest(r)
597+
future, err := c.SendRequest(r)
598598
if err != nil {
599599
return err
600600
}
@@ -682,7 +682,7 @@ func NewBroadcastCustomMessageRequest(
682682
realm,
683683
data,
684684
_request{
685-
ID_: getMessageID(),
685+
ID_: GetMessageID(),
686686
Type_: "BroadcastCustomMessage",
687687
err: make(chan error, 1),
688688
},
@@ -695,7 +695,7 @@ func (r *BroadcastCustomMessageRequest) Send(c Client) error {
695695
if r.sent {
696696
return ErrAlreadySent
697697
}
698-
future, err := c.sendRequest(r)
698+
future, err := c.SendRequest(r)
699699
if err != nil {
700700
return err
701701
}
@@ -769,7 +769,7 @@ type GetVideoInfoRequest struct {
769769
func NewGetVideoInfoRequest() GetVideoInfoRequest {
770770
return GetVideoInfoRequest{
771771
_request{
772-
ID_: getMessageID(),
772+
ID_: GetMessageID(),
773773
Type_: "GetVideoInfo",
774774
err: make(chan error, 1),
775775
},
@@ -782,7 +782,7 @@ func (r *GetVideoInfoRequest) Send(c Client) error {
782782
if r.sent {
783783
return ErrAlreadySent
784784
}
785-
future, err := c.sendRequest(r)
785+
future, err := c.SendRequest(r)
786786
if err != nil {
787787
return err
788788
}

requests_outputs.go

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ type ListOutputsRequest struct {
2222
func NewListOutputsRequest() ListOutputsRequest {
2323
return ListOutputsRequest{
2424
_request{
25-
ID_: getMessageID(),
25+
ID_: GetMessageID(),
2626
Type_: "ListOutputs",
2727
err: make(chan error, 1),
2828
},
@@ -35,7 +35,7 @@ func (r *ListOutputsRequest) Send(c Client) error {
3535
if r.sent {
3636
return ErrAlreadySent
3737
}
38-
future, err := c.sendRequest(r)
38+
future, err := c.SendRequest(r)
3939
if err != nil {
4040
return err
4141
}
@@ -116,7 +116,7 @@ func NewGetOutputInfoRequest(outputName string) GetOutputInfoRequest {
116116
return GetOutputInfoRequest{
117117
outputName,
118118
_request{
119-
ID_: getMessageID(),
119+
ID_: GetMessageID(),
120120
Type_: "GetOutputInfo",
121121
err: make(chan error, 1),
122122
},
@@ -129,7 +129,7 @@ func (r *GetOutputInfoRequest) Send(c Client) error {
129129
if r.sent {
130130
return ErrAlreadySent
131131
}
132-
future, err := c.sendRequest(r)
132+
future, err := c.SendRequest(r)
133133
if err != nil {
134134
return err
135135
}
@@ -210,7 +210,7 @@ func NewStartOutputRequest(outputName string) StartOutputRequest {
210210
return StartOutputRequest{
211211
outputName,
212212
_request{
213-
ID_: getMessageID(),
213+
ID_: GetMessageID(),
214214
Type_: "StartOutput",
215215
err: make(chan error, 1),
216216
},
@@ -223,7 +223,7 @@ func (r *StartOutputRequest) Send(c Client) error {
223223
if r.sent {
224224
return ErrAlreadySent
225225
}
226-
future, err := c.sendRequest(r)
226+
future, err := c.SendRequest(r)
227227
if err != nil {
228228
return err
229229
}
@@ -308,7 +308,7 @@ func NewStopOutputRequest(
308308
outputName,
309309
force,
310310
_request{
311-
ID_: getMessageID(),
311+
ID_: GetMessageID(),
312312
Type_: "StopOutput",
313313
err: make(chan error, 1),
314314
},
@@ -321,7 +321,7 @@ func (r *StopOutputRequest) Send(c Client) error {
321321
if r.sent {
322322
return ErrAlreadySent
323323
}
324-
future, err := c.sendRequest(r)
324+
future, err := c.SendRequest(r)
325325
if err != nil {
326326
return err
327327
}

requests_profiles.go

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ func NewSetCurrentProfileRequest(profileName string) SetCurrentProfileRequest {
2626
return SetCurrentProfileRequest{
2727
profileName,
2828
_request{
29-
ID_: getMessageID(),
29+
ID_: GetMessageID(),
3030
Type_: "SetCurrentProfile",
3131
err: make(chan error, 1),
3232
},
@@ -39,7 +39,7 @@ func (r *SetCurrentProfileRequest) Send(c Client) error {
3939
if r.sent {
4040
return ErrAlreadySent
4141
}
42-
future, err := c.sendRequest(r)
42+
future, err := c.SendRequest(r)
4343
if err != nil {
4444
return err
4545
}
@@ -113,7 +113,7 @@ type GetCurrentProfileRequest struct {
113113
func NewGetCurrentProfileRequest() GetCurrentProfileRequest {
114114
return GetCurrentProfileRequest{
115115
_request{
116-
ID_: getMessageID(),
116+
ID_: GetMessageID(),
117117
Type_: "GetCurrentProfile",
118118
err: make(chan error, 1),
119119
},
@@ -126,7 +126,7 @@ func (r *GetCurrentProfileRequest) Send(c Client) error {
126126
if r.sent {
127127
return ErrAlreadySent
128128
}
129-
future, err := c.sendRequest(r)
129+
future, err := c.SendRequest(r)
130130
if err != nil {
131131
return err
132132
}
@@ -203,7 +203,7 @@ type ListProfilesRequest struct {
203203
func NewListProfilesRequest() ListProfilesRequest {
204204
return ListProfilesRequest{
205205
_request{
206-
ID_: getMessageID(),
206+
ID_: GetMessageID(),
207207
Type_: "ListProfiles",
208208
err: make(chan error, 1),
209209
},
@@ -216,7 +216,7 @@ func (r *ListProfilesRequest) Send(c Client) error {
216216
if r.sent {
217217
return ErrAlreadySent
218218
}
219-
future, err := c.sendRequest(r)
219+
future, err := c.SendRequest(r)
220220
if err != nil {
221221
return err
222222
}

0 commit comments

Comments
 (0)