journalupdate

README

journal-update

This folder contains the gRPC/ProtocolBuffers definitions for the Command API. It also contains the generated Go code.

Install build dependencies

To generate Go code, you need a number of tools installed.

• You have already installed Go.
• Install make. This is almost always available in your systems default software repository. e.g.: sudo apt install build-essentials. If you're a developer, this is probably already installed.
• Install protoc, the protocol buffers compiler.
• Install protoc-gen-go, the protoc compiler for Go.
• Install protoc-gen-gogofaster, an alternative/overloaded protoc extension for Go that provides more optimizations and features than the default one.

Run

Tun make in this directory to compile the proto to Go code, and to generate the .protoset file for use with a CLI client such as grpcurl.

cd ~/src/gitlab.com/commonground/xbrp/desq/journal-update-api/journal-update
make

Documentation

Index

• Variables
• func RegisterJournalUpdateServer(s grpc.ServiceRegistrar, srv JournalUpdateServer)
• type AddEntryReply
  • func (*AddEntryReply) Descriptor() ([]byte, []int)
  • func (x *AddEntryReply) GetJournalHeight() uint64
  • func (x *AddEntryReply) GetJournalHeightHash() []byte
  • func (*AddEntryReply) ProtoMessage()
  • func (x *AddEntryReply) ProtoReflect() protoreflect.Message
  • func (x *AddEntryReply) Reset()
  • func (x *AddEntryReply) String() string
• type AddEntryRequest
  • func (*AddEntryRequest) Descriptor() ([]byte, []int)
  • func (x *AddEntryRequest) GetEventHash() []byte
  • func (x *AddEntryRequest) GetEventReference() []byte
  • func (x *AddEntryRequest) GetPersonReference() []byte
  • func (*AddEntryRequest) ProtoMessage()
  • func (x *AddEntryRequest) ProtoReflect() protoreflect.Message
  • func (x *AddEntryRequest) Reset()
  • func (x *AddEntryRequest) String() string
• type JournalUpdateClient
  • func NewJournalUpdateClient(cc grpc.ClientConnInterface) JournalUpdateClient
• type JournalUpdateServer
• type UnimplementedJournalUpdateServer
  • func (UnimplementedJournalUpdateServer) AddEntry(context.Context, *AddEntryRequest) (*AddEntryReply, error)
• type UnsafeJournalUpdateServer

Variables

var File_journal_update_api_journalupdate_journal_update_proto protoreflect.FileDescriptor

var JournalUpdate_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "journalupdate.JournalUpdate",
	HandlerType: (*JournalUpdateServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "AddEntry",
			Handler:    _JournalUpdate_AddEntry_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "journal-update-api/journalupdate/journal-update.proto",
}

JournalUpdate_ServiceDesc is the grpc.ServiceDesc for JournalUpdate service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterJournalUpdateServer

func RegisterJournalUpdateServer(s grpc.ServiceRegistrar, srv JournalUpdateServer)

Types

type AddEntryReply

type AddEntryReply struct {
	JournalHeight     uint64 `protobuf:"varint,1,opt,name=journalHeight,proto3" json:"journalHeight,omitempty"`
	JournalHeightHash []byte `protobuf:"bytes,2,opt,name=journalHeightHash,proto3" json:"journalHeightHash,omitempty"`
	// contains filtered or unexported fields
}

func (*AddEntryReply) Descriptor

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

Deprecated: Use AddEntryReply.ProtoReflect.Descriptor instead.

func (*AddEntryReply) GetJournalHeight

func (x *AddEntryReply) GetJournalHeight() uint64

func (*AddEntryReply) GetJournalHeightHash

func (x *AddEntryReply) GetJournalHeightHash() []byte

func (*AddEntryReply) ProtoMessage

func (*AddEntryReply) ProtoMessage()

func (*AddEntryReply) ProtoReflect

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

func (*AddEntryReply) Reset

func (x *AddEntryReply) Reset()

func (*AddEntryReply) String

func (x *AddEntryReply) String() string

type AddEntryRequest

type AddEntryRequest struct {
	PersonReference []byte `protobuf:"bytes,1,opt,name=personReference,proto3" json:"personReference,omitempty"`
	EventReference  []byte `protobuf:"bytes,2,opt,name=eventReference,proto3" json:"eventReference,omitempty"`
	EventHash       []byte `protobuf:"bytes,3,opt,name=eventHash,proto3" json:"eventHash,omitempty"`
	// contains filtered or unexported fields
}

func (*AddEntryRequest) Descriptor

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

Deprecated: Use AddEntryRequest.ProtoReflect.Descriptor instead.

func (*AddEntryRequest) GetEventHash

func (x *AddEntryRequest) GetEventHash() []byte

func (*AddEntryRequest) GetEventReference

func (x *AddEntryRequest) GetEventReference() []byte

func (*AddEntryRequest) GetPersonReference

func (x *AddEntryRequest) GetPersonReference() []byte

func (*AddEntryRequest) ProtoMessage

func (*AddEntryRequest) ProtoMessage()

func (*AddEntryRequest) ProtoReflect

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

func (*AddEntryRequest) Reset

func (x *AddEntryRequest) Reset()

func (*AddEntryRequest) String

func (x *AddEntryRequest) String() string

type JournalUpdateClient

type JournalUpdateClient interface {
	AddEntry(ctx context.Context, in *AddEntryRequest, opts ...grpc.CallOption) (*AddEntryReply, error)
}

JournalUpdateClient is the client API for JournalUpdate service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewJournalUpdateClient

func NewJournalUpdateClient(cc grpc.ClientConnInterface) JournalUpdateClient

type JournalUpdateServer

type JournalUpdateServer interface {
	AddEntry(context.Context, *AddEntryRequest) (*AddEntryReply, error)
	// contains filtered or unexported methods
}

JournalUpdateServer is the server API for JournalUpdate service. All implementations must embed UnimplementedJournalUpdateServer for forward compatibility

type UnimplementedJournalUpdateServer

type UnimplementedJournalUpdateServer struct {
}

UnimplementedJournalUpdateServer must be embedded to have forward compatible implementations.

func (UnimplementedJournalUpdateServer) AddEntry

func (UnimplementedJournalUpdateServer) AddEntry(context.Context, *AddEntryRequest) (*AddEntryReply, error)

type UnsafeJournalUpdateServer

type UnsafeJournalUpdateServer interface {
	// contains filtered or unexported methods
}

UnsafeJournalUpdateServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to JournalUpdateServer will result in compilation errors.