plan

package module
v0.0.0-...-3b4c8c3 Latest Latest
Warning

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

 Go to latest Published: Aug 26, 2020 License: GPL-3.0 Imports: 15 Imported by: 0

README

PLAN

PLAN is a free and open platform for groups to securely communicate, collaborate, and coordinate projects and activities.

About

PLAN leverages Protocol Buffers and gRPC. This repo houses PLAN's foundational data structures, allowing any consuming projects to be interoperable. This repo also offers the utility script build-proto.sh which invokes the protobuf compiler protoc on a .proto file for a given target language. Consuming projects invoke this script to more easily compile this projects proto files.

Setup

  1. Set up Gprc.Tools (and C# plugin):

    1. Download the latest Grpc.Tools nuget package

    2. Unzip the nuget zip using unzip:

      unzip grpc.tools.X.XX.0.nupkg -d plan-proto/Grpc.Tools

      Note: do not use macOS's built-in unarchiver since it does not restore nupkg filenames properly.

    3. Add execute permissions to for your platform:

      cd Grpc.Tools
chmod +x tools/macosx_x64/*
chmod +x tools/linux_x64/*
chmod +x tools/windows_x64/*

  2. Ensure your $PATH contains Go's bin directory, e.g. PATH="${GOPATH}/bin:${PATH}"

  3. Install gogo protobufs:

    go get -u github.com/gogo/protobuf/protoc-gen-gofast

  4. Install gRPC:

    go get -u google.golang.org/grpc

  5. Invoke build-proto.sh from consuming projects.

  6. Pick up your new lambo.

Getting started with gRPC:

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var FetchFlags_name = map[int32]string{
	0:  "NONE",
	1:  "FIELDS",
	2:  "LINKS",
	4:  "LINKS_RESOLVED",
	8:  "BLOCK",
	16: "BLOCK_DECODED",
}
View Source 
var FetchFlags_value = map[string]int32{
	"NONE":           0,
	"FIELDS":         1,
	"LINKS":          2,
	"LINKS_RESOLVED": 4,
	"BLOCK":          8,
	"BLOCK_DECODED":  16,
}
View Source 
var MergeMode_name = map[int32]string{
	0: "OVERWRITE_DST",
}
View Source 
var MergeMode_value = map[string]int32{
	"OVERWRITE_DST": 0,
}

Functions

func RegisterNodeSpaceServer 

func RegisterNodeSpaceServer(s *grpc.Server, srv NodeSpaceServer)

Types

type Block 

type Block struct {
	// Label is the name / field-name of this Block.
	// Any UTF8 string is available and only NUL is not permitted (such as in Go).
	Label string `protobuf:"bytes,1,opt,name=label,proto3" json:"label,omitempty"`
	// ContentType self-describes the nature of a Block's data and what form it takes.
	// Anyone handed this Block instance can accurately interpret / process / deserialize its content.
	// In effect, this field is a MIME type or more generally any multicodec pathname (e.g. "text/html", "image/png", "audio/mp3")
	ContentType string `protobuf:"bytes,2,opt,name=content_type,json=contentType,proto3" json:"content_type,omitempty"`
	// Codec is an integer alternative to ContentType (for efficiency and compactness).
	// Instead of, say, 10,000 Blocks all repeating a ContentType string over and over, a small int can be used instead.
	// For example, see: https://github.com/multiformats/multicodec
	Codec uint32 `protobuf:"varint,3,opt,name=codec,proto3" json:"codec,omitempty"`
	// Timestamps associated with this Block's content (in seconds UTC).
	TimeCreated  int64 `protobuf:"varint,4,opt,name=time_created,json=timeCreated,proto3" json:"time_created,omitempty"`
	TimeModified int64 `protobuf:"varint,5,opt,name=time_modified,json=timeModified,proto3" json:"time_modified,omitempty"`
	// Subs are optionally nested sub items that can be interpreted or employed in any way a client or protocol sees fit.
	Subs []*Block `protobuf:"bytes,10,rep,name=subs,proto3" json:"subs,omitempty"`
	// Content/payload/data -- structured in accordance with Block.ContentType and/or Block.Codec
	DataVecI             []int64   `protobuf:"varint,20,rep,packed,name=dataVec_i,json=dataVecI,proto3" json:"dataVec_i,omitempty"`
	DataVecF             []float32 `protobuf:"fixed32,21,rep,packed,name=dataVec_f,json=dataVecF,proto3" json:"dataVec_f,omitempty"`
	DataVecD             []float64 `protobuf:"fixed64,22,rep,packed,name=dataVec_d,json=dataVecD,proto3" json:"dataVec_d,omitempty"`
	DataVecS             []string  `protobuf:"bytes,23,rep,name=dataVec_s,json=dataVecS,proto3" json:"dataVec_s,omitempty"`
	DataRGBA             uint32    `protobuf:"fixed32,30,opt,name=dataRGBA,proto3" json:"dataRGBA,omitempty"`
	DataBuf              []byte    `protobuf:"bytes,31,opt,name=dataBuf,proto3" json:"dataBuf,omitempty"`
	DataStr              []byte    `protobuf:"bytes,32,opt,name=dataStr,proto3" json:"dataStr,omitempty"`
	DataInt              int64     `protobuf:"varint,33,opt,name=dataInt,proto3" json:"dataInt,omitempty"`
	DataNum              float64   `protobuf:"fixed64,35,opt,name=dataNum,proto3" json:"dataNum,omitempty"`
	XXX_NoUnkeyedLiteral struct{}  `json:"-"`
	XXX_unrecognized     []byte    `json:"-"`
	XXX_sizecache        int32     `json:"-"`
}

Block is a self-describing, flexible, and nestable information / content container. It contains a variety of readily usable data-types that are free of overhead penalties, courtesy of protobufs. All fields are optional and are understood to conform to the context / protocol / codec that a Block appears in.

func (*Block) Descriptor 

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

func (*Block) GetCodec 

func (m *Block) GetCodec() uint32

func (*Block) GetContentType 

func (m *Block) GetContentType() string

func (*Block) GetDataBuf 

func (m *Block) GetDataBuf() []byte

func (*Block) GetDataInt 

func (m *Block) GetDataInt() int64

func (*Block) GetDataNum 

func (m *Block) GetDataNum() float64

func (*Block) GetDataRGBA 

func (m *Block) GetDataRGBA() uint32

func (*Block) GetDataStr 

func (m *Block) GetDataStr() []byte

func (*Block) GetDataVecD 

func (m *Block) GetDataVecD() []float64

func (*Block) GetDataVecF 

func (m *Block) GetDataVecF() []float32

func (*Block) GetDataVecI 

func (m *Block) GetDataVecI() []int64

func (*Block) GetDataVecS 

func (m *Block) GetDataVecS() []string

func (*Block) GetLabel 

func (m *Block) GetLabel() string

func (*Block) GetSubs 

func (m *Block) GetSubs() []*Block

func (*Block) GetTimeCreated 

func (m *Block) GetTimeCreated() int64

func (*Block) GetTimeModified 

func (m *Block) GetTimeModified() int64

func (*Block) ProtoMessage 

func (*Block) ProtoMessage()

func (*Block) Reset 

func (m *Block) Reset()

func (*Block) String 

func (m *Block) String() string

func (*Block) XXX_DiscardUnknown 

func (m *Block) XXX_DiscardUnknown()

func (*Block) XXX_Marshal 

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

func (*Block) XXX_Merge 

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

func (*Block) XXX_Size 

func (m *Block) XXX_Size() int

func (*Block) XXX_Unmarshal 

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

type ChangeUserPermsReq 

type ChangeUserPermsReq struct {
	ChannelID            string   `protobuf:"bytes,1,opt,name=channelID,proto3" json:"channelID,omitempty"`
	Address              string   `protobuf:"bytes,2,opt,name=address,proto3" json:"address,omitempty"`
	WriteKeypathsRegex   string   `protobuf:"bytes,3,opt,name=writeKeypathsRegex,proto3" json:"writeKeypathsRegex,omitempty"`
	CanWrite             bool     `protobuf:"varint,4,opt,name=canWrite,proto3" json:"canWrite,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*ChangeUserPermsReq) Descriptor 

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

func (*ChangeUserPermsReq) GetAddress 

func (m *ChangeUserPermsReq) GetAddress() string

func (*ChangeUserPermsReq) GetCanWrite 

func (m *ChangeUserPermsReq) GetCanWrite() bool

func (*ChangeUserPermsReq) GetChannelID 

func (m *ChangeUserPermsReq) GetChannelID() string

func (*ChangeUserPermsReq) GetWriteKeypathsRegex 

func (m *ChangeUserPermsReq) GetWriteKeypathsRegex() string

func (*ChangeUserPermsReq) ProtoMessage 

func (*ChangeUserPermsReq) ProtoMessage()

func (*ChangeUserPermsReq) Reset 

func (m *ChangeUserPermsReq) Reset()

func (*ChangeUserPermsReq) String 

func (m *ChangeUserPermsReq) String() string

func (*ChangeUserPermsReq) XXX_DiscardUnknown 

func (m *ChangeUserPermsReq) XXX_DiscardUnknown()

func (*ChangeUserPermsReq) XXX_Marshal 

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

func (*ChangeUserPermsReq) XXX_Merge 

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

func (*ChangeUserPermsReq) XXX_Size 

func (m *ChangeUserPermsReq) XXX_Size() int

func (*ChangeUserPermsReq) XXX_Unmarshal 

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

type ChangeUserPermsResp 

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

func (*ChangeUserPermsResp) Descriptor 

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

func (*ChangeUserPermsResp) ProtoMessage 

func (*ChangeUserPermsResp) ProtoMessage()

func (*ChangeUserPermsResp) Reset 

func (m *ChangeUserPermsResp) Reset()

func (*ChangeUserPermsResp) String 

func (m *ChangeUserPermsResp) String() string

func (*ChangeUserPermsResp) XXX_DiscardUnknown 

func (m *ChangeUserPermsResp) XXX_DiscardUnknown()

func (*ChangeUserPermsResp) XXX_Marshal 

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

func (*ChangeUserPermsResp) XXX_Merge 

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

func (*ChangeUserPermsResp) XXX_Size 

func (m *ChangeUserPermsResp) XXX_Size() int

func (*ChangeUserPermsResp) XXX_Unmarshal 

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

type ChannelGenesisReq 

type ChannelGenesisReq struct {
	ChannelID            string   `protobuf:"bytes,1,opt,name=channelID,proto3" json:"channelID,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*ChannelGenesisReq) Descriptor 

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

func (*ChannelGenesisReq) GetChannelID 

func (m *ChannelGenesisReq) GetChannelID() string

func (*ChannelGenesisReq) ProtoMessage 

func (*ChannelGenesisReq) ProtoMessage()

func (*ChannelGenesisReq) Reset 

func (m *ChannelGenesisReq) Reset()

func (*ChannelGenesisReq) String 

func (m *ChannelGenesisReq) String() string

func (*ChannelGenesisReq) XXX_DiscardUnknown 

func (m *ChannelGenesisReq) XXX_DiscardUnknown()

func (*ChannelGenesisReq) XXX_Marshal 

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

func (*ChannelGenesisReq) XXX_Merge 

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

func (*ChannelGenesisReq) XXX_Size 

func (m *ChannelGenesisReq) XXX_Size() int

func (*ChannelGenesisReq) XXX_Unmarshal 

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

type ChannelGenesisResp 

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

func (*ChannelGenesisResp) Descriptor 

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

func (*ChannelGenesisResp) ProtoMessage 

func (*ChannelGenesisResp) ProtoMessage()

func (*ChannelGenesisResp) Reset 

func (m *ChannelGenesisResp) Reset()

func (*ChannelGenesisResp) String 

func (m *ChannelGenesisResp) String() string

func (*ChannelGenesisResp) XXX_DiscardUnknown 

func (m *ChannelGenesisResp) XXX_DiscardUnknown()

func (*ChannelGenesisResp) XXX_Marshal 

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

func (*ChannelGenesisResp) XXX_Merge 

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

func (*ChannelGenesisResp) XXX_Size 

func (m *ChannelGenesisResp) XXX_Size() int

func (*ChannelGenesisResp) XXX_Unmarshal 

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

type FetchFlags 

type FetchFlags int32

FetchFlags specifies what parts of a Node are loaded and returned during a NodeScan. 

const (
	FetchFlags_NONE           FetchFlags = 0
	FetchFlags_FIELDS         FetchFlags = 1
	FetchFlags_LINKS          FetchFlags = 2
	FetchFlags_LINKS_RESOLVED FetchFlags = 4
	FetchFlags_BLOCK          FetchFlags = 8
	FetchFlags_BLOCK_DECODED  FetchFlags = 16
)

func (FetchFlags) EnumDescriptor 

func (FetchFlags) EnumDescriptor() ([]byte, []int)

func (FetchFlags) String 

func (x FetchFlags) String() string

type LayerPutReq 

type LayerPutReq struct {
	ChannelID            string     `protobuf:"bytes,1,opt,name=channelID,proto3" json:"channelID,omitempty"`
	LayerURI             string     `protobuf:"bytes,2,opt,name=layerURI,proto3" json:"layerURI,omitempty"`
	Layer                *NodeLayer `protobuf:"bytes,3,opt,name=layer,proto3" json:"layer,omitempty"`
	MergeMode            MergeMode  `protobuf:"varint,4,opt,name=merge_mode,json=mergeMode,proto3,enum=plan.MergeMode" json:"merge_mode,omitempty"`
	XXX_NoUnkeyedLiteral struct{}   `json:"-"`
	XXX_unrecognized     []byte     `json:"-"`
	XXX_sizecache        int32      `json:"-"`
}

func (*LayerPutReq) Descriptor 

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

func (*LayerPutReq) GetChannelID 

func (m *LayerPutReq) GetChannelID() string

func (*LayerPutReq) GetLayer 

func (m *LayerPutReq) GetLayer() *NodeLayer

func (*LayerPutReq) GetLayerURI 

func (m *LayerPutReq) GetLayerURI() string

func (*LayerPutReq) GetMergeMode 

func (m *LayerPutReq) GetMergeMode() MergeMode

func (*LayerPutReq) ProtoMessage 

func (*LayerPutReq) ProtoMessage()

func (*LayerPutReq) Reset 

func (m *LayerPutReq) Reset()

func (*LayerPutReq) String 

func (m *LayerPutReq) String() string

func (*LayerPutReq) XXX_DiscardUnknown 

func (m *LayerPutReq) XXX_DiscardUnknown()

func (*LayerPutReq) XXX_Marshal 

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

func (*LayerPutReq) XXX_Merge 

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

func (*LayerPutReq) XXX_Size 

func (m *LayerPutReq) XXX_Size() int

func (*LayerPutReq) XXX_Unmarshal 

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

type LayerPutResp 

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

func (*LayerPutResp) Descriptor 

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

func (*LayerPutResp) ProtoMessage 

func (*LayerPutResp) ProtoMessage()

func (*LayerPutResp) Reset 

func (m *LayerPutResp) Reset()

func (*LayerPutResp) String 

func (m *LayerPutResp) String() string

func (*LayerPutResp) XXX_DiscardUnknown 

func (m *LayerPutResp) XXX_DiscardUnknown()

func (*LayerPutResp) XXX_Marshal 

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

func (*LayerPutResp) XXX_Merge 

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

func (*LayerPutResp) XXX_Size 

func (m *LayerPutResp) XXX_Size() int

func (*LayerPutResp) XXX_Unmarshal 

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

type LayerScanReq 

type LayerScanReq struct {
	ChannelID            string   `protobuf:"bytes,1,opt,name=channelID,proto3" json:"channelID,omitempty"`
	LayerIDRegex         string   `protobuf:"bytes,2,opt,name=layerID_regex,json=layerIDRegex,proto3" json:"layerID_regex,omitempty"`
	NameRegex            string   `protobuf:"bytes,3,opt,name=name_regex,json=nameRegex,proto3" json:"name_regex,omitempty"`
	TypeIDRegex          string   `protobuf:"bytes,4,opt,name=typeID_regex,json=typeIDRegex,proto3" json:"typeID_regex,omitempty"`
	Subscribe            bool     `protobuf:"varint,5,opt,name=subscribe,proto3" json:"subscribe,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*LayerScanReq) Descriptor 

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

func (*LayerScanReq) GetChannelID 

func (m *LayerScanReq) GetChannelID() string

func (*LayerScanReq) GetLayerIDRegex 

func (m *LayerScanReq) GetLayerIDRegex() string

func (*LayerScanReq) GetNameRegex 

func (m *LayerScanReq) GetNameRegex() string

func (*LayerScanReq) GetSubscribe 

func (m *LayerScanReq) GetSubscribe() bool

func (*LayerScanReq) GetTypeIDRegex 

func (m *LayerScanReq) GetTypeIDRegex() string

func (*LayerScanReq) ProtoMessage 

func (*LayerScanReq) ProtoMessage()

func (*LayerScanReq) Reset 

func (m *LayerScanReq) Reset()

func (*LayerScanReq) String 

func (m *LayerScanReq) String() string

func (*LayerScanReq) XXX_DiscardUnknown 

func (m *LayerScanReq) XXX_DiscardUnknown()

func (*LayerScanReq) XXX_Marshal 

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

func (*LayerScanReq) XXX_Merge 

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

func (*LayerScanReq) XXX_Size 

func (m *LayerScanReq) XXX_Size() int

func (*LayerScanReq) XXX_Unmarshal 

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

type MergeMode 

type MergeMode int32
const (
	MergeMode_OVERWRITE_DST MergeMode = 0
)

func (MergeMode) EnumDescriptor 

func (MergeMode) EnumDescriptor() ([]byte, []int)

func (MergeMode) String 

func (x MergeMode) String() string

type Node 

type Node struct {
	// NodeID is required and uniquely identifies a node.
	// This ID can be any UTF8 string but cannot contain NUL or forward slash ('/')
	NodeID string `protobuf:"bytes,1,opt,name=nodeID,proto3" json:"nodeID,omitempty"`
	// Optional values that can express how this node conforms to a convention.
	TypeID string `protobuf:"bytes,2,opt,name=typeID,proto3" json:"typeID,omitempty"`
	Name   string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	// Allows the server to return the parent layer of this node during a node scan (and is nil otherwise).
	// Note that '_' denotes the default layer ID.
	LayerID string `protobuf:"bytes,5,opt,name=layerID,proto3" json:"layerID,omitempty"`
	// Time value(s) that conform the parent layer's time unit type.
	T    float64 `protobuf:"fixed64,10,opt,name=t,proto3" json:"t,omitempty"`
	TEnd float64 `protobuf:"fixed64,11,opt,name=t_end,json=tEnd,proto3" json:"t_end,omitempty"`
	// Cords that conform the parent layer's cord space and unit types.
	X1 float64 `protobuf:"fixed64,20,opt,name=x1,proto3" json:"x1,omitempty"`
	X2 float64 `protobuf:"fixed64,21,opt,name=x2,proto3" json:"x2,omitempty"`
	X3 float64 `protobuf:"fixed64,22,opt,name=x3,proto3" json:"x3,omitempty"`
	X4 float64 `protobuf:"fixed64,23,opt,name=x4,proto3" json:"x4,omitempty"`
	// NodeURIs are links to other nodes.
	// [<node_uri>|.]<NodeID>[/<LayerID>]
	NodeURIs []string `protobuf:"bytes,30,rep,name=nodeURIs,proto3" json:"nodeURIs,omitempty"`
	// Nodes are corresponding elements of nodeURIs resolved/expanded.
	// This is only used for a server to return this.NodeURIs in their auto-resolved form.
	// See use of FetchFlags in NodeScanReq.
	Nodes []*Node `protobuf:"bytes,31,rep,name=nodes,proto3" json:"nodes,omitempty"`
	// Block is any client data payload (and is generally not accessed by redwood).
	// When non-nil, it is assumed to be the output of this.BlockRaw.Unmarshal()
	Block *Block `protobuf:"bytes,40,opt,name=block,proto3" json:"block,omitempty"`
	// BlockRaw is the protobufs serialization of this.Block.
	// When non-nil, it is assumed to be the output of this.Block.Marshal()
	BlockRaw             []byte   `protobuf:"bytes,41,opt,name=block_raw,json=blockRaw,proto3" json:"block_raw,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Node is a generic information schema that reflects a collection of abstract containers ("nodes") in relation to each other and nodes in other NodeSpace channels. Each node has a set of associated fields and attributes, including spatial coordinates and references (links) to other nodes.

func (*Node) Descriptor 

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

func (*Node) GetBlock 

func (m *Node) GetBlock() *Block

func (*Node) GetBlockRaw 

func (m *Node) GetBlockRaw() []byte

func (*Node) GetLayerID 

func (m *Node) GetLayerID() string

func (*Node) GetName 

func (m *Node) GetName() string

func (*Node) GetNodeID 

func (m *Node) GetNodeID() string

func (*Node) GetNodeURIs 

func (m *Node) GetNodeURIs() []string

func (*Node) GetNodes 

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

func (*Node) GetT 

func (m *Node) GetT() float64

func (*Node) GetTEnd 

func (m *Node) GetTEnd() float64

func (*Node) GetTypeID 

func (m *Node) GetTypeID() string

func (*Node) GetX1 

func (m *Node) GetX1() float64

func (*Node) GetX2 

func (m *Node) GetX2() float64

func (*Node) GetX3 

func (m *Node) GetX3() float64

func (*Node) GetX4 

func (m *Node) GetX4() float64

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 NodeLayer 

type NodeLayer struct {
	// LayerID is required and uniquely identifies a node layer.
	// This ID can be any UTF8 string but cannot contain NUL or forward slash ('/')
	LayerID string `protobuf:"bytes,1,opt,name=layerID,proto3" json:"layerID,omitempty"`
	// Optional values that can express how this layer conforms to a given convention.
	TypeID string   `protobuf:"bytes,2,opt,name=typeID,proto3" json:"typeID,omitempty"`
	Name   string   `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	Tags   []string `protobuf:"bytes,4,rep,name=tags,proto3" json:"tags,omitempty"`
	// Specifies the time and spatial units of nodes specified in this layer.
	CordSpaceType string `protobuf:"bytes,10,opt,name=cord_space_type,json=cordSpaceType,proto3" json:"cord_space_type,omitempty"`
	CordUnitType  string `protobuf:"bytes,11,opt,name=cord_unit_type,json=cordUnitType,proto3" json:"cord_unit_type,omitempty"`
	TimeUnitType  string `protobuf:"bytes,12,opt,name=time_unit_type,json=timeUnitType,proto3" json:"time_unit_type,omitempty"`
	// Same as Node.Block
	Block                *Block   `protobuf:"bytes,40,opt,name=block,proto3" json:"block,omitempty"`
	BlockRaw             []byte   `protobuf:"bytes,41,opt,name=block_raw,json=blockRaw,proto3" json:"block_raw,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

NodeLayer effectively is a column descriptor for nodes that define corresponding coordinates or attributes for the given layer ID. Node layerID is unrestricted, other than that '_' is hardwired to mean the "default" (base) layer.

func (*NodeLayer) Descriptor 

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

func (*NodeLayer) GetBlock 

func (m *NodeLayer) GetBlock() *Block

func (*NodeLayer) GetBlockRaw 

func (m *NodeLayer) GetBlockRaw() []byte

func (*NodeLayer) GetCordSpaceType 

func (m *NodeLayer) GetCordSpaceType() string

func (*NodeLayer) GetCordUnitType 

func (m *NodeLayer) GetCordUnitType() string

func (*NodeLayer) GetLayerID 

func (m *NodeLayer) GetLayerID() string

func (*NodeLayer) GetName 

func (m *NodeLayer) GetName() string

func (*NodeLayer) GetTags 

func (m *NodeLayer) GetTags() []string

func (*NodeLayer) GetTimeUnitType 

func (m *NodeLayer) GetTimeUnitType() string

func (*NodeLayer) GetTypeID 

func (m *NodeLayer) GetTypeID() string

func (*NodeLayer) ProtoMessage 

func (*NodeLayer) ProtoMessage()

func (*NodeLayer) Reset 

func (m *NodeLayer) Reset()

func (*NodeLayer) String 

func (m *NodeLayer) String() string

func (*NodeLayer) XXX_DiscardUnknown 

func (m *NodeLayer) XXX_DiscardUnknown()

func (*NodeLayer) XXX_Marshal 

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

func (*NodeLayer) XXX_Merge 

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

func (*NodeLayer) XXX_Size 

func (m *NodeLayer) XXX_Size() int

func (*NodeLayer) XXX_Unmarshal 

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

type NodePutReq 

type NodePutReq struct {
	ChannelID            string    `protobuf:"bytes,1,opt,name=channelID,proto3" json:"channelID,omitempty"`
	NodeURI              string    `protobuf:"bytes,2,opt,name=nodeURI,proto3" json:"nodeURI,omitempty"`
	Node                 *Node     `protobuf:"bytes,3,opt,name=node,proto3" json:"node,omitempty"`
	MergeMode            MergeMode `protobuf:"varint,4,opt,name=merge_mode,json=mergeMode,proto3,enum=plan.MergeMode" json:"merge_mode,omitempty"`
	XXX_NoUnkeyedLiteral struct{}  `json:"-"`
	XXX_unrecognized     []byte    `json:"-"`
	XXX_sizecache        int32     `json:"-"`
}

func (*NodePutReq) Descriptor 

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

func (*NodePutReq) GetChannelID 

func (m *NodePutReq) GetChannelID() string

func (*NodePutReq) GetMergeMode 

func (m *NodePutReq) GetMergeMode() MergeMode

func (*NodePutReq) GetNode 

func (m *NodePutReq) GetNode() *Node

func (*NodePutReq) GetNodeURI 

func (m *NodePutReq) GetNodeURI() string

func (*NodePutReq) ProtoMessage 

func (*NodePutReq) ProtoMessage()

func (*NodePutReq) Reset 

func (m *NodePutReq) Reset()

func (*NodePutReq) String 

func (m *NodePutReq) String() string

func (*NodePutReq) XXX_DiscardUnknown 

func (m *NodePutReq) XXX_DiscardUnknown()

func (*NodePutReq) XXX_Marshal 

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

func (*NodePutReq) XXX_Merge 

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

func (*NodePutReq) XXX_Size 

func (m *NodePutReq) XXX_Size() int

func (*NodePutReq) XXX_Unmarshal 

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

type NodePutResp 

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

func (*NodePutResp) Descriptor 

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

func (*NodePutResp) ProtoMessage 

func (*NodePutResp) ProtoMessage()

func (*NodePutResp) Reset 

func (m *NodePutResp) Reset()

func (*NodePutResp) String 

func (m *NodePutResp) String() string

func (*NodePutResp) XXX_DiscardUnknown 

func (m *NodePutResp) XXX_DiscardUnknown()

func (*NodePutResp) XXX_Marshal 

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

func (*NodePutResp) XXX_Merge 

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

func (*NodePutResp) XXX_Size 

func (m *NodePutResp) XXX_Size() int

func (*NodePutResp) XXX_Unmarshal 

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

type NodeScanReq 

type NodeScanReq struct {
	ChannelID             string `protobuf:"bytes,1,opt,name=channelID,proto3" json:"channelID,omitempty"`
	NodeIDRegex           string `protobuf:"bytes,2,opt,name=nodeID_regex,json=nodeIDRegex,proto3" json:"nodeID_regex,omitempty"`
	NameRegex             string `protobuf:"bytes,3,opt,name=name_regex,json=nameRegex,proto3" json:"name_regex,omitempty"`
	LayerIDRegex          string `protobuf:"bytes,4,opt,name=layerID_regex,json=layerIDRegex,proto3" json:"layerID_regex,omitempty"`
	InverseLayerSelection bool   `` /* 127-byte string literal not displayed */
	Subscribe             bool   `protobuf:"varint,6,opt,name=subscribe,proto3" json:"subscribe,omitempty"`
	// Min/max time search params (no search if t_max > t_min)
	TMin float64 `protobuf:"fixed64,10,opt,name=t_min,json=tMin,proto3" json:"t_min,omitempty"`
	TMax float64 `protobuf:"fixed64,11,opt,name=t_max,json=tMax,proto3" json:"t_max,omitempty"`
	// Spatial search params
	NodeSearchParams *NodeSearchParams `protobuf:"bytes,15,opt,name=node_search_params,json=nodeSearchParams,proto3" json:"node_search_params,omitempty"`
	// ScanFetchFlags specifies which fields are loaded and returned for each Node "hit" returned by a NodeScan().
	ScanFetchFlags FetchFlags `` /* 128-byte string literal not displayed */
	// LinksFetchFlags specifies which fields are loaded and returned for linked nodes of each Node hit returned by a NodeScan().
	LinksFetchFlags      FetchFlags `` /* 131-byte string literal not displayed */
	XXX_NoUnkeyedLiteral struct{}   `json:"-"`
	XXX_unrecognized     []byte     `json:"-"`
	XXX_sizecache        int32      `json:"-"`
}

