stream

package
v1.7.0 Latest Latest
Warning

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

Go to latest
Published: Aug 31, 2023 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var File_proto_stream_proto protoreflect.FileDescriptor

Functions

func NewStreamEndpoints

func NewStreamEndpoints() []*api.Endpoint

func RegisterStreamHandler

func RegisterStreamHandler(s server.Server, hdlr StreamHandler, opts ...server.HandlerOption) error

Types

type Channel

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

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

Deprecated: Use Channel.ProtoReflect.Descriptor instead.

func (*Channel) GetDescription

func (x *Channel) GetDescription() string

func (*Channel) GetLastActive

func (x *Channel) GetLastActive() string

func (*Channel) GetName

func (x *Channel) GetName() string

func (*Channel) ProtoMessage

func (*Channel) ProtoMessage()

func (*Channel) ProtoReflect

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

func (*Channel) Reset

func (x *Channel) Reset()

func (*Channel) String

func (x *Channel) String() string

type CreateChannelRequest

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

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

Deprecated: Use CreateChannelRequest.ProtoReflect.Descriptor instead.

func (*CreateChannelRequest) GetDescription

func (x *CreateChannelRequest) GetDescription() string

func (*CreateChannelRequest) GetName

func (x *CreateChannelRequest) GetName() string

func (*CreateChannelRequest) ProtoMessage

func (*CreateChannelRequest) ProtoMessage()

func (*CreateChannelRequest) ProtoReflect

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

func (*CreateChannelRequest) Reset

func (x *CreateChannelRequest) Reset()

func (*CreateChannelRequest) String

func (x *CreateChannelRequest) String() string

type CreateChannelResponse

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

func (*CreateChannelResponse) Descriptor deprecated

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

Deprecated: Use CreateChannelResponse.ProtoReflect.Descriptor instead.

func (*CreateChannelResponse) ProtoMessage

func (*CreateChannelResponse) ProtoMessage()

func (*CreateChannelResponse) ProtoReflect

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

func (*CreateChannelResponse) Reset

func (x *CreateChannelResponse) Reset()

func (*CreateChannelResponse) String

func (x *CreateChannelResponse) String() string

type ListChannelsRequest

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

List all the active channels

func (*ListChannelsRequest) Descriptor deprecated

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

Deprecated: Use ListChannelsRequest.ProtoReflect.Descriptor instead.

func (*ListChannelsRequest) ProtoMessage

func (*ListChannelsRequest) ProtoMessage()

func (*ListChannelsRequest) ProtoReflect

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

func (*ListChannelsRequest) Reset

func (x *ListChannelsRequest) Reset()

func (*ListChannelsRequest) String

func (x *ListChannelsRequest) String() string

type ListChannelsResponse

type ListChannelsResponse struct {
	Channels []*Channel `protobuf:"bytes,1,rep,name=channels,proto3" json:"channels,omitempty"`
	// contains filtered or unexported fields
}

func (*ListChannelsResponse) Descriptor deprecated

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

Deprecated: Use ListChannelsResponse.ProtoReflect.Descriptor instead.

func (*ListChannelsResponse) GetChannels

func (x *ListChannelsResponse) GetChannels() []*Channel

func (*ListChannelsResponse) ProtoMessage

func (*ListChannelsResponse) ProtoMessage()

func (*ListChannelsResponse) ProtoReflect

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

func (*ListChannelsResponse) Reset

func (x *ListChannelsResponse) Reset()

func (*ListChannelsResponse) String

func (x *ListChannelsResponse) String() string

type ListMessagesRequest

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

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

Deprecated: Use ListMessagesRequest.ProtoReflect.Descriptor instead.

func (*ListMessagesRequest) GetChannel

func (x *ListMessagesRequest) GetChannel() string

func (*ListMessagesRequest) GetLimit

func (x *ListMessagesRequest) GetLimit() int32

func (*ListMessagesRequest) ProtoMessage

func (*ListMessagesRequest) ProtoMessage()

func (*ListMessagesRequest) ProtoReflect

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

func (*ListMessagesRequest) Reset

func (x *ListMessagesRequest) Reset()

func (*ListMessagesRequest) String

func (x *ListMessagesRequest) String() string

type ListMessagesResponse

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

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

Deprecated: Use ListMessagesResponse.ProtoReflect.Descriptor instead.

func (*ListMessagesResponse) GetChannel

func (x *ListMessagesResponse) GetChannel() string

func (*ListMessagesResponse) GetMessages

func (x *ListMessagesResponse) GetMessages() []*Message

func (*ListMessagesResponse) ProtoMessage

func (*ListMessagesResponse) ProtoMessage()

func (*ListMessagesResponse) ProtoReflect

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

func (*ListMessagesResponse) Reset

func (x *ListMessagesResponse) Reset()

func (*ListMessagesResponse) String

func (x *ListMessagesResponse) String() string

type Message

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

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

Deprecated: Use Message.ProtoReflect.Descriptor instead.

func (*Message) GetChannel

func (x *Message) GetChannel() string

func (*Message) GetId

func (x *Message) GetId() string

func (*Message) GetMetadata

func (x *Message) GetMetadata() map[string]string

func (*Message) GetText

func (x *Message) GetText() string

func (*Message) GetTimestamp

func (x *Message) GetTimestamp() string

func (*Message) ProtoMessage

func (*Message) ProtoMessage()

func (*Message) ProtoReflect

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

func (*Message) Reset

func (x *Message) Reset()

func (*Message) String

func (x *Message) String() string

type SendMessageRequest

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

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

Deprecated: Use SendMessageRequest.ProtoReflect.Descriptor instead.

func (*SendMessageRequest) GetChannel

func (x *SendMessageRequest) GetChannel() string

func (*SendMessageRequest) GetText

func (x *SendMessageRequest) GetText() string

func (*SendMessageRequest) ProtoMessage

func (*SendMessageRequest) ProtoMessage()

func (*SendMessageRequest) ProtoReflect

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

func (*SendMessageRequest) Reset

func (x *SendMessageRequest) Reset()

func (*SendMessageRequest) String

func (x *SendMessageRequest) String() string

type SendMessageResponse

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

func (*SendMessageResponse) Descriptor deprecated

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

Deprecated: Use SendMessageResponse.ProtoReflect.Descriptor instead.

func (*SendMessageResponse) ProtoMessage

func (*SendMessageResponse) ProtoMessage()

func (*SendMessageResponse) ProtoReflect

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

func (*SendMessageResponse) Reset

func (x *SendMessageResponse) Reset()

func (*SendMessageResponse) String

func (x *SendMessageResponse) String() string

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

Jump to

Keyboard shortcuts

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