代码拉取完成,页面将自动刷新
// 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{}
}
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。