func (*NodeScanReq) Descriptor 

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

func (*NodeScanReq) GetChannelID 

func (m *NodeScanReq) GetChannelID() string

func (*NodeScanReq) GetInverseLayerSelection 

func (m *NodeScanReq) GetInverseLayerSelection() bool

func (*NodeScanReq) GetLayerIDRegex 

func (m *NodeScanReq) GetLayerIDRegex() string

func (*NodeScanReq) GetLinksFetchFlags 

func (m *NodeScanReq) GetLinksFetchFlags() FetchFlags

func (*NodeScanReq) GetNameRegex 

func (m *NodeScanReq) GetNameRegex() string

func (*NodeScanReq) GetNodeIDRegex 

func (m *NodeScanReq) GetNodeIDRegex() string

func (*NodeScanReq) GetNodeSearchParams 

func (m *NodeScanReq) GetNodeSearchParams() *NodeSearchParams

func (*NodeScanReq) GetScanFetchFlags 

func (m *NodeScanReq) GetScanFetchFlags() FetchFlags

func (*NodeScanReq) GetSubscribe 

func (m *NodeScanReq) GetSubscribe() bool

func (*NodeScanReq) GetTMax 

func (m *NodeScanReq) GetTMax() float64

func (*NodeScanReq) GetTMin 

