lib/xaapiv1/events.go

   1 /*
   2  * Copyright (C) 2017-2018 "IoT.bzh"
   3  * Author Sebastien Douheret <sebastien@iot.bzh>
   4  *
   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
   8  *
   9  *   http://www.apache.org/licenses/LICENSE-2.0
  10  *
  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.
  16  */
  17
  18 package xaapiv1
  19
  20 import (
  21         "encoding/json"
  22         "fmt"
  23 )
  24
  25 // EventRegisterArgs is the parameters (json format) of /events/register command
  26 type EventRegisterArgs struct {
  27         Name      string `json:"name"`
  28         ProjectID string `json:"filterProjectID"`
  29 }
  30
  31 // EventUnRegisterArgs is the parameters (json format) of /events/unregister command
  32 type EventUnRegisterArgs struct {
  33         Name string `json:"name"`
  34         ID   int    `json:"id"`
  35 }
  36
  37 // Events Type definitions
  38 const (
  39         // EventTypePrefix Used as event prefix
  40         EventTypePrefix = "event:" // following by event type
  41
  42         // Supported Events type
  43         EVTAll            = EventTypePrefix + "all"
  44         EVTServerConfig   = EventTypePrefix + "server-config"        // type EventMsg with Data type xaapiv1.ServerCfg
  45         EVTProjectAdd     = EventTypePrefix + "project-add"          // type EventMsg with Data type xaapiv1.ProjectConfig
  46         EVTProjectDelete  = EventTypePrefix + "project-delete"       // type EventMsg with Data type xaapiv1.ProjectConfig
  47         EVTProjectChange  = EventTypePrefix + "project-state-change" // type EventMsg with Data type xaapiv1.ProjectConfig
  48         EVTSDKAdd         = EventTypePrefix + "sdk-add"              // type EventMsg with Data type xaapiv1.SDK
  49         EVTSDKRemove      = EventTypePrefix + "sdk-remove"           // type EventMsg with Data type xaapiv1.SDK
  50         EVTSDKManagement  = EventTypePrefix + "sdk-management"       // type EventMsg with Data type xaapiv1.SDKManagementMsg
  51         EVTSDKStateChange = EventTypePrefix + "sdk-state-change"     // type EventMsg with Data type xaapiv1.SDK
  52 )
  53
  54 // EVTAllList List of all supported events
  55 var EVTAllList = []string{
  56         EVTServerConfig,
  57         EVTProjectAdd,
  58         EVTProjectDelete,
  59         EVTProjectChange,
  60         EVTSDKAdd,
  61         EVTSDKRemove,
  62         EVTSDKManagement,
  63         EVTSDKStateChange,
  64 }
  65
  66 // EventMsg Event message send over Websocket, data format depend to Type (see DecodeXXX function)
  67 type EventMsg struct {
  68         Time          string      `json:"time"`      // Timestamp
  69         FromSessionID string      `json:"sessionID"` // Session ID of client who produce this event
  70         Type          string      `json:"type"`      // Data type
  71         Data          interface{} `json:"data"`      // Data
  72 }
  73
  74 // DecodeServerCfg Helper to decode Data field type ServerCfg
  75 func (e *EventMsg) DecodeServerCfg() (ServerCfg, error) {
  76         p := ServerCfg{}
  77         if e.Type != EVTServerConfig {
  78                 return p, fmt.Errorf("Invalid type")
  79         }
  80         d, err := json.Marshal(e.Data)
  81         if err == nil {
  82                 err = json.Unmarshal(d, &p)
  83         }
  84         return p, err
  85 }
  86
  87 // DecodeProjectConfig Helper to decode Data field type ProjectConfig
  88 func (e *EventMsg) DecodeProjectConfig() (ProjectConfig, error) {
  89         var err error
  90         p := ProjectConfig{}
  91         switch e.Type {
  92         case EVTProjectAdd, EVTProjectChange, EVTProjectDelete:
  93                 d := []byte{}
  94                 d, err = json.Marshal(e.Data)
  95                 if err == nil {
  96                         err = json.Unmarshal(d, &p)
  97                 }
  98         default:
  99                 err = fmt.Errorf("Invalid type")
 100         }
 101         return p, err
 102 }
 103
 104 // DecodeSDKMgtMsg Helper to decode Data field type SDKManagementMsg
 105 func (e *EventMsg) DecodeSDKMgtMsg() (SDKManagementMsg, error) {
 106         var err error
 107         s := SDKManagementMsg{}
 108         if e.Type != EVTSDKManagement {
 109                 return s, fmt.Errorf("Invalid type")
 110         }
 111         d := []byte{}
 112         d, err = json.Marshal(e.Data)
 113         if err == nil {
 114                 err = json.Unmarshal(d, &s)
 115         }
 116         return s, err
 117 }
 118
 119 // DecodeSDKEvent Helper to decode Data field type SDK
 120 func (e *EventMsg) DecodeSDKEvent() (SDK, error) {
 121         var err error
 122         s := SDK{}
 123         switch e.Type {
 124         case EVTSDKAdd, EVTSDKRemove, EVTSDKStateChange:
 125                 d := []byte{}
 126                 d, err = json.Marshal(e.Data)
 127                 if err == nil {
 128                         err = json.Unmarshal(d, &s)
 129                 }
 130         default:
 131                 err = fmt.Errorf("Invalid type")
 132         }
 133         return s, err
 134 }