ts

package module
v0.0.0-...-1ea69c5 Latest Latest
Warning

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

Go to latest
Published: Nov 30, 2016 License: Apache-2.0 Imports: 11 Imported by: 2

README

gotimberslide

gotimberslide is a golang client for Timberslide. This package is under Development and may change at any time.

Build

make

Documentation

Overview

Package ts is a generated protocol buffer package.

It is generated from these files:

timberslide.proto

It has these top-level messages:

Event
EventReply
Topic
Register
RegisterReply
TopicsReq
TopicsReply
TopicMetadata
UpdateReply

Index

Constants

View Source
const (
	// PositionNewest will start reading a topic at the newest message
	PositionNewest int64 = -1
	// PositionOldest will start reading a topic from the oldest message
	PositionOldest int64 = -2
)

Variables

This section is empty.

Functions

func RegisterIngestServer

func RegisterIngestServer(s *grpc.Server, srv IngestServer)

func RegisterStreamerServer

func RegisterStreamerServer(s *grpc.Server, srv StreamerServer)

func RegisterTopicsServer

func RegisterTopicsServer(s *grpc.Server, srv TopicsServer)

Types

type Channel

type Channel struct {
	Topic string
	// contains filtered or unexported fields
}

Channel is used to send messages over

func (*Channel) Close

func (c *Channel) Close() error

Close closes out the channel with the server

func (*Channel) Send

func (c *Channel) Send(message string) error

Send sends a message for the channel's topic

type Client

type Client struct {
	Host  string
	Token string
	// contains filtered or unexported fields
}

Client contains configuration for talking to Timberslide

func NewClient

func NewClient(host string, token string) (Client, error)

NewClient creates a new client

func NewClientFromFile

func NewClientFromFile(file string) (Client, error)

NewClientFromFile creates a client from the config file

func (*Client) Close

func (c *Client) Close() error

Close closes the client's connection to Timberslide

func (*Client) Connect

func (c *Client) Connect() error

Connect connects to Timberslide

func (*Client) CreateChannel

func (c *Client) CreateChannel(topic string) (Channel, error)

CreateChannel returns a channel on which the client can send events

func (*Client) GetTopics

func (c *Client) GetTopics() ([]*Topic, error)

GetTopics returns a list of all topics visible to this user

func (*Client) Iter

func (c *Client) Iter(topic string, position int64) <-chan Event

Iter providers an iterator to range over event in a topic

type Event

type Event struct {
	Topic   string `protobuf:"bytes,1,opt,name=Topic" json:"Topic,omitempty"`
	Message string `protobuf:"bytes,2,opt,name=Message" json:"Message,omitempty"`
	Done    bool   `protobuf:"varint,3,opt,name=Done" json:"Done,omitempty"`
}

func (*Event) Descriptor

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

func (*Event) ProtoMessage

func (*Event) ProtoMessage()

func (*Event) Reset

func (m *Event) Reset()

func (*Event) String

func (m *Event) String() string

type EventReply

type EventReply struct {
}

func (*EventReply) Descriptor

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

func (*EventReply) ProtoMessage

func (*EventReply) ProtoMessage()

func (*EventReply) Reset

func (m *EventReply) Reset()

func (*EventReply) String

func (m *EventReply) String() string

type IngestClient

type IngestClient interface {
	StreamEvents(ctx context.Context, opts ...grpc.CallOption) (Ingest_StreamEventsClient, error)
}

func NewIngestClient

func NewIngestClient(cc *grpc.ClientConn) IngestClient

type IngestServer

type IngestServer interface {
	StreamEvents(Ingest_StreamEventsServer) error
}

type Ingest_StreamEventsClient

type Ingest_StreamEventsClient interface {
	Send(*Event) error
	Recv() (*EventReply, error)
	grpc.ClientStream
}

type Ingest_StreamEventsServer

type Ingest_StreamEventsServer interface {
	Send(*EventReply) error
	Recv() (*Event, error)
	grpc.ServerStream
}

type Register

type Register struct {
	Topic string `protobuf:"bytes,1,opt,name=Topic" json:"Topic,omitempty"`
	User  string `protobuf:"bytes,2,opt,name=User" json:"User,omitempty"`
}

func (*Register) Descriptor

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

func (*Register) ProtoMessage

func (*Register) ProtoMessage()

func (*Register) Reset

func (m *Register) Reset()

func (*Register) String

