eventstreamspec

package
v0.5.3 Latest Latest
Warning

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

 Go to latest Published: Jun 12, 2023 License: MIT Imports: 9 Imported by: 2

Documentation

Index

Constants

View Source 
const (
	StreamAPI_Consume_FullMethodName    = "/dogma.interop.v1.eventstream.StreamAPI/Consume"
	StreamAPI_EventTypes_FullMethodName = "/dogma.interop.v1.eventstream.StreamAPI/EventTypes"
)

Variables

View Source 
var File_github_com_dogmatiq_interopspec_eventstreamspec_streamapi_proto protoreflect.FileDescriptor
View Source 
var StreamAPI_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "dogma.interop.v1.eventstream.StreamAPI",
	HandlerType: (*StreamAPIServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "EventTypes",
			Handler:    _StreamAPI_EventTypes_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "Consume",
			Handler:       _StreamAPI_Consume_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "github.com/dogmatiq/interopspec/eventstreamspec/streamapi.proto",
}

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

Functions

func RegisterStreamAPIServer 

func RegisterStreamAPIServer(s grpc.ServiceRegistrar, srv StreamAPIServer)

Types

type ConsumeRequest 

type ConsumeRequest struct {

	// ApplicationKey is the identity key of the application to consume from.
	ApplicationKey string `protobuf:"bytes,1,opt,name=application_key,json=applicationKey,proto3" json:"application_key,omitempty"`
	// EventTypes is a list of event types to be consumed.
	EventTypes []*EventType `protobuf:"bytes,2,rep,name=event_types,json=eventTypes,proto3" json:"event_types,omitempty"`
	// StartPoint specifies the point within the stream to start consuming.
	//
	// Types that are assignable to StartPoint:
	//
	//	*ConsumeRequest_Offset
	StartPoint isConsumeRequest_StartPoint `protobuf_oneof:"start_point"`
	// contains filtered or unexported fields
}

func (*ConsumeRequest) Descriptor deprecated 

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

Deprecated: Use ConsumeRequest.ProtoReflect.Descriptor instead.

func (*ConsumeRequest) GetApplicationKey 

func (x *ConsumeRequest) GetApplicationKey() string

func (*ConsumeRequest) GetEventTypes 

func (x *ConsumeRequest) GetEventTypes() []*EventType

func (*ConsumeRequest) GetOffset 

func (x *ConsumeRequest) GetOffset() uint64

func (*ConsumeRequest) GetStartPoint 

func (m *ConsumeRequest) GetStartPoint() isConsumeRequest_StartPoint

func (*ConsumeRequest) ProtoMessage 

func (*ConsumeRequest) ProtoMessage()

func (*ConsumeRequest) ProtoReflect 

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

func (*ConsumeRequest) Reset 

func (x *ConsumeRequest) Reset()

func (*ConsumeRequest) String 

func (x *ConsumeRequest) String() string

type ConsumeRequest_Offset 

type ConsumeRequest_Offset struct {
	// Offset is the offset of the earliest message to be consumed.
	//
	// The offset of the message returned will be greater than this value if the
	// event at that offset is not one of the requested event types.
	Offset uint64 `protobuf:"varint,3,opt,name=offset,proto3,oneof"`
}

type ConsumeResponse 

type ConsumeResponse struct {

	// Offset is the offset of the message.
	Offset uint64 `protobuf:"varint,1,opt,name=offset,proto3" json:"offset,omitempty"`
	// Envelope is the envelope containing the event.
	Envelope *envelopespec.Envelope `protobuf:"bytes,2,opt,name=envelope,proto3" json:"envelope,omitempty"`
	// contains filtered or unexported fields
}

func (*ConsumeResponse) Descriptor deprecated 

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

Deprecated: Use ConsumeResponse.ProtoReflect.Descriptor instead.

func (*ConsumeResponse) GetEnvelope 

func (x *ConsumeResponse) GetEnvelope() *envelopespec.Envelope

func (*ConsumeResponse) GetOffset 

