go_micro_network

package
v1.18.3-focal Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 9, 2022 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func RegisterNetworkHandler

func RegisterNetworkHandler(s server.Server, hdlr NetworkHandler, opts ...server.HandlerOption) error

Types

type Close

type Close struct {
	// network node
	Node                 *Node    `protobuf:"bytes,1,opt,name=node,proto3" json:"node,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Close is sent when the node disconnects from the network

func (*Close) Descriptor

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

func (*Close) GetNode

func (m *Close) GetNode() *Node

func (*Close) ProtoMessage

func (*Close) ProtoMessage()

func (*Close) Reset

func (m *Close) Reset()

func (*Close) String

func (m *Close) String() string

func (*Close) XXX_DiscardUnknown

func (m *Close) XXX_DiscardUnknown()

func (*Close) XXX_Marshal

func (m *Close) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Close) XXX_Merge

func (m *Close) XXX_Merge(src proto.Message)

func (*Close) XXX_Size

func (m *Close) XXX_Size() int

func (*Close) XXX_Unmarshal

func (m *Close) XXX_Unmarshal(b []byte) error

type Connect

type Connect struct {
	// network mode
	Node                 *Node    `protobuf:"bytes,1,opt,name=node,proto3" json:"node,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Connect is sent when the node connects to the network

func (*Connect) Descriptor

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

func (*Connect) GetNode

func (m *Connect) GetNode() *Node

func (*Connect) ProtoMessage

func (*Connect) ProtoMessage()

func (*Connect) Reset

func (m *Connect) Reset()

func (*Connect) String

func (m *Connect) String() string

func (*Connect) XXX_DiscardUnknown

func (m *Connect) XXX_DiscardUnknown()

func (*Connect) XXX_Marshal

func (m *Connect) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Connect) XXX_Merge

func (m *Connect) XXX_Merge(src proto.Message)

func (*Connect) XXX_Size

func (m *Connect) XXX_Size() int

func (*Connect) XXX_Unmarshal

func (m *Connect) XXX_Unmarshal(b []byte) error

type ConnectRequest