func (m *Register) String() string

type RegisterReply

type RegisterReply struct {
}

func (*RegisterReply) Descriptor

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

func (*RegisterReply) ProtoMessage

func (*RegisterReply) ProtoMessage()

func (*RegisterReply) Reset

func (m *RegisterReply) Reset()

func (*RegisterReply) String

func (m *RegisterReply) String() string

type StreamerClient

type StreamerClient interface {
	GetStream(ctx context.Context, in *Topic, opts ...grpc.CallOption) (Streamer_GetStreamClient, error)
}

func NewStreamerClient

func NewStreamerClient(cc *grpc.ClientConn) StreamerClient

type StreamerServer

type StreamerServer interface {
	GetStream(*Topic, Streamer_GetStreamServer) error
}

type Streamer_GetStreamClient

type Streamer_GetStreamClient interface {
	Recv() (*Event, error)
	grpc.ClientStream
}

type Streamer_GetStreamServer

type Streamer_GetStreamServer interface {
	Send(*Event) error
	grpc.ServerStream
}

type Topic

type Topic struct {
	ID       int64  `protobuf:"varint,1,opt,name=ID" json:"ID,omitempty"`
	Name     string `protobuf:"bytes,2,opt,name=Name" json:"Name,omitempty"`
	Position int64  `protobuf:"varint,3,opt,name=Position" json:"Position,omitempty"`
	Public   bool   `protobuf:"varint,4,opt,name=Public" json:"Public,omitempty"`
}

func (*Topic) Descriptor

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

func (*Topic) ProtoMessage

func (*Topic) ProtoMessage()

func (*Topic) Reset

func (m *Topic) Reset()

func (*Topic) String

func (m *Topic) String() string

type TopicMetadata

type TopicMetadata struct {
	Name   string `protobuf:"bytes,1,opt,name=Name" json:"Name,omitempty"`
	Public bool   `protobuf:"varint,2,opt,name=public" json:"public,omitempty"`
}

func (*TopicMetadata) Descriptor

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

func (*TopicMetadata) ProtoMessage

func (*TopicMetadata) ProtoMessage()

func (*TopicMetadata) Reset

func (m *TopicMetadata) Reset()

func (*TopicMetadata) String

func (m *TopicMetadata) String() string

type TopicsClient

type TopicsClient interface {
	RegisterTopic(ctx context.Context, in *Register, opts ...grpc.CallOption) (*RegisterReply, error)
	GetTopics(ctx context.Context, in *TopicsReq, opts ...grpc.CallOption) (*TopicsReply, error)
	UpdateTopic(ctx context.Context, in *TopicMetadata, opts ...grpc.CallOption) (*UpdateReply, error)
}

func NewTopicsClient

func NewTopicsClient(cc *grpc.ClientConn) TopicsClient

type TopicsReply

type TopicsReply struct {
	Topics []*Topic `protobuf:"bytes,1,rep,name=topics" json:"topics,omitempty"`
}

func (*TopicsReply) Descriptor

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

func (*TopicsReply) GetTopics

func (m *TopicsReply) GetTopics() []*Topic

func (*TopicsReply) ProtoMessage

func (*TopicsReply) ProtoMessage()

func (*TopicsReply) Reset

func (m *TopicsReply) Reset()

func (*TopicsReply) String

func (m *TopicsReply) String() string

type TopicsReq

type TopicsReq struct {
	Username string `protobuf:"bytes,1,opt,name=Username" json:"Username,omitempty"`
}

func (*TopicsReq) Descriptor

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

func (*TopicsReq) ProtoMessage

func (*TopicsReq) ProtoMessage()

func (*TopicsReq) Reset

func (m *TopicsReq) Reset()

func (*TopicsReq) String

func (m *TopicsReq) String() string

type TopicsServer

type TopicsServer interface {
	RegisterTopic(context.Context, *Register) (*RegisterReply, error)
	GetTopics(context.Context, *TopicsReq) (*TopicsReply, error)
	UpdateTopic(context.Context, *TopicMetadata) (*UpdateReply, error)
}

type UpdateReply

type UpdateReply struct {
}

func (*UpdateReply) Descriptor

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

func (*UpdateReply) ProtoMessage

func (*UpdateReply) ProtoMessage()

func (*UpdateReply) Reset

func (m *UpdateReply) Reset()

func (*UpdateReply) String

func (m *UpdateReply) String() string

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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