litterboxsvc

package
v0.6.0 Latest Latest
Warning

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

 Go to latest Published: Jun 2, 2022 License: MIT Imports: 30 Imported by: 0

Documentation

Overview

Package litterboxsvc is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

This section is empty.

Variables

View Source 
var File_litterboxsvc_svc_proto protoreflect.FileDescriptor
View Source 
var LitterBox_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "autokitteh.litterbox.LitterBox",
	HandlerType: (*LitterBoxServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Setup",
			Handler:    _LitterBox_Setup_Handler,
		},
		{
			MethodName: "Scoop",
			Handler:    _LitterBox_Scoop_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "Event",
			Handler:       _LitterBox_Event_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "litterboxsvc/svc.proto",
}

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

Functions

func RegisterLitterBoxHandler 

func RegisterLitterBoxHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterLitterBoxHandler registers the http handlers for service LitterBox to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterLitterBoxHandlerClient 

func RegisterLitterBoxHandlerClient(ctx context.Context, mux *runtime.ServeMux, client LitterBoxClient) error

RegisterLitterBoxHandlerClient registers the http handlers for service LitterBox to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "LitterBoxClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "LitterBoxClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "LitterBoxClient" to call the correct interceptors.

func RegisterLitterBoxHandlerFromEndpoint 

func RegisterLitterBoxHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterLitterBoxHandlerFromEndpoint is same as RegisterLitterBoxHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterLitterBoxHandlerServer 

func RegisterLitterBoxHandlerServer(ctx context.Context, mux *runtime.ServeMux, server LitterBoxServer) error

RegisterLitterBoxHandlerServer registers the http handlers for service LitterBox to "mux". UnaryRPC :call LitterBoxServer 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 RegisterLitterBoxHandlerFromEndpoint instead.

func RegisterLitterBoxServer 

func RegisterLitterBoxServer(s grpc.ServiceRegistrar, srv LitterBoxServer)

Types

type EventRequest added in v0.6.0 

type EventRequest struct {
	Id    string          `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	Event *LitterBoxEvent `protobuf:"bytes,2,opt,name=event,proto3" json:"event,omitempty"`
	// contains filtered or unexported fields
}

func (*EventRequest) Descriptor deprecated added in v0.6.0 

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

Deprecated: Use EventRequest.ProtoReflect.Descriptor instead.

func (*EventRequest) GetEvent added in v0.6.0 

func (x *EventRequest) GetEvent() *LitterBoxEvent

func (*EventRequest) GetId added in v0.6.0 

func (x *EventRequest) GetId() string

func (*EventRequest) ProtoMessage added in v0.6.0 

func (*EventRequest) ProtoMessage()

func (*EventRequest) ProtoReflect added in v0.6.0 

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

func (*EventRequest) Reset added in v0.6.0 

func (x *EventRequest) Reset()

func (*EventRequest) String added in v0.6.0 

func (x *EventRequest) String() string

func (*EventRequest) Validate added in v0.6.0 

func (m *EventRequest) Validate() error

Validate checks the field values on EventRequest with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type EventRequestValidationError added in v0.6.0 

type EventRequestValidationError struct {
	// contains filtered or unexported fields
}

EventRequestValidationError is the validation error returned by EventRequest.Validate if the designated constraints aren't met.

func (EventRequestValidationError) Cause added in v0.6.0 

func (e EventRequestValidationError) Cause() error

Cause function returns cause value.

func (EventRequestValidationError) Error added in v0.6.0 

func (e EventRequestValidationError) Error() string

Error satisfies the builtin error interface

func (EventRequestValidationError) ErrorName added in v0.6.0 

func (e EventRequestValidationError) ErrorName() string

ErrorName returns error name.

func (EventRequestValidationError) Field added in v0.6.0 

func (e EventRequestValidationError) Field() string

Field function returns field value.

func (EventRequestValidationError) Key added in v0.6.0 

func (e EventRequestValidationError) Key() bool

Key function returns key value.

func (EventRequestValidationError) Reason added in v0.6.0 

func (e EventRequestValidationError) Reason() string

Reason function returns reason value.

type LitterBoxClient 

type LitterBoxClient interface {
	Setup(ctx context.Context, in *SetupRequest, opts ...grpc.CallOption) (*SetupResponse, error)
	Event(ctx context.Context, in *EventRequest, opts ...grpc.CallOption) (LitterBox_EventClient, error)
	Scoop(ctx context.Context, in *ScoopRequest, opts ...grpc.CallOption) (*ScoopResponse, error)
}

LitterBoxClient is the client API for LitterBox 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 NewLitterBoxClient 

func NewLitterBoxClient(cc grpc.ClientConnInterface) LitterBoxClient

type LitterBoxEvent added in v0.6.0 

type LitterBoxEvent struct {
	SrcBinding string                   `protobuf:"bytes,1,opt,name=src_binding,json=srcBinding,proto3" json:"src_binding,omitempty"`
	Type       string                   `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
	Data       map[string]*values.Value `` /* 149-byte string literal not displayed */
	OriginalId string                   `protobuf:"bytes,4,opt,name=original_id,json=originalId,proto3" json:"original_id,omitempty"`
	// contains filtered or unexported fields
}

