client

package

v0.10.6 Latest Latest Go to latest Published: Aug 29, 2019 License: Apache-2.0 Imports: 14 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

View Source

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

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

type FakeSailClient struct {
	ConnectCalls int
}

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 interface {
	store.Subscriber
	store.SubscriberLifecycle

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

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

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() SailDialer

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

func (SailRoomConnectedAction) Action()

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(addr model.SailURL) SailRoomer