messages

Documentation

Index

• Variables
• func New(options Options) (*messageLog, error)
• type Log
• type Options
• type StoredMessage
  • func (*StoredMessage) Descriptor() ([]byte, []int)
  • func (m *StoredMessage) GetPublish() *packet.Publish
  • func (m *StoredMessage) GetSender() string
  • func (*StoredMessage) ProtoMessage()
  • func (m *StoredMessage) Reset()
  • func (m *StoredMessage) String() string
  • func (m *StoredMessage) XXX_DiscardUnknown()
  • func (m *StoredMessage) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
  • func (m *StoredMessage) XXX_Merge(src proto.Message)
  • func (m *StoredMessage) XXX_Size() int
  • func (m *StoredMessage) XXX_Unmarshal(b []byte) error

Variables

var (
	// Encoding is the default binary encoding
	Encoding = binary.BigEndian
	// ErrKeyNotFound is an error indicating a given key does not exist
	ErrKeyNotFound = errors.New("not found")
	// ErrBucketNotFound is an error indicating a given key does not exist
	ErrBucketNotFound = errors.New("bucket not found")
	// ErrIndexOutdated is an error indicating that the supplied index is outdated
	ErrIndexOutdated = errors.New("index outdated")
)

Functions

func New

func New(options Options) (*messageLog, error)

Types

type Log

type Log interface {
	io.Closer
	Append(b []*packet.Publish) error
	Consume(ctx context.Context, from uint64, f func(string, *packet.Publish) error) error
}

type Options

type Options struct {
	// Path is the file path to the BoltDB to use
	Path string

	// BoltOptions contains any specific BoltDB options you might
	// want to specify [e.g. open timeout]
	BoltOptions *bolt.Options

	// NoSync causes the database to skip fsync calls after each
	// write to the log. This is unsafe, so it should be used
	// with caution.
	NoSync bool
}

type StoredMessage

type StoredMessage struct {
	Sender               string          `protobuf:"bytes,1,opt,name=Sender,proto3" json:"Sender,omitempty"`
	Publish              *packet.Publish `protobuf:"bytes,2,opt,name=Publish,proto3" json:"Publish,omitempty"`
	XXX_NoUnkeyedLiteral struct{}        `json:"-"`
	XXX_unrecognized     []byte          `json:"-"`
	XXX_sizecache        int32           `json:"-"`
}

func (*StoredMessage) Descriptor

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

func (*StoredMessage) GetPublish

func (m *StoredMessage) GetPublish() *packet.Publish

func (*StoredMessage) GetSender

func (m *StoredMessage) GetSender() string

func (*StoredMessage) ProtoMessage

func (*StoredMessage) ProtoMessage()

func (*StoredMessage) Reset

func (m *StoredMessage) Reset()

func (*StoredMessage) String

func (m *StoredMessage) String() string

func (*StoredMessage) XXX_DiscardUnknown

func (m *StoredMessage) XXX_DiscardUnknown()

func (*StoredMessage) XXX_Marshal

func (m *StoredMessage) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*StoredMessage) XXX_Merge

func (m *StoredMessage) XXX_Merge(src proto.Message)

func (*StoredMessage) XXX_Size

func (m *StoredMessage) XXX_Size() int

func (*StoredMessage) XXX_Unmarshal

func (m *StoredMessage) XXX_Unmarshal(b []byte) error