func (m *NodeScanReq) GetTMin() float64

func (*NodeScanReq) ProtoMessage 

func (*NodeScanReq) ProtoMessage()

func (*NodeScanReq) Reset 

func (m *NodeScanReq) Reset()

func (*NodeScanReq) String 

func (m *NodeScanReq) String() string

func (*NodeScanReq) XXX_DiscardUnknown 

func (m *NodeScanReq) XXX_DiscardUnknown()

func (*NodeScanReq) XXX_Marshal 

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

func (*NodeScanReq) XXX_Merge 

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

func (*NodeScanReq) XXX_Size 

func (m *NodeScanReq) XXX_Size() int

func (*NodeScanReq) XXX_Unmarshal 

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

type NodeSearchParams 

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

func (*NodeSearchParams) Descriptor 

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

func (*NodeSearchParams) ProtoMessage 

func (*NodeSearchParams) ProtoMessage()

func (*NodeSearchParams) Reset 

func (m *NodeSearchParams) Reset()

func (*NodeSearchParams) String 

func (m *NodeSearchParams) String() string

func (*NodeSearchParams) XXX_DiscardUnknown 

func (m *NodeSearchParams) XXX_DiscardUnknown()

func (*NodeSearchParams) XXX_Marshal 

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

func (*NodeSearchParams) XXX_Merge 

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

