metadata

Documentation

Index

• Variables
• func RegisterMetadataTestServer(srv *gorums.Server, impl MetadataTest)
• type Configuration
  • func (c Configuration) And(d *Configuration) gorums.NodeListOption
  • func (c Configuration) Except(rm *Configuration) gorums.NodeListOption
  • func (c *Configuration) Nodes() []*Node
• type IPAddr
  • func (*IPAddr) Descriptor() ([]byte, []int)
  • func (x *IPAddr) GetAddr() string
  • func (*IPAddr) ProtoMessage()
  • func (x *IPAddr) ProtoReflect() protoreflect.Message
  • func (x *IPAddr) Reset()
  • func (x *IPAddr) String() string
• type Manager
  • func NewManager(opts ...gorums.ManagerOption) (mgr *Manager)
  • func (m *Manager) NewConfiguration(opts ...gorums.ConfigOption) (c *Configuration, err error)
  • func (m *Manager) Nodes() []*Node
• type MetadataTest
• type Node
  • func (n *Node) IDFromMD(ctx context.Context, in *emptypb.Empty) (resp *NodeID, err error)
  • func (n *Node) WhatIP(ctx context.Context, in *emptypb.Empty) (resp *IPAddr, err error)
• type NodeID
  • func (*NodeID) Descriptor() ([]byte, []int)
  • func (x *NodeID) GetID() uint32
  • func (*NodeID) ProtoMessage()
  • func (x *NodeID) ProtoReflect() protoreflect.Message
  • func (x *NodeID) Reset()
  • func (x *NodeID) String() string
• type QuorumSpec

Variables

var File_metadata_metadata_proto protoreflect.FileDescriptor

Functions

func RegisterMetadataTestServer

func RegisterMetadataTestServer(srv *gorums.Server, impl MetadataTest)

Types

type Configuration

type Configuration struct {
	gorums.Configuration
	// contains filtered or unexported fields
}

A Configuration represents a static set of nodes on which quorum remote procedure calls may be invoked.

func (Configuration) And

func (c Configuration) And(d *Configuration) gorums.NodeListOption

And returns a NodeListOption that can be used to create a new configuration combining c and d.

func (Configuration) Except

func (c Configuration) Except(rm *Configuration) gorums.NodeListOption

Except returns a NodeListOption that can be used to create a new configuration from c without the nodes in rm.

func (*Configuration) Nodes

func (c *Configuration) Nodes() []*Node

Nodes returns a slice of each available node. IDs are returned in the same order as they were provided in the creation of the Manager.

type IPAddr

type IPAddr struct {
	Addr string `protobuf:"bytes,1,opt,name=Addr,proto3" json:"Addr,omitempty"`
	// contains filtered or unexported fields
}

func (*IPAddr) Descriptor

func (*IPAddr) Descriptor() ([]byte, []int)

Deprecated: Use IPAddr.ProtoReflect.Descriptor instead.

func (*IPAddr) GetAddr

func (x *IPAddr) GetAddr() string

func (*IPAddr) ProtoMessage

func (*IPAddr) ProtoMessage()

func (*IPAddr) ProtoReflect

func (x *IPAddr) ProtoReflect() protoreflect.Message

func (*IPAddr) Reset

func (x *IPAddr) Reset()

func (*IPAddr) String

func (x *IPAddr) String() string

type Manager

type Manager struct {
	*gorums.Manager
}

Manager maintains a connection pool of nodes on which quorum calls can be performed.

func NewManager

func NewManager(opts ...gorums.ManagerOption) (mgr *Manager)

NewManager returns a new Manager for managing connection to nodes added to the manager. This function accepts manager options used to configure various aspects of the manager.

func (*Manager) NewConfiguration

func (m *Manager) NewConfiguration(opts ...gorums.ConfigOption) (c *Configuration, err error)

NewConfiguration returns a configuration based on the provided list of nodes (required) and an optional quorum specification. The QuorumSpec is necessary for call types that must process replies. For configurations only used for unicast or multicast call types, a QuorumSpec is not needed. The QuorumSpec interface is also a ConfigOption. Nodes can be supplied using WithNodeMap or WithNodeList, or WithNodeIDs. A new configuration can also be created from an existing configuration, using the And, WithNewNodes, Except, and WithoutNodes methods.

func (*Manager) Nodes

func (m *Manager) Nodes() []*Node

Nodes returns a slice of available nodes on this manager. IDs are returned in the order they were added at creation of the manager.

type MetadataTest

type MetadataTest interface {
	IDFromMD(context.Context, *emptypb.Empty, func(*NodeID, error))
	WhatIP(context.Context, *emptypb.Empty, func(*IPAddr, error))
}

MetadataTest is the server-side API for the MetadataTest Service

type Node

type Node struct {
	*gorums.Node
}

func (*Node) IDFromMD

func (n *Node) IDFromMD(ctx context.Context, in *emptypb.Empty) (resp *NodeID, err error)

IDFromMD returns the 'id' field from the metadata.

func (*Node) WhatIP

func (n *Node) WhatIP(ctx context.Context, in *emptypb.Empty) (resp *IPAddr, err error)

WhatIP returns the address of the client that calls it.

type NodeID

type NodeID struct {
	ID uint32 `protobuf:"varint,1,opt,name=ID,proto3" json:"ID,omitempty"`
	// contains filtered or unexported fields
}

func (*NodeID) Descriptor

func (*NodeID) Descriptor() ([]byte, []int)

Deprecated: Use NodeID.ProtoReflect.Descriptor instead.

func (*NodeID) GetID

func (x *NodeID) GetID() uint32

func (*NodeID) ProtoMessage

func (*NodeID) ProtoMessage()

func (*NodeID) ProtoReflect

func (x *NodeID) ProtoReflect() protoreflect.Message

func (*NodeID) Reset

func (x *NodeID) Reset()

func (*NodeID) String

func (x *NodeID) String() string

type QuorumSpec

type QuorumSpec interface {
	gorums.ConfigOption
}

QuorumSpec is the interface of quorum functions for MetadataTest.