lib/xdsserver/folder-interface.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 "gerrit.automotivelinux.org/gerrit/src/xds/xds-server.git/lib/xsapiv1"
  21
  22 // FolderEventCBData Data format of FolderEvent events
  23 type FolderEventCBData map[string]interface{}
  24
  25 // FolderEventCB Callback prototype for FolderEvent events
  26 type FolderEventCB func(cfg *xsapiv1.FolderConfig, data *FolderEventCBData)
  27
  28 // IFOLDER Folder interface
  29 type IFOLDER interface {
  30         NewUID(suffix string) string                                    // Get a new folder UUID
  31         Add(cfg xsapiv1.FolderConfig) (*xsapiv1.FolderConfig, error)    // Add a new folder
  32         Setup(prj xsapiv1.FolderConfig) (*xsapiv1.FolderConfig, error)  // Local setup of the folder
  33         GetConfig() xsapiv1.FolderConfig                                // Get folder public configuration
  34         GetFullPath(dir string) string                                  // Get folder full path
  35         ConvPathCli2Svr(s string) string                                // Convert path from Client to Server
  36         ConvPathSvr2Cli(s string) string                                // Convert path from Server to Client
  37         Remove() error                                                  // Remove a folder
  38         Update(cfg xsapiv1.FolderConfig) (*xsapiv1.FolderConfig, error) // Update a new folder
  39         Sync() error                                                    // Force folder files synchronization
  40         IsInSync() (bool, error)                                        // Check if folder files are in-sync
  41 }