type ConnectRequest struct {
	Nodes                []*Node  `protobuf:"bytes,1,rep,name=nodes,proto3" json:"nodes,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*ConnectRequest) Descriptor

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

func (*ConnectRequest) GetNodes

func (m *ConnectRequest) GetNodes() []*Node

func (*ConnectRequest) ProtoMessage

func (*ConnectRequest) ProtoMessage()

func (*ConnectRequest) Reset

func (m *ConnectRequest) Reset()

func (*ConnectRequest) String

func (m *ConnectRequest) String() string

func (*ConnectRequest) XXX_DiscardUnknown

func (m *ConnectRequest) XXX_DiscardUnknown()

func (*ConnectRequest) XXX_Marshal

func (m *ConnectRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ConnectRequest) XXX_Merge

func (m *ConnectRequest) XXX_Merge(src proto.Message)

func (*ConnectRequest) XXX_Size

func (m *ConnectRequest) XXX_Size() int

func (*ConnectRequest) XXX_Unmarshal

func (m *ConnectRequest) XXX_Unmarshal(b []byte) error

type ConnectResponse

type ConnectResponse struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*ConnectResponse) Descriptor

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

func (*ConnectResponse) ProtoMessage

func (*ConnectResponse) ProtoMessage()

func (*ConnectResponse) Reset

func (m *ConnectResponse) Reset()

func (*ConnectResponse) String

func (m *ConnectResponse) String() string

func (*ConnectResponse) XXX_DiscardUnknown

func (m *ConnectResponse) XXX_DiscardUnknown()

func (*ConnectResponse) XXX_Marshal

func (m *ConnectResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ConnectResponse) XXX_Merge

func (m *ConnectResponse) XXX_Merge(src proto.Message)

func (*ConnectResponse) XXX_Size

func (m *ConnectResponse) XXX_Size() int

func (*ConnectResponse) XXX_Unmarshal

func (m *ConnectResponse) XXX_Unmarshal(b []byte) error

type GraphRequest

type GraphRequest struct {
	// node topology depth
	Depth                uint32   `protobuf:"varint,1,opt,name=depth,proto3" json:"depth,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*GraphRequest) Descriptor

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

func (*GraphRequest) GetDepth

func (m *GraphRequest) GetDepth() uint32

func (*GraphRequest) ProtoMessage

func (*GraphRequest) ProtoMessage()

func (*GraphRequest) Reset

func (m *GraphRequest) Reset()

func (*GraphRequest) String

func (m *GraphRequest) String() string

func (*GraphRequest) XXX_DiscardUnknown

func (m *GraphRequest) XXX_DiscardUnknown()

func (*GraphRequest) XXX_Marshal

func (m *GraphRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GraphRequest) XXX_Merge

func (m *GraphRequest) XXX_Merge(src proto.Message)

func (*GraphRequest) XXX_Size

func (m *GraphRequest) XXX_Size() int

func (*GraphRequest) XXX_Unmarshal

func (m *GraphRequest) XXX_Unmarshal(b []byte) error

type GraphResponse

type GraphResponse struct {
	Root                 *Peer    `protobuf:"bytes,1,opt,name=root,proto3" json:"root,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*GraphResponse) Descriptor

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

func (*GraphResponse) GetRoot

func (m *GraphResponse) GetRoot() *Peer

func (*GraphResponse) ProtoMessage

func (*GraphResponse) ProtoMessage()

func (*GraphResponse) Reset

func (m *GraphResponse) Reset()

func (*GraphResponse) String

func (m *GraphResponse) String() string

func (*GraphResponse) XXX_DiscardUnknown

func (m *GraphResponse) XXX_DiscardUnknown()

func (*GraphResponse) XXX_Marshal

func (m *GraphResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GraphResponse) XXX_Merge

func (m *GraphResponse) XXX_Merge(src proto.Message)

func (*GraphResponse) XXX_Size

func (m *GraphResponse) XXX_Size() int

func (*GraphResponse) XXX_Unmarshal

func (m *GraphResponse) XXX_Unmarshal(b []byte) error

type NetworkHandler

type NetworkHandler interface {
	// Connect to the network
	Connect(context.Context, *ConnectRequest, *ConnectResponse) error
	// Returns the entire network graph
	Graph(context.Context, *GraphRequest, *GraphResponse) error
	// Returns a list of known nodes in the network
	Nodes(context.Context, *NodesRequest, *NodesResponse) error
	// Returns a list of known routes in the network
	Routes(context.Context, *RoutesRequest, *RoutesResponse) error
	// Returns a list of known services based on routes
	Services(context.Context, *ServicesRequest, *ServicesResponse) error
}

type NetworkService

type NetworkService interface {
	// Connect to the network
	Connect(ctx context.Context, in *ConnectRequest, opts ...client.CallOption) (*ConnectResponse, error)
	// Returns the entire network graph
	Graph(ctx context.Context, in *GraphRequest, opts ...client.CallOption) (*GraphResponse, error)
	// Returns a list of known nodes in the network
	Nodes(ctx context.Context, in *NodesRequest, opts ...client.CallOption) (*NodesResponse, error)
	// Returns a list of known routes in the network
	Routes(ctx context.Context, in *RoutesRequest, opts ...client.CallOption) (*RoutesResponse, error)
	// Returns a list of known services based on routes
	Services(ctx context.Context, in *ServicesRequest, opts ...client.CallOption) (*ServicesResponse, error)
}

func NewNetworkService

func NewNetworkService(name string, c client.Client) NetworkService

type Node

type Node struct {
	// node id
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// node address
	Address string `protobuf:"bytes,2,opt,name=address,proto3" json:"address,omitempty"`
	// the network
	Network string `protobuf:"bytes,3,opt,name=network,proto3" json:"network,omitempty"`
	// associated metadata
	Metadata             map[string]string `` /* 157-byte string literal not displayed */
	XXX_NoUnkeyedLiteral struct{}          `json:"-"`
	XXX_unrecognized     []byte            `json:"-"`
	XXX_sizecache        int32             `json:"-"`
}

Node is network node

func (*Node) Descriptor

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

func (*Node) GetAddress

func (m *Node) GetAddress() string

func (*Node) GetId

func (m *Node) GetId() string

func (*Node) GetMetadata

func (m *Node) GetMetadata() map[string]string

func (*Node) GetNetwork

func (m *Node) GetNetwork() string

func (*Node) ProtoMessage

func (*Node) ProtoMessage()

func (*Node) Reset

func (m *Node) Reset()

func (*Node) String

func (m *Node) String() string

func (*Node) XXX_DiscardUnknown

func (m *Node) XXX_DiscardUnknown()

func (*Node) XXX_Marshal

func (m *Node) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Node) XXX_Merge

func (m *Node) XXX_Merge(src proto.Message)

func (*Node) XXX_Size

func (m *Node) XXX_Size() int

func (*Node) XXX_Unmarshal

func (m *Node) XXX_Unmarshal(b []byte) error

type NodesRequest

type NodesRequest struct {
	// node topology depth
	Depth                uint32   `protobuf:"varint,1,opt,name=depth,proto3" json:"depth,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

PeerRequest requests list of peers

func (*NodesRequest) Descriptor

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

func (*NodesRequest) GetDepth

func (m *NodesRequest) GetDepth() uint32

func (*NodesRequest) ProtoMessage

func (*NodesRequest) ProtoMessage()

func (*NodesRequest) Reset

func (m *NodesRequest) Reset()

func (*NodesRequest) String

func (m *NodesRequest) String() string

func (*NodesRequest) XXX_DiscardUnknown

func (m *NodesRequest) XXX_DiscardUnknown()

func (*NodesRequest) XXX_Marshal

func (m *NodesRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*NodesRequest) XXX_Merge

func (m *NodesRequest) XXX_Merge(src proto.Message)

func (*NodesRequest) XXX_Size

func (m *NodesRequest) XXX_Size() int

func (*NodesRequest) XXX_Unmarshal

func (m *NodesRequest) XXX_Unmarshal(b []byte) error

type NodesResponse

type NodesResponse struct {
	// return peer topology
	Nodes                []*Node  `protobuf:"bytes,1,rep,name=nodes,proto3" json:"nodes,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

PeerResponse is returned by ListPeers

func (*NodesResponse) Descriptor

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

func (*NodesResponse) GetNodes

func (m *NodesResponse) GetNodes() []*Node

func (*NodesResponse) ProtoMessage

func (*NodesResponse) ProtoMessage()

func (*NodesResponse) Reset

func (m *NodesResponse) Reset()

func (*NodesResponse) String

func (m *NodesResponse) String() string

func (*NodesResponse) XXX_DiscardUnknown

func (m *NodesResponse) XXX_DiscardUnknown()

func (*NodesResponse) XXX_Marshal

func (m *NodesResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*NodesResponse) XXX_Merge

func (m *NodesResponse) XXX_Merge(src proto.Message)

func (*NodesResponse) XXX_Size

func (m *NodesResponse) XXX_Size() int

func (*NodesResponse) XXX_Unmarshal

func (m *NodesResponse) XXX_Unmarshal(b []byte) error

type Peer

type Peer struct {
	// network node
	Node *Node `protobuf:"bytes,1,opt,name=node,proto3" json:"node,omitempty"`
	// node peers
	Peers                []*Peer  `protobuf:"bytes,2,rep,name=peers,proto3" json:"peers,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Peer is used to advertise node peers

func (*Peer) Descriptor

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

func (*Peer) GetNode

func (m *Peer) GetNode() *Node

func (*Peer) GetPeers

func (m *Peer) GetPeers() []*Peer

func (*Peer) ProtoMessage

func (*Peer) ProtoMessage()

func (*Peer) Reset

func (m *Peer) Reset()

func (*Peer) String

func (m *Peer) String() string

func (*Peer) XXX_DiscardUnknown

func (m *Peer) XXX_DiscardUnknown()

func (*Peer) XXX_Marshal

func (m *Peer) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Peer) XXX_Merge

func (m *Peer) XXX_Merge(src proto.Message)

func (*Peer) XXX_Size

func (m *Peer) XXX_Size() int

func (*Peer) XXX_Unmarshal

func (m *Peer) XXX_Unmarshal(b []byte) error

type Query

type Query struct {
	Service              string   `protobuf:"bytes,1,opt,name=service,proto3" json:"service,omitempty"`
	Address              string   `protobuf:"bytes,2,opt,name=address,proto3" json:"address,omitempty"`
	Gateway              string   `protobuf:"bytes,3,opt,name=gateway,proto3" json:"gateway,omitempty"`
	Router               string   `protobuf:"bytes,4,opt,name=router,proto3" json:"router,omitempty"`
	Network              string   `protobuf:"bytes,5,opt,name=network,proto3" json:"network,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Query is passed in a LookupRequest

func (*Query) Descriptor

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

func (*Query) GetAddress

func (m *Query) GetAddress() string

func (*Query) GetGateway

func (m *Query) GetGateway() string

func (*Query) GetNetwork

func (m *Query) GetNetwork() string

func (*Query) GetRouter

func (m *Query) GetRouter() string

func (*Query) GetService

func (m *Query) GetService() string

func (*Query) ProtoMessage

func (*Query) ProtoMessage()

func (*Query) Reset

func (m *Query) Reset()

func (*Query) String

func (m *Query) String() string

func (*Query) XXX_DiscardUnknown

func (m *Query) XXX_DiscardUnknown()

func (*Query) XXX_Marshal

func (m *Query) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Query) XXX_Merge

func (m *Query) XXX_Merge(src proto.Message)

func (*Query) XXX_Size

func (m *Query) XXX_Size() int

func (*Query) XXX_Unmarshal

func (m *Query) XXX_Unmarshal(b []byte) error

type RoutesRequest

type RoutesRequest struct {
	// filter based on
	Query                *Query   `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*RoutesRequest) Descriptor

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

func (*RoutesRequest) GetQuery

func (m *RoutesRequest) GetQuery() *Query

func (*RoutesRequest) ProtoMessage

func (*RoutesRequest) ProtoMessage()

func (*RoutesRequest) Reset

func (m *RoutesRequest) Reset()

func (*RoutesRequest) String

func (m *RoutesRequest) String() string

func (*RoutesRequest) XXX_DiscardUnknown

func (m *RoutesRequest) XXX_DiscardUnknown()

func (*RoutesRequest) XXX_Marshal

func (m *RoutesRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*RoutesRequest) XXX_Merge

func (m *RoutesRequest) XXX_Merge(src proto.Message)

func (*RoutesRequest) XXX_Size

func (m *RoutesRequest) XXX_Size() int

func (*RoutesRequest) XXX_Unmarshal

func (m *RoutesRequest) XXX_Unmarshal(b []byte) error

type RoutesResponse

type RoutesResponse struct {
	Routes               []*proto1.Route `protobuf:"bytes,1,rep,name=routes,proto3" json:"routes,omitempty"`
	XXX_NoUnkeyedLiteral struct{}        `json:"-"`
	XXX_unrecognized     []byte          `json:"-"`
	XXX_sizecache        int32           `json:"-"`
}

func (*RoutesResponse) Descriptor

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

func (*RoutesResponse) GetRoutes

func (m *RoutesResponse) GetRoutes() []*proto1.Route

func (*RoutesResponse) ProtoMessage

func (*RoutesResponse) ProtoMessage()

func (*RoutesResponse) Reset

func (m *RoutesResponse) Reset()

func (*RoutesResponse) String

func (m *RoutesResponse) String() string

func (*RoutesResponse) XXX_DiscardUnknown

func (m *RoutesResponse) XXX_DiscardUnknown()

func (*RoutesResponse) XXX_Marshal

func (m *RoutesResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*RoutesResponse) XXX_Merge

func (m *RoutesResponse) XXX_Merge(src proto.Message)

func (*RoutesResponse) XXX_Size

func (m *RoutesResponse) XXX_Size() int

func (*RoutesResponse) XXX_Unmarshal

func (m *RoutesResponse) XXX_Unmarshal(b []byte) error

type ServicesRequest

type ServicesRequest struct {
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*ServicesRequest) Descriptor

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

func (*ServicesRequest) ProtoMessage

func (*ServicesRequest) ProtoMessage()

func (*ServicesRequest) Reset

func (m *ServicesRequest) Reset()

func (*ServicesRequest) String

func (m *ServicesRequest) String() string

func (*ServicesRequest) XXX_DiscardUnknown

func (m *ServicesRequest) XXX_DiscardUnknown()

func (*ServicesRequest) XXX_Marshal

func (m *ServicesRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ServicesRequest) XXX_Merge

func (m *ServicesRequest) XXX_Merge(src proto.Message)

func (*ServicesRequest) XXX_Size

func (m *ServicesRequest) XXX_Size() int

func (*ServicesRequest) XXX_Unmarshal

func (m *ServicesRequest) XXX_Unmarshal(b []byte) error

type ServicesResponse

type ServicesResponse struct {
	Services             []string `protobuf:"bytes,1,rep,name=services,proto3" json:"services,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*ServicesResponse) Descriptor

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

func (*ServicesResponse) GetServices

func (m *ServicesResponse) GetServices() []string

func (*ServicesResponse) ProtoMessage

func (*ServicesResponse) ProtoMessage()

func (*ServicesResponse) Reset

func (m *ServicesResponse) Reset()

func (*ServicesResponse) String

func (m *ServicesResponse) String() string

func (*ServicesResponse) XXX_DiscardUnknown

func (m *ServicesResponse) XXX_DiscardUnknown()

func (*ServicesResponse) XXX_Marshal

func (m *ServicesResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ServicesResponse) XXX_Merge

func (m *ServicesResponse) XXX_Merge(src proto.Message)

func (*ServicesResponse) XXX_Size

func (m *ServicesResponse) XXX_Size() int

func (*ServicesResponse) XXX_Unmarshal

func (m *ServicesResponse) XXX_Unmarshal(b []byte) error

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL