axon

README

Axon.

Documentation

Index

• Variables
• type Close
• type Event
• type EventHandler
  • func (f EventHandler) Run()
• type EventStore
• type KVStore
• type ReplyHandler
• type Send
• type Stream
• type StreamHandler
• type StreamReceiver
• type Streamer
• type SubscriptionHandler

Variables

var (
	ErrEmptyStoreName          = errors.New("Sorry, you must provide a valid store name")
	ErrInvalidURL              = errors.New("Sorry, you must provide a valid store URL")
	ErrInvalidTlsConfiguration = errors.New("Sorry, you have provided an invalid tls configuration")
	ErrCloseConn               = errors.New("connection closed")
)

Types

type Close

type Close func()

type Event

type Event interface {
	Ack()
	NAck()
	Message() *messages.Message
	Data() []byte
	Topic() string
}

type EventHandler

type EventHandler func() error

func (EventHandler) Run

func (f EventHandler) Run()

type EventStore

type EventStore interface {
	Publish(topic string, data []byte, opts ...options.PublisherOption) error
	Subscribe(topic string, handler SubscriptionHandler, opts ...options.SubscriptionOption) error
	Request(topic string, params []byte, opts ...options.PublisherOption) (*messages.Message, error)
	Reply(topic string, handler ReplyHandler, opts ...options.SubscriptionOption) error
	GetServiceName() string
	Run(ctx context.Context, handlers ...EventHandler)
	NewKVStore(opts ...options.KVOption) (KVStore, error)
	NewStreamer(opts ...options.StreamerOption) (Streamer, error)
	Close()
}

type KVStore

type KVStore interface {
	Get(key string) ([]byte, error)
	Set(key string, value []byte) error
	Del(key string) error
	Purge() error
	Watch(ctx context.Context, key string) (stream <-chan []byte, err error)
	Keys() []string
}

type ReplyHandler

type ReplyHandler func(mg *messages.Message) (*messages.Message, error)

type Send

type Send func(b []byte) error

type Stream

type Stream interface {
	ID() string
	Send(b []byte) error
	Recv() (<-chan []byte, error)
	Close()
	String() string
}

type StreamHandler

type StreamHandler func(Send, Close)

type StreamReceiver

type StreamReceiver interface {
	Recv(ctx context.Context) (<-chan []byte, error)
	Close()
}

type Streamer

type Streamer interface {
	Run()
	NewStream(handler StreamHandler) Stream
	JoinStream(id string) (Stream, error)
	Close()
}

type SubscriptionHandler

type SubscriptionHandler func(event Event)