2 * Copyright (C) 2017-2018 "IoT.bzh"
3 * Author Sebastien Douheret <sebastien@iot.bzh>
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
25 // EventRegisterArgs Parameters (json format) of /events/register command
26 type EventRegisterArgs struct {
27 Name string `json:"name"`
28 Filter string `json:"filter"`
31 // EventUnRegisterArgs Parameters of /events/unregister command
32 type EventUnRegisterArgs struct {
33 Name string `json:"name"`
37 // EventMsg Message send
38 type EventMsg struct {
39 Time string `json:"time"`
40 FromSessionID string `json:"sessionID"` // Session ID of client who produce this event
41 Type string `json:"type"`
42 Data interface{} `json:"data"` // Data
45 // EventEvent Event send in WS when an internal event (eg. Syncthing event is received)
47 // EventTypePrefix Used as event prefix
48 EventTypePrefix = "event:" // following by event type
50 // Supported Events type
51 EVTAll = EventTypePrefix + "all"
53 EVTFolderChange = EventTypePrefix + "folder-change" // type EventMsg with Data type xsapiv1.FolderConfig
54 EVTFolderStateChange = EventTypePrefix + "folder-state-change" // type EventMsg with Data type xsapiv1.FolderConfig
56 EVTSDKAdd = EventTypePrefix + "sdk-add" // type EventMsg with Data type xsapiv1.SDK
57 EVTSDKRemove = EventTypePrefix + "sdk-remove" // type EventMsg with Data type xsapiv1.SDK
58 EVTSDKManagement = EventTypePrefix + "sdk-management" // type EventMsg with Data type xsapiv1.SDKManagementMsg
59 EVTSDKStateChange = EventTypePrefix + "sdk-state-change" // type EventMsg with Data type xsapiv1.SDK
61 EVTTargetAdd = EventTypePrefix + "target-add" // type EventMsg with Data type xsapiv1.TargetConfig
62 EVTTargetRemove = EventTypePrefix + "target-remove" // type EventMsg with Data type xsapiv1.TargetConfig
63 EVTTargetStateChange = EventTypePrefix + "target-state-change" // type EventMsg with Data type xsapiv1.TargetConfig
65 EVTTargetTerminalAdd = EventTypePrefix + "target-terminal-add" // type EventMsg with Data type xsapiv1.TerminalConfig
66 EVTTargetTerminalRemove = EventTypePrefix + "target-terminal-remove" // type EventMsg with Data type xsapiv1.TerminalConfig
67 EVTTargetTerminalStateChange = EventTypePrefix + "target-terminal-state-change" // type EventMsg with Data type xsapiv1.TerminalConfig
70 // EVTAllList List of all supported events
71 var EVTAllList = []string{
82 EVTTargetTerminalRemove,
83 EVTTargetTerminalStateChange,
86 // DecodeFolderConfig Helper to decode Data field type FolderConfig
87 func (e *EventMsg) DecodeFolderConfig() (FolderConfig, error) {
91 case EVTFolderChange, EVTFolderStateChange:
93 d, err = json.Marshal(e.Data)
95 err = json.Unmarshal(d, &f)
98 err = fmt.Errorf("Invalid type")
103 // DecodeSDKEvent Helper to decode Data field type SDK
104 func (e *EventMsg) DecodeSDKEvent() (SDK, error) {
108 case EVTSDKAdd, EVTSDKRemove, EVTSDKStateChange:
110 d, err = json.Marshal(e.Data)
112 err = json.Unmarshal(d, &s)
115 err = fmt.Errorf("Invalid type")
120 // DecodeTargetEvent Helper to decode Data field type TargetConfig
121 func (e *EventMsg) DecodeTargetEvent() (TargetConfig, error) {
125 case EVTTargetAdd, EVTTargetRemove, EVTTargetStateChange:
127 d, err = json.Marshal(e.Data)
129 err = json.Unmarshal(d, &p)
132 err = fmt.Errorf("Invalid type")
137 // DecodeTerminalEvent Helper to decode Data field type TerminalConfig
138 func (e *EventMsg) DecodeTerminalEvent() (TerminalConfig, error) {
140 p := TerminalConfig{}
142 case EVTTargetTerminalAdd, EVTTargetTerminalRemove, EVTTargetTerminalStateChange:
144 d, err = json.Marshal(e.Data)
146 err = json.Unmarshal(d, &p)
149 err = fmt.Errorf("Invalid type")