lib/xdsserver/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 xdsserver
  19
  20 import (
  21         "fmt"
  22         "time"
  23
  24         "gerrit.automotivelinux.org/gerrit/src/xds/xds-server/lib/xsapiv1"
  25 )
  26
  27 // EventDef Definition on one event
  28 type EventDef struct {
  29         sids map[string]int
  30 }
  31
  32 // Events Hold registered events per context
  33 type Events struct {
  34         *Context
  35         eventsMap map[string]*EventDef
  36 }
  37
  38 // EventsConstructor creates an instance of Events
  39 func EventsConstructor(ctx *Context) *Events {
  40         evMap := make(map[string]*EventDef)
  41         for _, ev := range xsapiv1.EVTAllList {
  42                 evMap[ev] = &EventDef{
  43                         sids: make(map[string]int),
  44                 }
  45         }
  46         return &Events{
  47                 Context:   ctx,
  48                 eventsMap: evMap,
  49         }
  50 }
  51
  52 // GetList returns the list of all supported events
  53 func (e *Events) GetList() []string {
  54         return xsapiv1.EVTAllList
  55 }
  56
  57 // Register Used by a client/session to register to a specific (or all) event(s)
  58 func (e *Events) Register(evName, sessionID string) error {
  59         evs := xsapiv1.EVTAllList
  60         if evName != xsapiv1.EVTAll {
  61                 if _, ok := e.eventsMap[evName]; !ok {
  62                         return fmt.Errorf("Unsupported event type name")
  63                 }
  64                 evs = []string{evName}
  65         }
  66         for _, ev := range evs {
  67                 e.eventsMap[ev].sids[sessionID]++
  68         }
  69         return nil
  70 }
  71
  72 // UnRegister Used by a client/session to un-register event(s)
  73 func (e *Events) UnRegister(evName, sessionID string) error {
  74         evs := xsapiv1.EVTAllList
  75         if evName != xsapiv1.EVTAll {
  76                 if _, ok := e.eventsMap[evName]; !ok {
  77                         return fmt.Errorf("Unsupported event type name")
  78                 }
  79                 evs = []string{evName}
  80         }
  81         for _, ev := range evs {
  82                 if _, exist := e.eventsMap[ev].sids[sessionID]; exist {
  83                         delete(e.eventsMap[ev].sids, sessionID)
  84                         break
  85                 }
  86         }
  87         return nil
  88 }
  89
  90 // Emit Used to manually emit an event
  91 func (e *Events) Emit(evName string, data interface{}, fromSessID string) error {
  92         var firstErr error
  93
  94         if _, ok := e.eventsMap[evName]; !ok {
  95                 return fmt.Errorf("Unsupported event type")
  96         }
  97
  98         firstErr = nil
  99         evm := e.eventsMap[evName]
 100         e.LogSillyf("Emit Event %s: len(sids)=%d, data=%v", evName, len(evm.sids), data)
 101         for sid := range evm.sids {
 102                 so := e.sessions.IOSocketGet(sid)
 103                 if so == nil {
 104                         if firstErr == nil {
 105                                 firstErr = fmt.Errorf("IOSocketGet return nil (SID=%v)", sid)
 106                         }
 107                         continue
 108                 }
 109                 msg := xsapiv1.EventMsg{
 110                         Time:          time.Now().String(),
 111                         FromSessionID: fromSessID,
 112                         Type:          evName,
 113                         Data:          data,
 114                 }
 115                 e.Log.Debugf("Emit Event %s: %v", evName, sid)
 116                 if err := (*so).Emit(evName, msg); err != nil {
 117                         e.Log.Errorf("WS Emit %v error : %v", evName, err)
 118                         if firstErr == nil {
 119                                 firstErr = err
 120                         }
 121                 }
 122         }
 123
 124         return firstErr
 125 }