es_proto

package
v0.4.2 Latest Latest
Warning

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

Go to latest
Published: Jan 2, 2022 License: GPL-3.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	OpResponse_Result_name = map[int32]string{
		0: "FAILED",
		1: "OK",
	}
	OpResponse_Result_value = map[string]int32{
		"FAILED": 0,
		"OK":     1,
	}
)

Enum value maps for OpResponse_Result.

View Source
var (
	Filter_FilterType_name = map[int32]string{
		0: "HAS_NAME",
		1: "IN_NAME",
		2: "IN_DESCR",
	}
	Filter_FilterType_value = map[string]int32{
		"HAS_NAME": 0,
		"IN_NAME":  1,
		"IN_DESCR": 2,
	}
)

Enum value maps for Filter_FilterType.

View Source
var EventService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "es_proto.EventService",
	HandlerType: (*EventServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "HasTopic",
			Handler:    _EventService_HasTopic_Handler,
		},
		{
			MethodName: "AddTopics",
			Handler:    _EventService_AddTopics_Handler,
		},
		{
			MethodName: "DelTopics",
			Handler:    _EventService_DelTopics_Handler,
		},
		{
			MethodName: "AddEvent",
			Handler:    _EventService_AddEvent_Handler,
		},
		{
			MethodName: "UnSubscribe",
			Handler:    _EventService_UnSubscribe_Handler,
		},
		{
			MethodName: "StopSubscriptionStream",
			Handler:    _EventService_StopSubscriptionStream_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "Subscribe",
			Handler:       _EventService_Subscribe_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "proto/es.proto",
}

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

View Source
var File_proto_es_proto protoreflect.FileDescriptor

Functions

func RegisterEventServiceServer

func RegisterEventServiceServer(s grpc.ServiceRegistrar, srv EventServiceServer)

Types

type AddTopicReq

type AddTopicReq struct {

	// host server id
	ServerId string `protobuf:"bytes,1,opt,name=server_id,json=serverId,proto3" json:"server_id,omitempty"`
	// topic or branch to add
	Topic string `protobuf:"bytes,2,opt,name=topic,proto3" json:"topic,omitempty"`
	// base topic to add into. Base topic should be on the host server
	// or RPC failed.
	FromTopic string `protobuf:"bytes,3,opt,name=from_topic,json=fromTopic,proto3" json:"from_topic,omitempty"`
	// contains filtered or unexported fields
}

func (*AddTopicReq) Descriptor deprecated

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

Deprecated: Use AddTopicReq.ProtoReflect.Descriptor instead.

func (*AddTopicReq) GetFromTopic

func (x *AddTopicReq) GetFromTopic() string

func (*AddTopicReq) GetServerId

func (x *AddTopicReq) GetServerId() string

func (*AddTopicReq) GetTopic

func (x *AddTopicReq) GetTopic() string

func (*AddTopicReq) ProtoMessage

func (*AddTopicReq) ProtoMessage()

func (*AddTopicReq) ProtoReflect

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

func (*AddTopicReq) Reset

func (x *AddTopicReq) Reset()

func (*AddTopicReq) String

func (x *AddTopicReq) String() string

type DelTopicReq

type DelTopicReq struct {

	// host server id
	ServerId string `protobuf:"bytes,1,opt,name=server_id,json=serverId,proto3" json:"server_id,omitempty"`
	// topic to remove.
	Topic string `protobuf:"bytes,2,opt,name=topic,proto3" json:"topic,omitempty"`
	// if recursive is true, the whole branch started from topic and all
	// its subtopics.
	// if topic has subtopcs and recursive is false, error will be returned.
	Recursive bool `protobuf:"varint,3,opt,name=recursive,proto3" json:"recursive,omitempty"`
	// contains filtered or unexported fields
}

func (*DelTopicReq) Descriptor deprecated

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

Deprecated: Use DelTopicReq.ProtoReflect.Descriptor instead.

func (*DelTopicReq) GetRecursive

func (x *DelTopicReq) GetRecursive() bool

func (*DelTopicReq) GetServerId

func (x *DelTopicReq) GetServerId() string

func (*DelTopicReq) GetTopic

func (x *DelTopicReq) GetTopic() string

func (*DelTopicReq) ProtoMessage

func (*DelTopicReq) ProtoMessage()

func (*DelTopicReq) ProtoReflect

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

func (*DelTopicReq) Reset

func (x *DelTopicReq) Reset()

func (*DelTopicReq) String

func (x *DelTopicReq) String() string

type Event

