Refit source files to have a public xs-apiv1 lib package.

[src/xds/xds-server.git] / lib / xdsserver / folder-interface.go

diff --git a/lib/xdsserver/folder-interface.go b/lib/xdsserver/folder-interface.go
new file mode 100644 (file)
index 0000000..c2b2ada
--- /dev/null
+++ b/lib/xdsserver/folder-interface.go
@@ -0,0 +1,22 @@
+package xdsserver
+
+import "github.com/iotbzh/xds-server/lib/xsapiv1"
+
+type FolderEventCBData map[string]interface{}
+type FolderEventCB func(cfg *xsapiv1.FolderConfig, data *FolderEventCBData)
+
+// IFOLDER Folder interface
+type IFOLDER interface {
+       NewUID(suffix string) string                                          // Get a new folder UUID
+       Add(cfg xsapiv1.FolderConfig) (*xsapiv1.FolderConfig, error)              // Add a new folder
+       GetConfig() xsapiv1.FolderConfig                                        // Get folder public configuration
+       GetFullPath(dir string) string                                        // Get folder full path
+       ConvPathCli2Svr(s string) string                                      // Convert path from Client to Server
+       ConvPathSvr2Cli(s string) string                                      // Convert path from Server to Client
+       Remove() error                                                        // Remove a folder
+       Update(cfg xsapiv1.FolderConfig) (*xsapiv1.FolderConfig, error)           // Update a new folder
+       RegisterEventChange(cb *FolderEventCB, data *FolderEventCBData) error // Request events registration (sent through WS)
+       UnRegisterEventChange() error                                         // Un-register events
+       Sync() error                                                          // Force folder files synchronization
+       IsInSync() (bool, error)                                              // Check if folder files are in-sync
+}