func (x *ConsumeResponse) GetOffset() uint64

func (*ConsumeResponse) ProtoMessage 

func (*ConsumeResponse) ProtoMessage()

func (*ConsumeResponse) ProtoReflect 

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

func (*ConsumeResponse) Reset 

func (x *ConsumeResponse) Reset()

func (*ConsumeResponse) String 

func (x *ConsumeResponse) String() string

type EventType 

type EventType struct {

	// PortableName is a name that uniquely identifies the event type across
	// process boundaries.
	PortableName string `protobuf:"bytes,1,opt,name=portable_name,json=portableName,proto3" json:"portable_name,omitempty"`
	// MediaTypes is the set of supported media-types that can be used to
	// represents events of this type, in order of preference.
	MediaTypes []string `protobuf:"bytes,2,rep,name=media_types,json=mediaTypes,proto3" json:"media_types,omitempty"`
	// contains filtered or unexported fields
}

func (*EventType) Descriptor deprecated 

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

Deprecated: Use EventType.ProtoReflect.Descriptor instead.

func (*EventType) GetMediaTypes 

func (x *EventType) GetMediaTypes() []string

func (*EventType) GetPortableName 

func (x *EventType) GetPortableName() string

func (*EventType) ProtoMessage 

func (*EventType) ProtoMessage()

func (*EventType) ProtoReflect 

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

func (*EventType) Reset 

func (x *EventType) Reset()

func (*EventType) String 

func (x *EventType) String() string

type EventTypesRequest 

type EventTypesRequest struct {

	// ApplicationKey is the identity key of the application to query.
	ApplicationKey string `protobuf:"bytes,1,opt,name=application_key,json=applicationKey,proto3" json:"application_key,omitempty"`
	// contains filtered or unexported fields
}

func (*EventTypesRequest) Descriptor deprecated 

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

Deprecated: Use EventTypesRequest.ProtoReflect.Descriptor instead.

func (*EventTypesRequest) GetApplicationKey added in v0.5.0 

func (x *EventTypesRequest) GetApplicationKey() string

func (*EventTypesRequest) ProtoMessage 

func (*EventTypesRequest) ProtoMessage()

func (*EventTypesRequest) ProtoReflect 

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

func (*EventTypesRequest) Reset 

func (x *EventTypesRequest) Reset()

func (*EventTypesRequest) String 

func (x *EventTypesRequest) String() string

type EventTypesResponse 

type EventTypesResponse struct {

	// EventTypes is a list of event types supported by the server.
	EventTypes []*EventType `protobuf:"bytes,1,rep,name=event_types,json=eventTypes,proto3" json:"event_types,omitempty"`
	// contains filtered or unexported fields
}

func (*EventTypesResponse) Descriptor deprecated 

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

Deprecated: Use EventTypesResponse.ProtoReflect.Descriptor instead.

func (*EventTypesResponse) GetEventTypes 

func (x *EventTypesResponse) GetEventTypes() []*EventType

func (*EventTypesResponse) ProtoMessage 

func (*EventTypesResponse) ProtoMessage()

func (*EventTypesResponse) ProtoReflect 

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

func (*EventTypesResponse) Reset 

func (x *EventTypesResponse) Reset()

func (*EventTypesResponse) String 

func (x *EventTypesResponse) String() string

type NoRecognizedMediaTypes 

type NoRecognizedMediaTypes struct {

	// PortableName is a name that uniquely identifies the event type across
	// process boundaries.
	PortableName string `protobuf:"bytes,2,opt,name=portable_name,json=portableName,proto3" json:"portable_name,omitempty"`
	// contains filtered or unexported fields
}

NoRecognizedMediaTypes is an error-details value for INVALID_ARGUMENT errors that occurred because a client requested that events of a specific type be encoded using media-types that are not recognized by the server.

func (*NoRecognizedMediaTypes) Descriptor deprecated 

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

Deprecated: Use NoRecognizedMediaTypes.ProtoReflect.Descriptor instead.

func (*NoRecognizedMediaTypes) GetPortableName 