func (*NodeSearchParams) XXX_Size 

func (m *NodeSearchParams) XXX_Size() int

func (*NodeSearchParams) XXX_Unmarshal 

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

type NodeSpaceClient 

type NodeSpaceClient interface {
	ChannelGenesis(ctx context.Context, in *ChannelGenesisReq, opts ...grpc.CallOption) (*ChannelGenesisResp, error)
	ChangeUserPerms(ctx context.Context, in *ChangeUserPermsReq, opts ...grpc.CallOption) (*ChangeUserPermsResp, error)
	LayerScan(ctx context.Context, in *LayerScanReq, opts ...grpc.CallOption) (NodeSpace_LayerScanClient, error)
	LayerPut(ctx context.Context, in *LayerPutReq, opts ...grpc.CallOption) (*LayerPutResp, error)
	NodeScan(ctx context.Context, in *NodeScanReq, opts ...grpc.CallOption) (NodeSpace_NodeScanClient, error)
	NodePut(ctx context.Context, in *NodePutReq, opts ...grpc.CallOption) (*NodePutResp, error)
}

NodeSpaceClient is the client API for NodeSpace service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewNodeSpaceClient 

func NewNodeSpaceClient(cc *grpc.ClientConn) NodeSpaceClient

type NodeSpaceServer 