func (*LitterBoxEvent) Descriptor deprecated added in v0.6.0 

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

Deprecated: Use LitterBoxEvent.ProtoReflect.Descriptor instead.

func (*LitterBoxEvent) GetData added in v0.6.0 

func (x *LitterBoxEvent) GetData() map[string]*values.Value

func (*LitterBoxEvent) GetOriginalId added in v0.6.0 

func (x *LitterBoxEvent) GetOriginalId() string

func (*LitterBoxEvent) GetSrcBinding added in v0.6.0 

func (x *LitterBoxEvent) GetSrcBinding() string

func (*LitterBoxEvent) GetType added in v0.6.0 

func (x *LitterBoxEvent) GetType() string

func (*LitterBoxEvent) ProtoMessage added in v0.6.0 

func (*LitterBoxEvent) ProtoMessage()

func (*LitterBoxEvent) ProtoReflect added in v0.6.0 

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

func (*LitterBoxEvent) Reset added in v0.6.0 

func (x *LitterBoxEvent) Reset()

func (*LitterBoxEvent) String added in v0.6.0 

func (x *LitterBoxEvent) String() string

func (*LitterBoxEvent) Validate added in v0.6.0 

func (m *LitterBoxEvent) Validate() error

Validate checks the field values on LitterBoxEvent with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type LitterBoxEventValidationError added in v0.6.0 

type LitterBoxEventValidationError struct {
	// contains filtered or unexported fields
}

LitterBoxEventValidationError is the validation error returned by LitterBoxEvent.Validate if the designated constraints aren't met.

func (LitterBoxEventValidationError) Cause added in v0.6.0 

func (e LitterBoxEventValidationError) Cause() error

Cause function returns cause value.

func (LitterBoxEventValidationError) Error added in v0.6.0 

func (e LitterBoxEventValidationError) Error() string

Error satisfies the builtin error interface

func (LitterBoxEventValidationError) ErrorName added in v0.6.0 

func (e LitterBoxEventValidationError) ErrorName() string

ErrorName returns error name.

func (LitterBoxEventValidationError) Field added in v0.6.0 

func (e LitterBoxEventValidationError) Field() string

Field function returns field value.

func (LitterBoxEventValidationError) Key added in v0.6.0 

func (e LitterBoxEventValidationError) Key() bool

Key function returns key value.

func (LitterBoxEventValidationError) Reason added in v0.6.0 

func (e LitterBoxEventValidationError) Reason() string

Reason function returns reason value.

type LitterBoxServer 

type LitterBoxServer interface {
	Setup(context.Context, *SetupRequest) (*SetupResponse, error)
	Event(*EventRequest, LitterBox_EventServer) error
	Scoop(context.Context, *ScoopRequest) (*ScoopResponse, error)
	// contains filtered or unexported methods
}

LitterBoxServer is the server API for LitterBox service. All implementations must embed UnimplementedLitterBoxServer for forward compatibility

type LitterBox_EventClient added in v0.6.0 

type LitterBox_EventClient interface {
	Recv() (*event.TrackIngestEventUpdate, error)
	grpc.ClientStream
}

type LitterBox_EventServer added in v0.6.0 