func (x *NoRecognizedMediaTypes) GetPortableName() string

func (*NoRecognizedMediaTypes) ProtoMessage 

func (*NoRecognizedMediaTypes) ProtoMessage()

func (*NoRecognizedMediaTypes) ProtoReflect 

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

func (*NoRecognizedMediaTypes) Reset 

func (x *NoRecognizedMediaTypes) Reset()

func (*NoRecognizedMediaTypes) String 

func (x *NoRecognizedMediaTypes) String() string

type StreamAPIClient 

type StreamAPIClient interface {
	// Consume starts consuming from a particular "start point" within an
	// application's event stream.
	//
	// The start point can be specified using different mechanisms. If the server
	// does not support the requested mechanism it MUST return an UNIMPLEMENTED
	// error with an attached UnimplementedStartPointMechanism value.
	//
	// If the requested start point is beyond the end of the application's event
	// stream, the server SHOULD keep the stream open and send new events as they
	// are produced.
	//
	// If the start point is requested in a manner not supported by the server, it
	// MUST return an UNIMPLEMENTED error with an attached UnsupportedStartPoint
	// value.
	//
	// If the server does not host the application specified in the request, it
	// MUST return a NOT_FOUND error with an attached UnrecognizedApplication
	// value.
	//
	// If any of the requested event types are not produced by the specified
	// application the server MUST return an INVALID_ARGUMENT error with an
	// attached UnrecognizedEventType value for each unrecognized event type.
	//
	// If none of the requested media-types for a given event type are supported
	// the server MUST return an INVALID_ARGUMENT error with an attached
	// NoRecognizedMediaTypes value for each such event type.
	Consume(ctx context.Context, in *ConsumeRequest, opts ...grpc.CallOption) (StreamAPI_ConsumeClient, error)
	// EventTypes queries the event types that the server supports for a specific
	// application.
	//
	// If the server does not host the application specified in the request, it
	// MUST return a NOT_FOUND error with an attached UnrecognizedApplication
	// value.
	EventTypes(ctx context.Context, in *EventTypesRequest, opts ...grpc.CallOption) (*EventTypesResponse, error)
}

StreamAPIClient is the client API for StreamAPI 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 NewStreamAPIClient 

func NewStreamAPIClient(cc grpc.ClientConnInterface) StreamAPIClient

type StreamAPIServer 

type StreamAPIServer interface {
	// Consume starts consuming from a particular "start point" within an
	// application's event stream.
	//
	// The start point can be specified using different mechanisms. If the server
	// does not support the requested mechanism it MUST return an UNIMPLEMENTED
	// error with an attached UnimplementedStartPointMechanism value.
	//
	// If the requested start point is beyond the end of the application's event
	// stream, the server SHOULD keep the stream open and send new events as they
	// are produced.
	//
	// If the start point is requested in a manner not supported by the server, it
	// MUST return an UNIMPLEMENTED error with an attached UnsupportedStartPoint
	// value.
	//
	// If the server does not host the application specified in the request, it
	// MUST return a NOT_FOUND error with an attached UnrecognizedApplication
	// value.
	//
	// If any of the requested event types are not produced by the specified
	// application the server MUST return an INVALID_ARGUMENT error with an
	// attached UnrecognizedEventType value for each unrecognized event type.
	//
	// If none of the requested media-types for a given event type are supported
	// the server MUST return an INVALID_ARGUMENT error with an attached
	// NoRecognizedMediaTypes value for each such event type.
	Consume(*ConsumeRequest, StreamAPI_ConsumeServer) error
	// EventTypes queries the event types that the server supports for a specific
	// application.
	//
	// If the server does not host the application specified in the request, it
	// MUST return a NOT_FOUND error with an attached UnrecognizedApplication
	// value.
	EventTypes(context.Context, *EventTypesRequest) (*EventTypesResponse, error)
}

StreamAPIServer is the server API for StreamAPI service. All implementations should embed UnimplementedStreamAPIServer for forward compatibility