type Event struct {

	// event name
	EvtName string `protobuf:"bytes,1,opt,name=evt_name,json=evtName,proto3" json:"evt_name,omitempty"`
	// event details
	EvtDetails string `protobuf:"bytes,2,opt,name=evt_details,json=evtDetails,proto3" json:"evt_details,omitempty"`
	// event time in unix milliseconds
	Timestamp int64 `protobuf:"varint,3,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	// contains filtered or unexported fields
}

func (*Event) Descriptor deprecated

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

Deprecated: Use Event.ProtoReflect.Descriptor instead.

func (*Event) GetEvtDetails

func (x *Event) GetEvtDetails() string

func (*Event) GetEvtName

func (x *Event) GetEvtName() string

func (*Event) GetTimestamp

func (x *Event) GetTimestamp() int64

func (*Event) ProtoMessage

func (*Event) ProtoMessage()

func (*Event) ProtoReflect

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

func (*Event) Reset

func (x *Event) Reset()

func (*Event) String

func (x *Event) String() string

type EventEnvelope

type EventEnvelope struct {

	// host server id
	ServerId string `protobuf:"bytes,1,opt,name=server_id,json=serverId,proto3" json:"server_id,omitempty"`
	// topic of event registration
	Topic string `protobuf:"bytes,2,opt,name=topic,proto3" json:"topic,omitempty"`
	// event's sender id
	SenderId string `protobuf:"bytes,3,opt,name=sender_id,json=senderId,proto3" json:"sender_id,omitempty"`
	// event registration time
	RegAt string `protobuf:"bytes,5,opt,name=reg_at,json=regAt,proto3" json:"reg_at,omitempty"`
	// event name, details and timestamp
	Event *Event `protobuf:"bytes,6,opt,name=Event,proto3" json:"Event,omitempty"`
	// contains filtered or unexported fields
}

func (*EventEnvelope) Descriptor deprecated

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

Deprecated: Use EventEnvelope.ProtoReflect.Descriptor instead.

func (*EventEnvelope) GetEvent

func (x *EventEnvelope) GetEvent() *Event

func (*EventEnvelope) GetRegAt

func (x *EventEnvelope) GetRegAt() string

func (*EventEnvelope) GetSenderId

func (x *EventEnvelope) GetSenderId() string

func (*EventEnvelope) GetServerId

func (x *EventEnvelope) GetServerId() string

func (*EventEnvelope) GetTopic

func (x *EventEnvelope) GetTopic() string

func (*EventEnvelope) ProtoMessage

func (*EventEnvelope) ProtoMessage()

func (*EventEnvelope) ProtoReflect

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

func (*EventEnvelope) Reset

func (x *EventEnvelope) Reset()

func (*EventEnvelope) String

func (x *EventEnvelope) String() string

type EventRegistration

type EventRegistration struct {

	// host server id
	ServerId string `protobuf:"bytes,1,opt,name=server_id,json=serverId,proto3" json:"server_id,omitempty"`
	// topic to insert the event into.
	Topic string `protobuf:"bytes,2,opt,name=topic,proto3" json:"topic,omitempty"`
	// event's sender id.
	SenderId string `protobuf:"bytes,3,opt,name=sender_id,json=senderId,proto3" json:"sender_id,omitempty"`
	// event's name, details and timestamp.
	Event *Event `protobuf:"bytes,4,opt,name=event,proto3" json:"event,omitempty"`
	// contains filtered or unexported fields
}

func (*EventRegistration) Descriptor deprecated

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

Deprecated: Use EventRegistration.ProtoReflect.Descriptor instead.

func (*EventRegistration) GetEvent

func (x *EventRegistration) GetEvent() *Event

func (*EventRegistration) GetSenderId

func (x *EventRegistration) GetSenderId() string

func (*EventRegistration) GetServerId

func (x *EventRegistration) GetServerId() string

func (*EventRegistration) GetTopic

func (x *EventRegistration) GetTopic() string

func (*EventRegistration) ProtoMessage

func (*EventRegistration) ProtoMessage()

func (*EventRegistration) ProtoReflect

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

func (*EventRegistration) Reset

func (x *EventRegistration) Reset()

func (*EventRegistration) String

func (x *EventRegistration) String() string

type EventServiceClient

type EventServiceClient interface {
	// checks if the topic exists on host server.
	HasTopic(ctx context.Context, in *TopicRequest, opts ...grpc.CallOption) (*OpResponse, error)
	// adds a new topic or a whole topics branch to the host server.
	AddTopics(ctx context.Context, in *AddTopicReq, opts ...grpc.CallOption) (*OpResponse, error)
	// Returns topic or branch from the host server
	DelTopics(ctx context.Context, in *DelTopicReq, opts ...grpc.CallOption) (*OpResponse, error)
	// adds a new event on the host server.
	AddEvent(ctx context.Context, in *EventRegistration, opts ...grpc.CallOption) (*OpResponse, error)
	// creates single or multi- subscription on the host server.
	Subscribe(ctx context.Context, in *SubscriptionRequest, opts ...grpc.CallOption) (EventService_SubscribeClient, error)
	// cancels subsciptions for one or many topics on the host server.
	UnSubscribe(ctx context.Context, in *UnsubsibeRequest, opts ...grpc.CallOption) (*OpResponse, error)
	// stops event streaming service of subscription events.
	// UnSubscribe only stops sending events into the channel, but not
	// stops the streaming service.
	StopSubscriptionStream(ctx context.Context, in *StopStreamRequest, opts ...grpc.CallOption) (*OpResponse, error)
}

EventServiceClient is the client API for EventService 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.

type EventServiceServer

type EventServiceServer interface {
	// checks if the topic exists on host server.
	HasTopic(context.Context, *TopicRequest) (*OpResponse, error)
	// adds a new topic or a whole topics branch to the host server.
	AddTopics(context.Context, *AddTopicReq) (*OpResponse, error)
	// Returns topic or branch from the host server
	DelTopics(context.Context, *DelTopicReq) (*OpResponse, error)
	// adds a new event on the host server.
	AddEvent(context.Context, *EventRegistration) (*OpResponse, error)
	// creates single or multi- subscription on the host server.
	Subscribe(*SubscriptionRequest, EventService_SubscribeServer) error
	// cancels subsciptions for one or many topics on the host server.
	UnSubscribe(context.Context, *UnsubsibeRequest) (*OpResponse, error)
	// stops event streaming service of subscription events.
	// UnSubscribe only stops sending events into the channel, but not
	// stops the streaming service.
	StopSubscriptionStream(context.Context, *StopStreamRequest) (*OpResponse, error)
	// contains filtered or unexported methods
}

EventServiceServer is the server API for EventService service. All implementations must embed UnimplementedEventServiceServer for forward compatibility

type EventService_SubscribeClient

type EventService_SubscribeClient interface {
	Recv() (*EventEnvelope, error)
	grpc.ClientStream
}

type EventService_SubscribeServer

type EventService_SubscribeServer interface {
	Send(*EventEnvelope) error
	grpc.ServerStream
}

type Filter

type Filter struct {
	Value string            `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`
	Type  Filter_FilterType `protobuf:"varint,2,opt,name=type,proto3,enum=es_proto.Filter_FilterType" json:"type,omitempty"`
	// contains filtered or unexported fields
}

func (*Filter) Descriptor deprecated

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

Deprecated: Use Filter.ProtoReflect.Descriptor instead.

func (*Filter) GetType

func (x *Filter) GetType() Filter_FilterType

func (*Filter) GetValue

func (x *Filter) GetValue() string

func (*Filter) ProtoMessage

func (*Filter) ProtoMessage()

func (*Filter) ProtoReflect

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

func (*Filter) Reset

func (x *Filter) Reset()

func (*Filter) String

func (x *Filter) String() string

type Filter_FilterType

type Filter_FilterType int32
const (
	Filter_HAS_NAME Filter_FilterType = 0 // exact event name equality
	Filter_IN_NAME  Filter_FilterType = 1 // event name has a given substring
	Filter_IN_DESCR Filter_FilterType = 2 // event description has a given substring
)

func (Filter_FilterType) Descriptor

func (Filter_FilterType) Enum

func (Filter_FilterType) EnumDescriptor deprecated

func (Filter_FilterType) EnumDescriptor() ([]byte, []int)

Deprecated: Use Filter_FilterType.Descriptor instead.

func (Filter_FilterType) Number

func (Filter_FilterType) String

func (x Filter_FilterType) String() string

func (Filter_FilterType) Type

type OpResponse

type OpResponse struct {

	// if operation is failed, then id.Nil will be returned, if
	// everything is fine, then server_id is returned.
	ServerId string            `protobuf:"bytes,1,opt,name=server_id,json=serverId,proto3" json:"server_id,omitempty"`
	Result   OpResponse_Result `protobuf:"varint,2,opt,name=result,proto3,enum=es_proto.OpResponse_Result" json:"result,omitempty"`
	// contains filtered or unexported fields
}

func (*OpResponse) Descriptor deprecated

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

Deprecated: Use OpResponse.ProtoReflect.Descriptor instead.

func (*OpResponse) GetResult

func (x *OpResponse) GetResult() OpResponse_Result

func (*OpResponse) GetServerId

func (x *OpResponse) GetServerId() string

func (*OpResponse) ProtoMessage

func (*OpResponse) ProtoMessage()

func (*OpResponse) ProtoReflect

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

func (*OpResponse) Reset

func (x *OpResponse) Reset()

func (*OpResponse) String

func (x *OpResponse) String() string

type OpResponse_Result

type OpResponse_Result int32
const (
	OpResponse_FAILED OpResponse_Result = 0
	OpResponse_OK     OpResponse_Result = 1
)

func (OpResponse_Result) Descriptor

func (OpResponse_Result) Enum

func (OpResponse_Result) EnumDescriptor deprecated

func (OpResponse_Result) EnumDescriptor() ([]byte, []int)

Deprecated: Use OpResponse_Result.Descriptor instead.

func (OpResponse_Result) Number

func (OpResponse_Result) String

func (x OpResponse_Result) String() string

func (OpResponse_Result) Type

type StopStreamRequest

type StopStreamRequest struct {

	// host server id
	ServerId string `protobuf:"bytes,1,opt,name=server_id,json=serverId,proto3" json:"server_id,omitempty"`
	// subscriber id
	SubscriberId string `protobuf:"bytes,2,opt,name=subscriber_id,json=subscriberId,proto3" json:"subscriber_id,omitempty"`
	// subscription stream id
	SubsStreamId string `protobuf:"bytes,3,opt,name=subs_stream_id,json=subsStreamId,proto3" json:"subs_stream_id,omitempty"`
	// contains filtered or unexported fields
}

func (*StopStreamRequest) Descriptor deprecated

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

Deprecated: Use StopStreamRequest.ProtoReflect.Descriptor instead.

func (*StopStreamRequest) GetServerId

func (x *StopStreamRequest) GetServerId() string

func (*StopStreamRequest) GetSubsStreamId

func (x *StopStreamRequest) GetSubsStreamId() string

func (*StopStreamRequest) GetSubscriberId

func (x *StopStreamRequest) GetSubscriberId() string

func (*StopStreamRequest) ProtoMessage

func (*StopStreamRequest) ProtoMessage()

func (*StopStreamRequest) ProtoReflect

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

func (*StopStreamRequest) Reset

func (x *StopStreamRequest) Reset()

func (*StopStreamRequest) String

func (x *StopStreamRequest) String() string

type Subscription

type Subscription struct {

	// topic in absolute path format
	Topic string `protobuf:"bytes,1,opt,name=topic,proto3" json:"topic,omitempty"`
	// make recursive subscription
	Recursive bool `protobuf:"varint,2,opt,name=recursive,proto3" json:"recursive,omitempty"`
	// recursion depth
	Depth int32 `protobuf:"varint,3,opt,name=depth,proto3" json:"depth,omitempty"`
	// start number of events in topic
	StartPos int32 `protobuf:"varint,4,opt,name=start_pos,json=startPos,proto3" json:"start_pos,omitempty"`
	// filters for subscription
	Filters []*Filter `protobuf:"bytes,5,rep,name=filters,proto3" json:"filters,omitempty"`
	// contains filtered or unexported fields
}

func (*Subscription) Descriptor deprecated

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

Deprecated: Use Subscription.ProtoReflect.Descriptor instead.

func (*Subscription) GetDepth

func (x *Subscription) GetDepth() int32

func (*Subscription) GetFilters

func (x *Subscription) GetFilters() []*Filter

func (*Subscription) GetRecursive

func (x *Subscription) GetRecursive() bool

func (*Subscription) GetStartPos

func (x *Subscription) GetStartPos() int32

func (*Subscription) GetTopic

func (x *Subscription) GetTopic() string

func (*Subscription) ProtoMessage

func (*Subscription) ProtoMessage()

func (*Subscription) ProtoReflect

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

func (*Subscription) Reset

func (x *Subscription) Reset()

func (*Subscription) String

func (x *Subscription) String() string

type SubscriptionRequest

type SubscriptionRequest struct {

	// host server id
	ServerId string `protobuf:"bytes,1,opt,name=server_id,json=serverId,proto3" json:"server_id,omitempty"`
	// subscriber id
	SubscriberId string `protobuf:"bytes,2,opt,name=subscriber_id,json=subscriberId,proto3" json:"subscriber_id,omitempty"`
	// subscription list
	Subscriptions []*Subscription `protobuf:"bytes,3,rep,name=subscriptions,proto3" json:"subscriptions,omitempty"`
	// ID of the subscription stream.
	// By using this id streaming service could
	// be stopped in StopSubscriptionStream call.
	SubsStreamId string `protobuf:"bytes,4,opt,name=subs_stream_id,json=subsStreamId,proto3" json:"subs_stream_id,omitempty"`
	// contains filtered or unexported fields
}

func (*SubscriptionRequest) Descriptor deprecated

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

Deprecated: Use SubscriptionRequest.ProtoReflect.Descriptor instead.

func (*SubscriptionRequest) GetServerId

func (x *SubscriptionRequest) GetServerId() string

func (*SubscriptionRequest) GetSubsStreamId

func (x *SubscriptionRequest) GetSubsStreamId() string

func (*SubscriptionRequest) GetSubscriberId

func (x *SubscriptionRequest) GetSubscriberId() string

func (*SubscriptionRequest) GetSubscriptions

func (x *SubscriptionRequest) GetSubscriptions() []*Subscription

func (*SubscriptionRequest) ProtoMessage

func (*SubscriptionRequest) ProtoMessage()

func (*SubscriptionRequest) ProtoReflect

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

func (*SubscriptionRequest) Reset

func (x *SubscriptionRequest) Reset()

func (*SubscriptionRequest) String

func (x *SubscriptionRequest) String() string

type TopicRequest

type TopicRequest struct {

	// host server id
	ServerId string `protobuf:"bytes,1,opt,name=server_id,json=serverId,proto3" json:"server_id,omitempty"`
	// should be used absolute topic's path
	// i.e. /main/topic/subtopic
	Topic string `protobuf:"bytes,2,opt,name=topic,proto3" json:"topic,omitempty"`
	// contains filtered or unexported fields
}

func (*TopicRequest) Descriptor deprecated

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

Deprecated: Use TopicRequest.ProtoReflect.Descriptor instead.

func (*TopicRequest) GetServerId

func (x *TopicRequest) GetServerId() string

func (*TopicRequest) GetTopic

func (x *TopicRequest) GetTopic() string

func (*TopicRequest) ProtoMessage

func (*TopicRequest) ProtoMessage()

func (*TopicRequest) ProtoReflect

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

func (*TopicRequest) Reset

func (x *TopicRequest) Reset()

func (*TopicRequest) String

func (x *TopicRequest) String() string

type UnimplementedEventServiceServer

type UnimplementedEventServiceServer struct {
}

UnimplementedEventServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedEventServiceServer) AddEvent

func (UnimplementedEventServiceServer) AddTopics

func (UnimplementedEventServiceServer) DelTopics

func (UnimplementedEventServiceServer) HasTopic

func (UnimplementedEventServiceServer) StopSubscriptionStream

func (UnimplementedEventServiceServer) Subscribe

func (UnimplementedEventServiceServer) UnSubscribe

type UnsafeEventServiceServer

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

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

type UnsubsibeRequest

type UnsubsibeRequest struct {

	// host server id
	ServerId string `protobuf:"bytes,1,opt,name=server_id,json=serverId,proto3" json:"server_id,omitempty"`
	// subscriber id
	SubscriberId string `protobuf:"bytes,2,opt,name=subscriber_id,json=subscriberId,proto3" json:"subscriber_id,omitempty"`
	// topics to unsubscribe from
	Topics []string `protobuf:"bytes,3,rep,name=topics,proto3" json:"topics,omitempty"`
	// contains filtered or unexported fields
}

func (*UnsubsibeRequest) Descriptor deprecated

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

Deprecated: Use UnsubsibeRequest.ProtoReflect.Descriptor instead.

func (*UnsubsibeRequest) GetServerId

func (x *UnsubsibeRequest) GetServerId() string

func (*UnsubsibeRequest) GetSubscriberId

func (x *UnsubsibeRequest) GetSubscriberId() string

func (*UnsubsibeRequest) GetTopics

func (x *UnsubsibeRequest) GetTopics() []string

func (*UnsubsibeRequest) ProtoMessage

func (*UnsubsibeRequest) ProtoMessage()

func (*UnsubsibeRequest) ProtoReflect

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

func (*UnsubsibeRequest) Reset

func (x *UnsubsibeRequest) Reset()

func (*UnsubsibeRequest) String

func (x *UnsubsibeRequest) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL