client

Documentation

Index

• Variables
• func ProvideSailClient(addr model.SailURL, roomer SailRoomer, dialer SailDialer) *sailClient
• type FakeSailClient
  • func NewFakeSailClient() *FakeSailClient
  • func (c *FakeSailClient) Connect(ctx context.Context, st store.RStore) error
  • func (c *FakeSailClient) OnChange(ctx context.Context, st store.RStore)
  • func (c *FakeSailClient) SetUp(ctx context.Context)
  • func (c *FakeSailClient) TearDown(ctx context.Context)
• type SailClient
• type SailConn
• type SailDialer
  • func ProvideSailDialer() SailDialer
• type SailRoomConnectedAction
  • func (SailRoomConnectedAction) Action()
• type SailRoomer
  • func ProvideSailRoomer(addr model.SailURL) SailRoomer

Variables

var SailWireSet = wire.NewSet(
	ProvideSailClient,
	wire.Bind(new(SailClient), new(sailClient)),
	ProvideSailRoomer,
	ProvideSailDialer,
)

Functions

func ProvideSailClient

func ProvideSailClient(addr model.SailURL, roomer SailRoomer, dialer SailDialer) *sailClient

Types

type FakeSailClient

type FakeSailClient struct {
	ConnectCalls int
}

func NewFakeSailClient

func NewFakeSailClient() *FakeSailClient

func (*FakeSailClient) Connect

func (c *FakeSailClient) Connect(ctx context.Context, st store.RStore) error

func (*FakeSailClient) OnChange

func (c *FakeSailClient) OnChange(ctx context.Context, st store.RStore)

func (*FakeSailClient) SetUp

func (c *FakeSailClient) SetUp(ctx context.Context)

func (*FakeSailClient) TearDown

func (c *FakeSailClient) TearDown(ctx context.Context)

type SailClient

type SailClient interface {
	store.Subscriber
	store.SubscriberLifecycle

	Connect(ctx context.Context, st store.RStore) error
}

type SailConn

type SailConn interface {
	WriteJSON(v interface{}) error
	NextReader() (int, io.Reader, error)
	Close() error
}

type SailDialer

type SailDialer interface {
	DialContext(ctx context.Context, addr string, headers http.Header) (SailConn, error)
}

Helpers for stubbing out the network connection in sailClient

func ProvideSailDialer

func ProvideSailDialer() SailDialer

type SailRoomConnectedAction

type SailRoomConnectedAction struct {
	ViewURL string // URL to view the Sail room
	Err     error
}

func (SailRoomConnectedAction) Action

func (SailRoomConnectedAction) Action()

type SailRoomer

type SailRoomer interface {
	NewRoom(ctx context.Context, version model.WebVersion) (roomID model.RoomID, secret string, err error)
}

For injecting room creation logic (because the real way involves an HTTP request)

func ProvideSailRoomer

func ProvideSailRoomer(addr model.SailURL) SailRoomer