type LitterBox_EventServer interface {
	Send(*event.TrackIngestEventUpdate) error
	grpc.ServerStream
}

type ScoopRequest 

type ScoopRequest struct {
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

func (*ScoopRequest) Descriptor deprecated 

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

Deprecated: Use ScoopRequest.ProtoReflect.Descriptor instead.

func (*ScoopRequest) GetId 

func (x *ScoopRequest) GetId() string

func (*ScoopRequest) ProtoMessage 

func (*ScoopRequest) ProtoMessage()

func (*ScoopRequest) ProtoReflect 

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

func (*ScoopRequest) Reset 

func (x *ScoopRequest) Reset()

func (*ScoopRequest) String 

func (x *ScoopRequest) String() string

func (*ScoopRequest) Validate 

func (m *ScoopRequest) Validate() error

Validate checks the field values on ScoopRequest with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type ScoopRequestValidationError 

type ScoopRequestValidationError struct {
	// contains filtered or unexported fields
}

ScoopRequestValidationError is the validation error returned by ScoopRequest.Validate if the designated constraints aren't met.

func (ScoopRequestValidationError) Cause 

func (e ScoopRequestValidationError) Cause() error

Cause function returns cause value.

func (ScoopRequestValidationError) Error 

func (e ScoopRequestValidationError) Error() string

Error satisfies the builtin error interface

func (ScoopRequestValidationError) ErrorName 

func (e ScoopRequestValidationError) ErrorName() string

ErrorName returns error name.

func (ScoopRequestValidationError) Field 

func (e ScoopRequestValidationError) Field() string

Field function returns field value.

func (ScoopRequestValidationError) Key 

func (e ScoopRequestValidationError) Key() bool

Key function returns key value.

func (ScoopRequestValidationError) Reason 

func (e ScoopRequestValidationError) Reason() string

Reason function returns reason value.

type ScoopResponse 

type ScoopResponse struct {
	// contains filtered or unexported fields
}

func (*ScoopResponse) Descriptor deprecated 

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

Deprecated: Use ScoopResponse.ProtoReflect.Descriptor instead.

func (*ScoopResponse) ProtoMessage 

func (*ScoopResponse) ProtoMessage()

func (*ScoopResponse) ProtoReflect 

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

func (*ScoopResponse) Reset 

func (x *ScoopResponse) Reset()

func (*ScoopResponse) String 

func (x *ScoopResponse) String() string

func (*ScoopResponse) Validate 

func (m *ScoopResponse) Validate() error

Validate checks the field values on ScoopResponse with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type ScoopResponseValidationError 

type ScoopResponseValidationError struct {
	// contains filtered or unexported fields
}

ScoopResponseValidationError is the validation error returned by ScoopResponse.Validate if the designated constraints aren't met.

func (ScoopResponseValidationError) Cause 

func (e ScoopResponseValidationError) Cause() error

Cause function returns cause value.

func (ScoopResponseValidationError) Error 

func (e ScoopResponseValidationError) Error() string

Error satisfies the builtin error interface

func (ScoopResponseValidationError) ErrorName 

func (e ScoopResponseValidationError) ErrorName() string

ErrorName returns error name.

func (ScoopResponseValidationError) Field 

func (e ScoopResponseValidationError) Field() string

Field function returns field value.

func (ScoopResponseValidationError) Key 

func (e ScoopResponseValidationError) Key() bool

Key function returns key value.

func (ScoopResponseValidationError) Reason 

func (e ScoopResponseValidationError) Reason() string

Reason function returns reason value.

type SetupRequest 

type SetupRequest struct {
	Id             string            `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	SourcesMap     map[string][]byte `` /* 179-byte string literal not displayed */
	MainSourceName string            `protobuf:"bytes,3,opt,name=main_source_name,json=mainSourceName,proto3" json:"main_source_name,omitempty"`
	Sources        []byte            `protobuf:"bytes,4,opt,name=sources,proto3" json:"sources,omitempty"` // in txtar format (see https://pkg.go.dev/golang.org/x/tools/txtar).
	// contains filtered or unexported fields
}

func (*SetupRequest) Descriptor deprecated 

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

Deprecated: Use SetupRequest.ProtoReflect.Descriptor instead.

func (*SetupRequest) GetId added in v0.6.0 

func (x *SetupRequest) GetId() string

func (*SetupRequest) GetMainSourceName added in v0.6.0 

func (x *SetupRequest) GetMainSourceName() string

func (*SetupRequest) GetSources added in v0.6.0 

func (x *SetupRequest) GetSources() []byte

func (*SetupRequest) GetSourcesMap added in v0.6.0 

func (x *SetupRequest) GetSourcesMap() map[string][]byte

func (*SetupRequest) ProtoMessage 

func (*SetupRequest) ProtoMessage()

func (*SetupRequest) ProtoReflect 

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

func (*SetupRequest) Reset 

func (x *SetupRequest) Reset()

func (*SetupRequest) String 

func (x *SetupRequest) String() string

func (*SetupRequest) Validate 

func (m *SetupRequest) Validate() error

Validate checks the field values on SetupRequest with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type SetupRequestValidationError 

type SetupRequestValidationError struct {
	// contains filtered or unexported fields
}

SetupRequestValidationError is the validation error returned by SetupRequest.Validate if the designated constraints aren't met.

func (SetupRequestValidationError) Cause 

func (e SetupRequestValidationError) Cause() error

Cause function returns cause value.

func (SetupRequestValidationError) Error 

func (e SetupRequestValidationError) Error() string

Error satisfies the builtin error interface

func (SetupRequestValidationError) ErrorName 

func (e SetupRequestValidationError) ErrorName() string

ErrorName returns error name.

func (SetupRequestValidationError) Field 

func (e SetupRequestValidationError) Field() string

Field function returns field value.

func (SetupRequestValidationError) Key 

func (e SetupRequestValidationError) Key() bool

Key function returns key value.

func (SetupRequestValidationError) Reason 

func (e SetupRequestValidationError) Reason() string

Reason function returns reason value.

type SetupResponse 

type SetupResponse struct {
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

func (*SetupResponse) Descriptor deprecated 

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

Deprecated: Use SetupResponse.ProtoReflect.Descriptor instead.

func (*SetupResponse) GetId 

func (x *SetupResponse) GetId() string

func (*SetupResponse) ProtoMessage 

func (*SetupResponse) ProtoMessage()

func (*SetupResponse) ProtoReflect 

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

func (*SetupResponse) Reset 

func (x *SetupResponse) Reset()

func (*SetupResponse) String 

func (x *SetupResponse) String() string

func (*SetupResponse) Validate 

func (m *SetupResponse) Validate() error

Validate checks the field values on SetupResponse with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type SetupResponseValidationError 

type SetupResponseValidationError struct {
	// contains filtered or unexported fields
}

SetupResponseValidationError is the validation error returned by SetupResponse.Validate if the designated constraints aren't met.

func (SetupResponseValidationError) Cause 

func (e SetupResponseValidationError) Cause() error

Cause function returns cause value.

func (SetupResponseValidationError) Error 

func (e SetupResponseValidationError) Error() string

Error satisfies the builtin error interface

func (SetupResponseValidationError) ErrorName 

func (e SetupResponseValidationError) ErrorName() string

ErrorName returns error name.

func (SetupResponseValidationError) Field 

func (e SetupResponseValidationError) Field() string

Field function returns field value.

func (SetupResponseValidationError) Key 

func (e SetupResponseValidationError) Key() bool

Key function returns key value.

func (SetupResponseValidationError) Reason 

func (e SetupResponseValidationError) Reason() string

Reason function returns reason value.

type UnimplementedLitterBoxServer 

type UnimplementedLitterBoxServer struct {
}

UnimplementedLitterBoxServer must be embedded to have forward compatible implementations.

func (UnimplementedLitterBoxServer) Event added in v0.6.0 

func (UnimplementedLitterBoxServer) Event(*EventRequest, LitterBox_EventServer) error

func (UnimplementedLitterBoxServer) Scoop 

func (UnimplementedLitterBoxServer) Scoop(context.Context, *ScoopRequest) (*ScoopResponse, error)

func (UnimplementedLitterBoxServer) Setup 

func (UnimplementedLitterBoxServer) Setup(context.Context, *SetupRequest) (*SetupResponse, error)

type UnsafeLitterBoxServer 

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

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

Source Files

View all Source files

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.