README
¶
To update the protocol buffer definitions, run this from one directory above:
protoc -I worker worker/payload.proto --gofast_out=plugins=grpc:worker
Documentation
¶
Overview ¶
Package worker is a generated protocol buffer package.
It is generated from these files:
payload.proto
It has these top-level messages:
Payload
Package worker contains code for internal worker communication to perform queries and mutations.
Index ¶
- Constants
- Variables
- func Connect(workerList []string, workerPort string)
- func GetOrAssignUidsOverNetwork(ctx context.Context, xidToUid map[string]uint64) (rerr error)
- func InitState(ps, uStore *store.Store, idx, numInst uint64)
- func NewQuery(attr string, uids []uint64) []byte
- func ProcessTaskOverNetwork(ctx context.Context, qu []byte) (result []byte, rerr error)
- func RegisterWorkerServer(s *grpc.Server, srv WorkerServer)
- type Mutations
- type Payload
- func (*Payload) Descriptor() ([]byte, []int)
- func (m *Payload) Marshal() (data []byte, err error)
- func (m *Payload) MarshalTo(data []byte) (int, error)
- func (*Payload) ProtoMessage()
- func (m *Payload) Reset()
- func (m *Payload) Size() (n int)
- func (m *Payload) String() string
- func (m *Payload) Unmarshal(data []byte) error
- type PayloadCodec
- type Pool
- type State
- type WorkerClient
- type WorkerServer
- type Worker_PredicateDataClient
- type Worker_PredicateDataServer
Constants ¶
const (
// MB represents a megabyte.
MB = 1 << 20
)
Variables ¶
var ( ErrInvalidLengthPayload = fmt.Errorf("proto: negative length found during unmarshaling") ErrIntOverflowPayload = fmt.Errorf("proto: integer overflow") )
Functions ¶
func Connect ¶
Connect establishes a connection with other workers and sends the Hello rpc call to them.
func GetOrAssignUidsOverNetwork ¶
GetOrAssignUidsOverNetwork gets or assigns uids corresponding to xids and writes them to the xidToUid map.
func InitState ¶ added in v0.4.4
InitState initializes the state on an instance with data,uid store and other meta.
func ProcessTaskOverNetwork ¶
ProcessTaskOverNetwork is used to process the query and get the result from the instance which stores posting list corresponding to the predicate in the query.
func RegisterWorkerServer ¶
func RegisterWorkerServer(s *grpc.Server, srv WorkerServer)
Types ¶
type Mutations ¶
type Mutations struct {
Set []x.DirectedEdge
Del []x.DirectedEdge
}
Mutations stores the directed edges for both the set and delete operations.
func MutateOverNetwork ¶
MutateOverNetwork checks which instance should be running the mutations according to fingerprint of the predicate and sends it to that instance.
type Payload ¶
type Payload struct {
Data []byte `protobuf:"bytes,1,opt,name=Data,json=data,proto3" json:"Data,omitempty"`
}
func (*Payload) Descriptor ¶
func (*Payload) ProtoMessage ¶
func (*Payload) ProtoMessage()
type PayloadCodec ¶
type PayloadCodec struct{}
PayloadCodec is a custom codec that is that is used for internal worker communication.
func (*PayloadCodec) Marshal ¶
func (cb *PayloadCodec) Marshal(v interface{}) ([]byte, error)
Marshal marshals v into a Payload instance. v contains serialised data for a flatbuffer Query object.
func (*PayloadCodec) String ¶
func (cb *PayloadCodec) String() string
func (*PayloadCodec) Unmarshal ¶
func (cb *PayloadCodec) Unmarshal(data []byte, v interface{}) error
Unmarshal unmarshals byte slice data into v.
type Pool ¶
type Pool struct {
Addr string
// contains filtered or unexported fields
}
Pool is used to manage the grpc client connections for communicating with other worker instances.
func NewPool ¶
NewPool initializes an instance of Pool which is used to connect with other workers. The pool instance also has a buffered channel,conn with capacity maxCap that stores the connections.
type State ¶ added in v0.4.4
type State struct {
// contains filtered or unexported fields
}
State stores the worker state.
type WorkerClient ¶
type WorkerClient interface {
Hello(ctx context.Context, in *Payload, opts ...grpc.CallOption) (*Payload, error)
GetOrAssign(ctx context.Context, in *Payload, opts ...grpc.CallOption) (*Payload, error)
Mutate(ctx context.Context, in *Payload, opts ...grpc.CallOption) (*Payload, error)
ServeTask(ctx context.Context, in *Payload, opts ...grpc.CallOption) (*Payload, error)
PredicateData(ctx context.Context, in *Payload, opts ...grpc.CallOption) (Worker_PredicateDataClient, error)
}
func NewWorkerClient ¶
func NewWorkerClient(cc *grpc.ClientConn) WorkerClient
type WorkerServer ¶
type WorkerServer interface {
Hello(context.Context, *Payload) (*Payload, error)
GetOrAssign(context.Context, *Payload) (*Payload, error)
Mutate(context.Context, *Payload) (*Payload, error)
ServeTask(context.Context, *Payload) (*Payload, error)
PredicateData(*Payload, Worker_PredicateDataServer) error
}
type Worker_PredicateDataClient ¶ added in v0.4.4
type Worker_PredicateDataClient interface {
Recv() (*Payload, error)
grpc.ClientStream
}
type Worker_PredicateDataServer ¶ added in v0.4.4
type Worker_PredicateDataServer interface {
Send(*Payload) error
grpc.ServerStream
}
Source Files