Documentation
¶
Overview ¶
Package pb is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- Constants
- Variables
- func RegisterBroodHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterBroodHandlerClient(ctx context.Context, mux *runtime.ServeMux, client BroodClient) error
- func RegisterBroodHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterBroodHandlerServer(ctx context.Context, mux *runtime.ServeMux, server BroodServer) error
- func RegisterBroodServer(s grpc.ServiceRegistrar, srv BroodServer)
- type Acknowledgement
- func (*Acknowledgement) Descriptor() ([]byte, []int)deprecated
- func (x *Acknowledgement) GetAcknowledged() bool
- func (x *Acknowledgement) GetSpore() *Spore
- func (x *Acknowledgement) GetTimestamp() *timestamppb.Timestamp
- func (*Acknowledgement) ProtoMessage()
- func (x *Acknowledgement) ProtoReflect() protoreflect.Message
- func (x *Acknowledgement) Reset()
- func (x *Acknowledgement) String() string
- type BroodClient
- type BroodServer
- type Brood_SubscribeClient
- type Brood_SubscribeServer
- type Hive
- type Spore
- func (*Spore) Descriptor() ([]byte, []int)deprecated
- func (x *Spore) GetData() []byte
- func (x *Spore) GetHive() *Hive
- func (x *Spore) GetId() string
- func (x *Spore) GetTimestamp() *timestamppb.Timestamp
- func (*Spore) ProtoMessage()
- func (x *Spore) ProtoReflect() protoreflect.Message
- func (x *Spore) Reset()
- func (x *Spore) String() string
- type UnimplementedBroodServer
- type UnsafeBroodServer
Constants ¶
const ( Brood_Publish_FullMethodName = "/pb.brood/Publish" Brood_Subscribe_FullMethodName = "/pb.brood/Subscribe" )
Variables ¶
var Brood_ServiceDesc = grpc.ServiceDesc{ ServiceName: "pb.brood", HandlerType: (*BroodServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "Publish", Handler: _Brood_Publish_Handler, }, }, Streams: []grpc.StreamDesc{ { StreamName: "Subscribe", Handler: _Brood_Subscribe_Handler, ServerStreams: true, }, }, Metadata: "brood.proto", }
Brood_ServiceDesc is the grpc.ServiceDesc for Brood service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
var File_brood_proto protoreflect.FileDescriptor
Functions ¶
func RegisterBroodHandler ¶
RegisterBroodHandler registers the http handlers for service Brood to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterBroodHandlerClient ¶
func RegisterBroodHandlerClient(ctx context.Context, mux *runtime.ServeMux, client BroodClient) error
RegisterBroodHandlerClient registers the http handlers for service Brood to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "BroodClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "BroodClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "BroodClient" to call the correct interceptors.
func RegisterBroodHandlerFromEndpoint ¶
func RegisterBroodHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterBroodHandlerFromEndpoint is same as RegisterBroodHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterBroodHandlerServer ¶
func RegisterBroodHandlerServer(ctx context.Context, mux *runtime.ServeMux, server BroodServer) error
RegisterBroodHandlerServer registers the http handlers for service Brood to "mux". UnaryRPC :call BroodServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterBroodHandlerFromEndpoint instead.
func RegisterBroodServer ¶
func RegisterBroodServer(s grpc.ServiceRegistrar, srv BroodServer)
Types ¶
type Acknowledgement ¶
type Acknowledgement struct {
Spore *Spore `protobuf:"bytes,1,opt,name=spore,proto3" json:"spore,omitempty"`
Acknowledged bool `protobuf:"varint,2,opt,name=acknowledged,proto3" json:"acknowledged,omitempty"`
Timestamp *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
// contains filtered or unexported fields
}
func (*Acknowledgement) Descriptor
deprecated
func (*Acknowledgement) Descriptor() ([]byte, []int)
Deprecated: Use Acknowledgement.ProtoReflect.Descriptor instead.
func (*Acknowledgement) GetAcknowledged ¶
func (x *Acknowledgement) GetAcknowledged() bool
func (*Acknowledgement) GetSpore ¶
func (x *Acknowledgement) GetSpore() *Spore
func (*Acknowledgement) GetTimestamp ¶
func (x *Acknowledgement) GetTimestamp() *timestamppb.Timestamp
func (*Acknowledgement) ProtoMessage ¶
func (*Acknowledgement) ProtoMessage()
func (*Acknowledgement) ProtoReflect ¶
func (x *Acknowledgement) ProtoReflect() protoreflect.Message
func (*Acknowledgement) Reset ¶
func (x *Acknowledgement) Reset()
func (*Acknowledgement) String ¶
func (x *Acknowledgement) String() string
type BroodClient ¶
type BroodClient interface {
Publish(ctx context.Context, in *Spore, opts ...grpc.CallOption) (*Acknowledgement, error)
Subscribe(ctx context.Context, in *Hive, opts ...grpc.CallOption) (Brood_SubscribeClient, error)
}
BroodClient is the client API for Brood 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 NewBroodClient ¶
func NewBroodClient(cc grpc.ClientConnInterface) BroodClient
type BroodServer ¶
type BroodServer interface {
Publish(context.Context, *Spore) (*Acknowledgement, error)
Subscribe(*Hive, Brood_SubscribeServer) error
// contains filtered or unexported methods
}
BroodServer is the server API for Brood service. All implementations must embed UnimplementedBroodServer for forward compatibility
type Brood_SubscribeClient ¶
type Brood_SubscribeClient interface {
Recv() (*Spore, error)
grpc.ClientStream
}
type Brood_SubscribeServer ¶
type Brood_SubscribeServer interface {
Send(*Spore) error
grpc.ServerStream
}
type Hive ¶
type Hive struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*Hive) Descriptor
deprecated
func (*Hive) ProtoMessage ¶
func (*Hive) ProtoMessage()
func (*Hive) ProtoReflect ¶
func (x *Hive) ProtoReflect() protoreflect.Message
type Spore ¶
type Spore struct {
Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
Hive *Hive `protobuf:"bytes,2,opt,name=hive,proto3" json:"hive,omitempty"`
Timestamp *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
Data []byte `protobuf:"bytes,20,opt,name=data,proto3" json:"data,omitempty"`
// contains filtered or unexported fields
}
func (*Spore) Descriptor
deprecated
func (*Spore) GetTimestamp ¶
func (x *Spore) GetTimestamp() *timestamppb.Timestamp
func (*Spore) ProtoMessage ¶
func (*Spore) ProtoMessage()
func (*Spore) ProtoReflect ¶
func (x *Spore) ProtoReflect() protoreflect.Message
type UnimplementedBroodServer ¶
type UnimplementedBroodServer struct {
}
UnimplementedBroodServer must be embedded to have forward compatible implementations.
func (UnimplementedBroodServer) Publish ¶
func (UnimplementedBroodServer) Publish(context.Context, *Spore) (*Acknowledgement, error)
func (UnimplementedBroodServer) Subscribe ¶
func (UnimplementedBroodServer) Subscribe(*Hive, Brood_SubscribeServer) error
type UnsafeBroodServer ¶
type UnsafeBroodServer interface {
// contains filtered or unexported methods
}
UnsafeBroodServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to BroodServer will result in compilation errors.
Source Files