type NodeSpaceServer interface {
	ChannelGenesis(context.Context, *ChannelGenesisReq) (*ChannelGenesisResp, error)
	ChangeUserPerms(context.Context, *ChangeUserPermsReq) (*ChangeUserPermsResp, error)
	LayerScan(*LayerScanReq, NodeSpace_LayerScanServer) error
	LayerPut(context.Context, *LayerPutReq) (*LayerPutResp, error)
	NodeScan(*NodeScanReq, NodeSpace_NodeScanServer) error
	NodePut(context.Context, *NodePutReq) (*NodePutResp, error)
}

NodeSpaceServer is the server API for NodeSpace service.

type NodeSpace_LayerScanClient 

type NodeSpace_LayerScanClient interface {
	Recv() (*NodeLayer, error)
	grpc.ClientStream
}

type NodeSpace_LayerScanServer 

type NodeSpace_LayerScanServer interface {
	Send(*NodeLayer) error
	grpc.ServerStream
}

type NodeSpace_NodeScanClient 

type NodeSpace_NodeScanClient interface {
	Recv() (*Node, error)
	grpc.ClientStream
}

type NodeSpace_NodeScanServer 

type NodeSpace_NodeScanServer interface {
	Send(*Node) error
	grpc.ServerStream
}

type RPCServer 

