Documentation
¶
Index ¶
- Variables
- func NewStreamEndpoints() []*api.Endpoint
- func RegisterStreamHandler(s server.Server, hdlr StreamHandler, opts ...server.HandlerOption) error
- type Channel
- func (*Channel) Descriptor() ([]byte, []int)deprecated
- func (x *Channel) GetDescription() string
- func (x *Channel) GetLastActive() string
- func (x *Channel) GetName() string
- func (*Channel) ProtoMessage()
- func (x *Channel) ProtoReflect() protoreflect.Message
- func (x *Channel) Reset()
- func (x *Channel) String() string
- type CreateChannelRequest
- func (*CreateChannelRequest) Descriptor() ([]byte, []int)deprecated
- func (x *CreateChannelRequest) GetDescription() string
- func (x *CreateChannelRequest) GetName() string
- func (*CreateChannelRequest) ProtoMessage()
- func (x *CreateChannelRequest) ProtoReflect() protoreflect.Message
- func (x *CreateChannelRequest) Reset()
- func (x *CreateChannelRequest) String() string
- type CreateChannelResponse
- type ListChannelsRequest
- type ListChannelsResponse
- func (*ListChannelsResponse) Descriptor() ([]byte, []int)deprecated
- func (x *ListChannelsResponse) GetChannels() []*Channel
- func (*ListChannelsResponse) ProtoMessage()
- func (x *ListChannelsResponse) ProtoReflect() protoreflect.Message
- func (x *ListChannelsResponse) Reset()
- func (x *ListChannelsResponse) String() string
- type ListMessagesRequest
- func (*ListMessagesRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ListMessagesRequest) GetChannel() string
- func (x *ListMessagesRequest) GetLimit() int32
- func (*ListMessagesRequest) ProtoMessage()
- func (x *ListMessagesRequest) ProtoReflect() protoreflect.Message
- func (x *ListMessagesRequest) Reset()
- func (x *ListMessagesRequest) String() string
- type ListMessagesResponse
- func (*ListMessagesResponse) Descriptor() ([]byte, []int)deprecated
- func (x *ListMessagesResponse) GetChannel() string
- func (x *ListMessagesResponse) GetMessages() []*Message
- func (*ListMessagesResponse) ProtoMessage()
- func (x *ListMessagesResponse) ProtoReflect() protoreflect.Message
- func (x *ListMessagesResponse) Reset()
- func (x *ListMessagesResponse) String() string
- type Message
- func (*Message) Descriptor() ([]byte, []int)deprecated
- func (x *Message) GetChannel() string
- func (x *Message) GetId() string
- func (x *Message) GetMetadata() map[string]string
- func (x *Message) GetText() string
- func (x *Message) GetTimestamp() string
- func (*Message) ProtoMessage()
- func (x *Message) ProtoReflect() protoreflect.Message
- func (x *Message) Reset()
- func (x *Message) String() string
- type SendMessageRequest
- func (*SendMessageRequest) Descriptor() ([]byte, []int)deprecated
- func (x *SendMessageRequest) GetChannel() string
- func (x *SendMessageRequest) GetText() string
- func (*SendMessageRequest) ProtoMessage()
- func (x *SendMessageRequest) ProtoReflect() protoreflect.Message
- func (x *SendMessageRequest) Reset()
- func (x *SendMessageRequest) String() string
- type SendMessageResponse
- type StreamHandler
- type StreamService
Constants ¶
This section is empty.
Variables ¶
var File_proto_stream_proto protoreflect.FileDescriptor
Functions ¶
func NewStreamEndpoints ¶
func RegisterStreamHandler ¶
func RegisterStreamHandler(s server.Server, hdlr StreamHandler, opts ...server.HandlerOption) error
Types ¶
type Channel ¶ added in v0.22.0
type Channel struct {
// name of the channel
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// description for the channel
Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
// last activity time
LastActive string `protobuf:"bytes,3,opt,name=last_active,json=lastActive,proto3" json:"last_active,omitempty"`
// contains filtered or unexported fields
}
func (*Channel) Descriptor
deprecated
added in
v0.22.0
func (*Channel) GetDescription ¶ added in v0.22.0
func (*Channel) GetLastActive ¶ added in v0.22.0
func (*Channel) ProtoMessage ¶ added in v0.22.0
func (*Channel) ProtoMessage()
func (*Channel) ProtoReflect ¶ added in v0.22.0
func (x *Channel) ProtoReflect() protoreflect.Message
type CreateChannelRequest ¶ added in v0.22.0
type CreateChannelRequest struct {
// name of the channel
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// description for the channel
Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
// contains filtered or unexported fields
}
Create a channel with a given name and description. Channels are created automatically but this allows you to specify a description that's persisted for the lifetime of the channel.
func (*CreateChannelRequest) Descriptor
deprecated
added in
v0.22.0
func (*CreateChannelRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateChannelRequest.ProtoReflect.Descriptor instead.
func (*CreateChannelRequest) GetDescription ¶ added in v0.22.0
func (x *CreateChannelRequest) GetDescription() string
func (*CreateChannelRequest) GetName ¶ added in v0.22.0
func (x *CreateChannelRequest) GetName() string
func (*CreateChannelRequest) ProtoMessage ¶ added in v0.22.0
func (*CreateChannelRequest) ProtoMessage()
func (*CreateChannelRequest) ProtoReflect ¶ added in v0.22.0
func (x *CreateChannelRequest) ProtoReflect() protoreflect.Message
func (*CreateChannelRequest) Reset ¶ added in v0.22.0
func (x *CreateChannelRequest) Reset()
func (*CreateChannelRequest) String ¶ added in v0.22.0
func (x *CreateChannelRequest) String() string
type CreateChannelResponse ¶ added in v0.22.0
type CreateChannelResponse struct {
// contains filtered or unexported fields
}
func (*CreateChannelResponse) Descriptor
deprecated
added in
v0.22.0
func (*CreateChannelResponse) Descriptor() ([]byte, []int)
Deprecated: Use CreateChannelResponse.ProtoReflect.Descriptor instead.
func (*CreateChannelResponse) ProtoMessage ¶ added in v0.22.0
func (*CreateChannelResponse) ProtoMessage()
func (*CreateChannelResponse) ProtoReflect ¶ added in v0.22.0
func (x *CreateChannelResponse) ProtoReflect() protoreflect.Message
func (*CreateChannelResponse) Reset ¶ added in v0.22.0
func (x *CreateChannelResponse) Reset()
func (*CreateChannelResponse) String ¶ added in v0.22.0
func (x *CreateChannelResponse) String() string
type ListChannelsRequest ¶ added in v0.22.0
type ListChannelsRequest struct {
// contains filtered or unexported fields
}
List all the active channels
func (*ListChannelsRequest) Descriptor
deprecated
added in
v0.22.0
func (*ListChannelsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListChannelsRequest.ProtoReflect.Descriptor instead.
func (*ListChannelsRequest) ProtoMessage ¶ added in v0.22.0
func (*ListChannelsRequest) ProtoMessage()
func (*ListChannelsRequest) ProtoReflect ¶ added in v0.22.0
func (x *ListChannelsRequest) ProtoReflect() protoreflect.Message
func (*ListChannelsRequest) Reset ¶ added in v0.22.0
func (x *ListChannelsRequest) Reset()
func (*ListChannelsRequest) String ¶ added in v0.22.0
func (x *ListChannelsRequest) String() string
type ListChannelsResponse ¶ added in v0.22.0
type ListChannelsResponse struct {
Channels []*Channel `protobuf:"bytes,1,rep,name=channels,proto3" json:"channels,omitempty"`
// contains filtered or unexported fields
}
func (*ListChannelsResponse) Descriptor
deprecated
added in
v0.22.0
func (*ListChannelsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListChannelsResponse.ProtoReflect.Descriptor instead.
func (*ListChannelsResponse) GetChannels ¶ added in v0.22.0
func (x *ListChannelsResponse) GetChannels() []*Channel
func (*ListChannelsResponse) ProtoMessage ¶ added in v0.22.0
func (*ListChannelsResponse) ProtoMessage()
func (*ListChannelsResponse) ProtoReflect ¶ added in v0.22.0
func (x *ListChannelsResponse) ProtoReflect() protoreflect.Message
func (*ListChannelsResponse) Reset ¶ added in v0.22.0
func (x *ListChannelsResponse) Reset()
func (*ListChannelsResponse) String ¶ added in v0.22.0
func (x *ListChannelsResponse) String() string
type ListMessagesRequest ¶ added in v0.22.0
type ListMessagesRequest struct {
// The channel to subscribe to
Channel string `protobuf:"bytes,1,opt,name=channel,proto3" json:"channel,omitempty"`
// number of message to return
Limit int32 `protobuf:"varint,2,opt,name=limit,proto3" json:"limit,omitempty"`
// contains filtered or unexported fields
}
List messages for a given channel
func (*ListMessagesRequest) Descriptor
deprecated
added in
v0.22.0
func (*ListMessagesRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListMessagesRequest.ProtoReflect.Descriptor instead.
func (*ListMessagesRequest) GetChannel ¶ added in v0.22.0
func (x *ListMessagesRequest) GetChannel() string
func (*ListMessagesRequest) GetLimit ¶ added in v0.22.0
func (x *ListMessagesRequest) GetLimit() int32
func (*ListMessagesRequest) ProtoMessage ¶ added in v0.22.0
func (*ListMessagesRequest) ProtoMessage()
func (*ListMessagesRequest) ProtoReflect ¶ added in v0.22.0
func (x *ListMessagesRequest) ProtoReflect() protoreflect.Message
func (*ListMessagesRequest) Reset ¶ added in v0.22.0
func (x *ListMessagesRequest) Reset()
func (*ListMessagesRequest) String ¶ added in v0.22.0
func (x *ListMessagesRequest) String() string
type ListMessagesResponse ¶ added in v0.22.0
type ListMessagesResponse struct {
// The channel subscribed to
Channel string `protobuf:"bytes,1,opt,name=channel,proto3" json:"channel,omitempty"`
// Messages are chronological order
Messages []*Message `protobuf:"bytes,2,rep,name=messages,proto3" json:"messages,omitempty"`
// contains filtered or unexported fields
}
func (*ListMessagesResponse) Descriptor
deprecated
added in
v0.22.0
func (*ListMessagesResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListMessagesResponse.ProtoReflect.Descriptor instead.
func (*ListMessagesResponse) GetChannel ¶ added in v0.22.0
func (x *ListMessagesResponse) GetChannel() string
func (*ListMessagesResponse) GetMessages ¶ added in v0.22.0
func (x *ListMessagesResponse) GetMessages() []*Message
func (*ListMessagesResponse) ProtoMessage ¶ added in v0.22.0
func (*ListMessagesResponse) ProtoMessage()
func (*ListMessagesResponse) ProtoReflect ¶ added in v0.22.0
func (x *ListMessagesResponse) ProtoReflect() protoreflect.Message
func (*ListMessagesResponse) Reset ¶ added in v0.22.0
func (x *ListMessagesResponse) Reset()
func (*ListMessagesResponse) String ¶ added in v0.22.0
func (x *ListMessagesResponse) String() string
type Message ¶ added in v0.22.0
type Message struct {
// id of the message
Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
// text of the message
Text string `protobuf:"bytes,2,opt,name=text,proto3" json:"text,omitempty"`
// time of message creation
Timestamp string `protobuf:"bytes,3,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
// the channel name
Channel string `protobuf:"bytes,4,opt,name=channel,proto3" json:"channel,omitempty"`
// the associated metadata
Metadata map[string]string `` /* 157-byte string literal not displayed */
// contains filtered or unexported fields
}
func (*Message) Descriptor
deprecated
added in
v0.22.0
func (*Message) GetChannel ¶ added in v0.22.0
func (*Message) GetMetadata ¶ added in v0.22.0
func (*Message) GetTimestamp ¶ added in v0.22.0
func (*Message) ProtoMessage ¶ added in v0.22.0
func (*Message) ProtoMessage()
func (*Message) ProtoReflect ¶ added in v0.22.0
func (x *Message) ProtoReflect() protoreflect.Message
type SendMessageRequest ¶ added in v0.22.0
type SendMessageRequest struct {
// The channel to send to
Channel string `protobuf:"bytes,1,opt,name=channel,proto3" json:"channel,omitempty"`
// The message text to send
Text string `protobuf:"bytes,2,opt,name=text,proto3" json:"text,omitempty"`
// contains filtered or unexported fields
}
Send a message to the stream.
func (*SendMessageRequest) Descriptor
deprecated
added in
v0.22.0
func (*SendMessageRequest) Descriptor() ([]byte, []int)
Deprecated: Use SendMessageRequest.ProtoReflect.Descriptor instead.
func (*SendMessageRequest) GetChannel ¶ added in v0.22.0
func (x *SendMessageRequest) GetChannel() string
func (*SendMessageRequest) GetText ¶ added in v0.22.0
func (x *SendMessageRequest) GetText() string
func (*SendMessageRequest) ProtoMessage ¶ added in v0.22.0
func (*SendMessageRequest) ProtoMessage()
func (*SendMessageRequest) ProtoReflect ¶ added in v0.22.0
func (x *SendMessageRequest) ProtoReflect() protoreflect.Message
func (*SendMessageRequest) Reset ¶ added in v0.22.0
func (x *SendMessageRequest) Reset()
func (*SendMessageRequest) String ¶ added in v0.22.0
func (x *SendMessageRequest) String() string
type SendMessageResponse ¶ added in v0.22.0
type SendMessageResponse struct {
// contains filtered or unexported fields
}
func (*SendMessageResponse) Descriptor
deprecated
added in
v0.22.0
func (*SendMessageResponse) Descriptor() ([]byte, []int)
Deprecated: Use SendMessageResponse.ProtoReflect.Descriptor instead.
func (*SendMessageResponse) ProtoMessage ¶ added in v0.22.0
func (*SendMessageResponse) ProtoMessage()
func (*SendMessageResponse) ProtoReflect ¶ added in v0.22.0
func (x *SendMessageResponse) ProtoReflect() protoreflect.Message
func (*SendMessageResponse) Reset ¶ added in v0.22.0
func (x *SendMessageResponse) Reset()
func (*SendMessageResponse) String ¶ added in v0.22.0
func (x *SendMessageResponse) String() string
type StreamHandler ¶
type StreamHandler interface {
CreateChannel(context.Context, *CreateChannelRequest, *CreateChannelResponse) error
SendMessage(context.Context, *SendMessageRequest, *SendMessageResponse) error
ListMessages(context.Context, *ListMessagesRequest, *ListMessagesResponse) error
ListChannels(context.Context, *ListChannelsRequest, *ListChannelsResponse) error
}
type StreamService ¶
type StreamService interface {
CreateChannel(ctx context.Context, in *CreateChannelRequest, opts ...client.CallOption) (*CreateChannelResponse, error)
SendMessage(ctx context.Context, in *SendMessageRequest, opts ...client.CallOption) (*SendMessageResponse, error)
ListMessages(ctx context.Context, in *ListMessagesRequest, opts ...client.CallOption) (*ListMessagesResponse, error)
ListChannels(ctx context.Context, in *ListChannelsRequest, opts ...client.CallOption) (*ListChannelsResponse, error)
}
func NewStreamService ¶
func NewStreamService(name string, c client.Client) StreamService