type StreamAPI_ConsumeClient 

type StreamAPI_ConsumeClient interface {
	Recv() (*ConsumeResponse, error)
	grpc.ClientStream
}

type StreamAPI_ConsumeServer 

type StreamAPI_ConsumeServer interface {
	Send(*ConsumeResponse) error
	grpc.ServerStream
}

type UnimplementedStreamAPIServer 

type UnimplementedStreamAPIServer struct {
}

UnimplementedStreamAPIServer should be embedded to have forward compatible implementations.

func (UnimplementedStreamAPIServer) Consume 

func (UnimplementedStreamAPIServer) Consume(*ConsumeRequest, StreamAPI_ConsumeServer) error

func (UnimplementedStreamAPIServer) EventTypes 

func (UnimplementedStreamAPIServer) EventTypes(context.Context, *EventTypesRequest) (*EventTypesResponse, error)

type UnrecognizedApplication 

type UnrecognizedApplication struct {

	// ApplicationKey is the identity of the application that produced the error.
	ApplicationKey string `protobuf:"bytes,1,opt,name=application_key,json=applicationKey,proto3" json:"application_key,omitempty"`
	// contains filtered or unexported fields
}

UnrecognizedApplication is an error-details value for INVALID_ARGUMENT errors that occurred because a specific application key was not recognized by the server.

func (*UnrecognizedApplication) Descriptor deprecated 

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

Deprecated: Use UnrecognizedApplication.ProtoReflect.Descriptor instead.

func (*UnrecognizedApplication) GetApplicationKey 

func (x *UnrecognizedApplication) GetApplicationKey() string

func (*UnrecognizedApplication) ProtoMessage 

func (*UnrecognizedApplication) ProtoMessage()

func (*UnrecognizedApplication) ProtoReflect 

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

func (*UnrecognizedApplication) Reset 

func (x *UnrecognizedApplication) Reset()

func (*UnrecognizedApplication) String 

func (x *UnrecognizedApplication) String() string

type UnrecognizedEventType 

type UnrecognizedEventType struct {

	// PortableName is a name that uniquely identifies the event type across
	// process boundaries.
	PortableName string `protobuf:"bytes,2,opt,name=portable_name,json=portableName,proto3" json:"portable_name,omitempty"`
	// contains filtered or unexported fields
}

UnrecognizedEventType is an error-details value for INVALID_ARGUMENT errors that occurred because a specific event type was not recognized by the server.

func (*UnrecognizedEventType) Descriptor deprecated 

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

Deprecated: Use UnrecognizedEventType.ProtoReflect.Descriptor instead.

func (*UnrecognizedEventType) GetPortableName 

func (x *UnrecognizedEventType) GetPortableName() string

func (*UnrecognizedEventType) ProtoMessage 

func (*UnrecognizedEventType) ProtoMessage()

func (*UnrecognizedEventType) ProtoReflect 

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

func (*UnrecognizedEventType) Reset 

func (x *UnrecognizedEventType) Reset()

func (*UnrecognizedEventType) String 

func (x *UnrecognizedEventType) String() string

type UnsafeStreamAPIServer added in v0.5.1 

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

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

type UnsupportedStartPoint added in v0.5.0 

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

UnsupportedStartPoint is an error-details value for UNIMPLEMENTED errors that occurred because a client started consuming using a start point specified in a way that is not supported by the server.

func (*UnsupportedStartPoint) Descriptor deprecated added in v0.5.0 

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

Deprecated: Use UnsupportedStartPoint.ProtoReflect.Descriptor instead.

func (*UnsupportedStartPoint) ProtoMessage added in v0.5.0 

func (*UnsupportedStartPoint) ProtoMessage()

func (*UnsupportedStartPoint) ProtoReflect added in v0.5.0 

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

func (*UnsupportedStartPoint) Reset added in v0.5.0 

func (x *UnsupportedStartPoint) Reset()

func (*UnsupportedStartPoint) String added in v0.5.0 

func (x *UnsupportedStartPoint) String() string

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.