lib/xdsserver/folder-interface.go

   1 /*
   2  * Copyright (C) 2017 "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 "github.com/iotbzh/xds-server/lib/xsapiv1"
  21
  22 type FolderEventCBData map[string]interface{}
  23 type FolderEventCB func(cfg *xsapiv1.FolderConfig, data *FolderEventCBData)
  24
  25 // IFOLDER Folder interface
  26 type IFOLDER interface {
  27         NewUID(suffix string) string                                          // Get a new folder UUID
  28         Add(cfg xsapiv1.FolderConfig) (*xsapiv1.FolderConfig, error)              // Add a new folder
  29         GetConfig() xsapiv1.FolderConfig                                        // Get folder public configuration
  30         GetFullPath(dir string) string                                        // Get folder full path
  31         ConvPathCli2Svr(s string) string                                      // Convert path from Client to Server
  32         ConvPathSvr2Cli(s string) string                                      // Convert path from Server to Client
  33         Remove() error                                                        // Remove a folder
  34         Update(cfg xsapiv1.FolderConfig) (*xsapiv1.FolderConfig, error)           // Update a new folder
  35         RegisterEventChange(cb *FolderEventCB, data *FolderEventCBData) error // Request events registration (sent through WS)
  36         UnRegisterEventChange() error                                         // Un-register events
  37         Sync() error                                                          // Force folder files synchronization
  38         IsInSync() (bool, error)                                              // Check if folder files are in-sync
  39 }