type RPCServer struct {
	*ctx.Context
	// contains filtered or unexported fields
}

func NewRPCServer 

func NewRPCServer(host redwood.Host, listenNetwork string, listenAddr string) *RPCServer

func (*RPCServer) ChangeUserPerms 

func (s *RPCServer) ChangeUserPerms(ctx context.Context, req *ChangeUserPermsReq) (*ChangeUserPermsResp, error)

func (*RPCServer) ChannelGenesis 

func (s *RPCServer) ChannelGenesis(ctx context.Context, req *ChannelGenesisReq) (*ChannelGenesisResp, error)

func (*RPCServer) LayerPut 

func (s *RPCServer) LayerPut(ctx context.Context, req *LayerPutReq) (*LayerPutResp, error)

func (*RPCServer) LayerScan 

func (s *RPCServer) LayerScan(req *LayerScanReq, server NodeSpace_LayerScanServer) error

func (*RPCServer) NodePut 

func (s *RPCServer) NodePut(ctx context.Context, req *NodePutReq) (*NodePutResp, error)

func (*RPCServer) NodeScan 

func (s *RPCServer) NodeScan(req *NodeScanReq, server NodeSpace_NodeScanServer) error

func (*RPCServer) Start 

func (s *RPCServer) Start() error

func (*RPCServer) StreamServerInterceptor 

func (s *RPCServer) StreamServerInterceptor() grpc.StreamServerInterceptor

func (*RPCServer) UnaryServerInterceptor 

func (s *RPCServer) UnaryServerInterceptor() grpc.UnaryServerInterceptor

type UnimplementedNodeSpaceServer 

type UnimplementedNodeSpaceServer struct {
}

UnimplementedNodeSpaceServer can be embedded to have forward compatible implementations.

func (*UnimplementedNodeSpaceServer) ChangeUserPerms 

func (*UnimplementedNodeSpaceServer) ChangeUserPerms(ctx context.Context, req *ChangeUserPermsReq) (*ChangeUserPermsResp, error)

func (*UnimplementedNodeSpaceServer) ChannelGenesis 

func (*UnimplementedNodeSpaceServer) ChannelGenesis(ctx context.Context, req *ChannelGenesisReq) (*ChannelGenesisResp, error)

func (*UnimplementedNodeSpaceServer) LayerPut 

func (*UnimplementedNodeSpaceServer) LayerPut(ctx context.Context, req *LayerPutReq) (*LayerPutResp, error)

func (*UnimplementedNodeSpaceServer) LayerScan 

func (*UnimplementedNodeSpaceServer) LayerScan(req *LayerScanReq, srv NodeSpace_LayerScanServer) error

func (*UnimplementedNodeSpaceServer) NodePut 

func (*UnimplementedNodeSpaceServer) NodePut(ctx context.Context, req *NodePutReq) (*NodePutResp, error)

func (*UnimplementedNodeSpaceServer) NodeScan 

func (*UnimplementedNodeSpaceServer) NodeScan(req *NodeScanReq, srv NodeSpace_NodeScanServer) error

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.