entities

Documentation

Index

• func Module() fx.Option
• func RegisterEntitiesService(in RegisterEntitiesServiceIn) error
• type Entities
  • func NewEntities() *Entities
  • func (e *Entities) Clear()
  • func (e *Entities) GetByIP(entityIP string) (Entity, error)
  • func (e *Entities) GetByName(entityName string) (Entity, error)
  • func (e *Entities) GetEntities() *entitiesv1.Entities
  • func (e *Entities) Put(entity Entity)
  • func (e *Entities) PutForTest(entity *entitiesv1.Entity)
  • func (e *Entities) Remove(entity Entity) bool
• type EntitiesService
  • func (c *EntitiesService) GetEntities(ctx context.Context, _ *emptypb.Empty) (*entitiesv1.Entities, error)
  • func (c *EntitiesService) GetEntityByIPAddress(ctx context.Context, req *entitiesv1.GetEntityByIPAddressRequest) (*entitiesv1.Entity, error)
  • func (c *EntitiesService) GetEntityByName(ctx context.Context, req *entitiesv1.GetEntityByNameRequest) (*entitiesv1.Entity, error)
  • func (c *EntitiesService) ListDiscoveryEntities(ctx context.Context, _ *cmdv1.ListDiscoveryEntitiesRequest) (*cmdv1.ListDiscoveryEntitiesAgentResponse, error)
  • func (c *EntitiesService) ListDiscoveryEntity(ctx context.Context, req *cmdv1.ListDiscoveryEntityRequest) (*cmdv1.ListDiscoveryEntityAgentResponse, error)
• type Entity
  • func NewEntity(entity *entitiesv1.Entity) Entity
  • func NewEntityFromImmutable(entity *entitiesv1.Entity) Entity
  • func (e Entity) Clone() *entitiesv1.Entity
  • func (e Entity) IPAddress() string
  • func (e Entity) Name() string
  • func (e Entity) Namespace() string
  • func (e Entity) NodeName() string
  • func (e Entity) Services() []string
  • func (e Entity) UID() string
• type EntityTrackers
  • func (et *EntityTrackers) HasDiscovery() bool
  • func (et *EntityTrackers) RegisterServiceDiscovery(name string) notifiers.EventWriter
  • func (et *EntityTrackers) Watcher() notifiers.Watcher
• type FxIn
• type RegisterEntitiesServiceIn

Functions

func Module

func Module() fx.Option

Module sets up Entities with Fx.

func RegisterEntitiesService

func RegisterEntitiesService(in RegisterEntitiesServiceIn) error

RegisterEntitiesService registers a service for entity cache.

Types

type Entities

type Entities struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

Entities maps IP addresses and Entity names to entities.

func NewEntities

func NewEntities() *Entities

NewEntities creates a new, empty Entities.

func (*Entities) Clear

func (e *Entities) Clear()

Clear removes all entities from the cache.

func (*Entities) GetByIP

func (e *Entities) GetByIP(entityIP string) (Entity, error)

GetByIP retrieves entity with a given IP address.

func (*Entities) GetByName

func (e *Entities) GetByName(entityName string) (Entity, error)

GetByName retrieves entity with a given name.

func (*Entities) GetEntities

func (e *Entities) GetEntities() *entitiesv1.Entities

GetEntities returns *entitiesv1.EntitiyCache entities.

func (*Entities) Put

func (e *Entities) Put(entity Entity)

Put maps given IP address and name to the entity it currently represents.

func (*Entities) PutForTest

func (e *Entities) PutForTest(entity *entitiesv1.Entity)

PutForTest maps given IP address and name to the entity it currently represents.

func (*Entities) Remove

func (e *Entities) Remove(entity Entity) bool

Remove removes entity from the cache and returns `true` if any of IP address or name mapping exists. If no such entity was found, returns `false`.

type EntitiesService

type EntitiesService struct {
	entitiesv1.UnimplementedEntitiesServiceServer
	// contains filtered or unexported fields
}

EntitiesService is the implementation of entitiesv1.EntitiesService interface.

func (*EntitiesService) GetEntities

func (c *EntitiesService) GetEntities(ctx context.Context, _ *emptypb.Empty) (*entitiesv1.Entities, error)

GetEntities returns *entitiesv1.Entities which contains mappings of ip address to entity and entity name to entity.

func (*EntitiesService) GetEntityByIPAddress

func (c *EntitiesService) GetEntityByIPAddress(ctx context.Context, req *entitiesv1.GetEntityByIPAddressRequest) (*entitiesv1.Entity, error)

GetEntityByIPAddress returns an entity by IP address.

func (*EntitiesService) GetEntityByName

func (c *EntitiesService) GetEntityByName(ctx context.Context, req *entitiesv1.GetEntityByNameRequest) (*entitiesv1.Entity, error)

GetEntityByName returns an entity by name.

func (*EntitiesService) ListDiscoveryEntities

func (c *EntitiesService) ListDiscoveryEntities(ctx context.Context, _ *cmdv1.ListDiscoveryEntitiesRequest) (*cmdv1.ListDiscoveryEntitiesAgentResponse, error)

ListDiscoveryEntities lists currently discovered entities by IP address.

func (*EntitiesService) ListDiscoveryEntity

func (c *EntitiesService) ListDiscoveryEntity(ctx context.Context, req *cmdv1.ListDiscoveryEntityRequest) (*cmdv1.ListDiscoveryEntityAgentResponse, error)

ListDiscoveryEntity returns an entity by IP address or name.

type Entity

type Entity struct {
	// contains filtered or unexported fields
}

Entity is an immutable wrapper over *entitiesv1.Entity.

func NewEntity

func NewEntity(entity *entitiesv1.Entity) Entity

NewEntity creates a new immutable entity from the copy of given entity.

func NewEntityFromImmutable

func NewEntityFromImmutable(entity *entitiesv1.Entity) Entity

NewEntityFromImmutable creates a new immutable entity, assuming given entity is immutable.

This allows avoiding a copy compared to NewEntity.

func (Entity) Clone

func (e Entity) Clone() *entitiesv1.Entity

Clone returns a mutable copy of the entity.

func (Entity) IPAddress

func (e Entity) IPAddress() string

IPAddress returns the entity's IP address.

func (Entity) Name

func (e Entity) Name() string

Name returns the entity's name.

func (Entity) Namespace

func (e Entity) Namespace() string

Namespace returns the entity's namespace.

func (Entity) NodeName

func (e Entity) NodeName() string

NodeName returns the entity's node name.

func (Entity) Services

func (e Entity) Services() []string

Services returns list of services the entity belongs to.

The returned slice must not be modified.

func (Entity) UID

func (e Entity) UID() string

UID returns the entity's UID.

type EntityTrackers

type EntityTrackers struct {
	// contains filtered or unexported fields
}

EntityTrackers allows to register a service discovery for entity cache

Intended to be used during FX initialization.

func (*EntityTrackers) HasDiscovery

func (et *EntityTrackers) HasDiscovery() bool

HasDiscovery returns whether RegisterServiceDiscovery was called before.

func (*EntityTrackers) RegisterServiceDiscovery

func (et *EntityTrackers) RegisterServiceDiscovery(name string) notifiers.EventWriter

RegisterServiceDiscovery registers service discovery for entity cache and returns an EventWriter to push discovery events into.

Keys passed to EventWriter should not be prefixed.

Should be called at FX provide/invoke stage.

func (*EntityTrackers) Watcher

func (et *EntityTrackers) Watcher() notifiers.Watcher

Watcher returns watcher that watches all events from registered service discoveries.

type FxIn

type FxIn struct {
	fx.In
	Lifecycle      fx.Lifecycle
	EntityTrackers notifiers.Trackers `name:"entity_trackers_private"`
}

FxIn are the parameters for ProvideEntities.

type RegisterEntitiesServiceIn

type RegisterEntitiesServiceIn struct {
	fx.In
	Server   *grpc.Server `name:"default"`
	Cache    *Entities
	Registry *rpc.HandlerRegistry
}

RegisterEntitiesServiceIn bundles and annotates parameters.