lib/xaapiv1/events.go

   1 package xaapiv1
   2
   3 import (
   4         "encoding/json"
   5         "fmt"
   6 )
   7
   8 // EventRegisterArgs is the parameters (json format) of /events/register command
   9 type EventRegisterArgs struct {
  10         Name      string `json:"name"`
  11         ProjectID string `json:"filterProjectID"`
  12 }
  13
  14 // EventUnRegisterArgs is the parameters (json format) of /events/unregister command
  15 type EventUnRegisterArgs struct {
  16         Name string `json:"name"`
  17         ID   int    `json:"id"`
  18 }
  19
  20 // Events Type definitions
  21 const (
  22         // EventTypePrefix Used as event prefix
  23         EventTypePrefix = "event:" // following by event type
  24
  25         // Supported Events type
  26         EVTAll           = EventTypePrefix + "all"
  27         EVTServerConfig  = EventTypePrefix + "server-config"        // type EventMsg with Data type xaapiv1.ServerCfg
  28         EVTProjectAdd    = EventTypePrefix + "project-add"          // type EventMsg with Data type xaapiv1.ProjectConfig
  29         EVTProjectDelete = EventTypePrefix + "project-delete"       // type EventMsg with Data type xaapiv1.ProjectConfig
  30         EVTProjectChange = EventTypePrefix + "project-state-change" // type EventMsg with Data type xaapiv1.ProjectConfig
  31 )
  32
  33 // EVTAllList List of all supported events
  34 var EVTAllList = []string{
  35         EVTServerConfig,
  36         EVTProjectAdd,
  37         EVTProjectDelete,
  38         EVTProjectChange,
  39 }
  40
  41 // EventMsg Event message send over Websocket, data format depend to Type (see DecodeXXX function)
  42 type EventMsg struct {
  43         Time          string      `json:"time"`      // Timestamp
  44         FromSessionID string      `json:"sessionID"` // Session ID of client that emits this event
  45         Type          string      `json:"type"`      // Data type
  46         Data          interface{} `json:"data"`      // Data
  47 }
  48
  49 // DecodeServerCfg Helper to decode Data field type ServerCfg
  50 func (e *EventMsg) DecodeServerCfg() (ServerCfg, error) {
  51         p := ServerCfg{}
  52         if e.Type != EVTServerConfig {
  53                 return p, fmt.Errorf("Invalid type")
  54         }
  55         d, err := json.Marshal(e.Data)
  56         if err == nil {
  57                 err = json.Unmarshal(d, &p)
  58         }
  59         return p, err
  60 }
  61
  62 // DecodeProjectConfig Helper to decode Data field type ProjectConfig
  63 func (e *EventMsg) DecodeProjectConfig() (ProjectConfig, error) {
  64         var err error
  65         p := ProjectConfig{}
  66         switch e.Type {
  67         case EVTProjectAdd, EVTProjectChange, EVTProjectDelete:
  68                 d := []byte{}
  69                 d, err = json.Marshal(e.Data)
  70                 if err == nil {
  71                         err = json.Unmarshal(d, &p)
  72                 }
  73         default:
  74                 err = fmt.Errorf("Invalid type")
  75         }
  76         return p, err
  77 }