1 Star 0 Fork 0

xingyp/cn-infra

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
文件
克隆/下载
api.go 3.08 KB
一键复制 编辑 原始数据 按行查看 历史
// Copyright (c) 2017 Cisco and/or its affiliates.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at:
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package idxmap
import (
"github.com/ligato/cn-infra/core"
)
// NamedMapping is the "user API" to the mapping. It provides read-only access.
type NamedMapping interface {
// GetRegistryTitle returns the title assigned to the registry.
GetRegistryTitle() string
// GetValue retrieves a previously stored item identified by
// <name>. If there is no item associated with the give name in the mapping,
// the <exists> flag is returned as *false*.
GetValue(name string) (value interface{}, exists bool)
// ListNames looks up the items by a secondary index.
// It returns the names of all indexes for which the value of a secondary
// key <field> equals to <value>.
ListNames(field string, value string) (names []string)
// ListAllNames returns all names in the mapping.
ListAllNames() (names []string)
// Watch subscribes to receive notifications about the changes in the
// mapping. To receive changes through a channel, ToChan utility can be used.
//
// Example usage:
//
// map.Watch(plugin.PluginName, ToChan(myChannel))
//
// map.Watch(plugin.PluginName, func(msgNamedMappingGenericEvent) {/*handle callback*/ return nil})
//
Watch(subscriber core.PluginName, callback func(NamedMappingGenericEvent)) error
}
// NamedMappingRW is the "owner API" to the mapping. Using this API the owner
// can modify the content of the mapping.
type NamedMappingRW interface {
NamedMapping
// Put registers a new item into the mapping under the given <name>.
// Name is the primary unique key, if an item was registered before
// it is overwritten.
Put(name string, value interface{})
// Delete removes an item associated with the <name> from the mapping.
Delete(name string) (value interface{}, exists bool)
}
// NamedMappingEvent is a part of the change notification. It is a generic
// part that does not contain metadata of type interface{} thus it can be reused
// in mapping with typed metadata.
type NamedMappingEvent struct {
// The owner plugin of the registry (use also as namespace)
Owner core.PluginName
// Logical name of the object
Name string
// Del denotes a type of change
// - it is true if an item was removed
// - it false if an item was added or updated
Del bool
// RegistryTitle identifies the registry (NameToIndexMapping)
RegistryTitle string
}
// NamedMappingGenericEvent represents a single change in the mapping.
// The structure is created when an item is inserted or removed from the mapping.
type NamedMappingGenericEvent struct {
NamedMappingEvent
Value interface{}
}
Loading...
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/xingyp/cn-infra.git
git@gitee.com:xingyp/cn-infra.git
xingyp
cn-infra
cn-infra
v1.0.4

搜索帮助