client

package

v0.0.0-...-fc15ddb Latest Latest Go to latest Published: Sep 27, 2017 License: MPL-2.0 Imports: 4 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

Repository

github.com/iamduo/workq

Links

Open Source Insights

Documentation ¶

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	KeepAlivePeriod = 300
)

Functions ¶

This section is empty.

Types ¶

type Client ¶

type Client struct {
	// contains filtered or unexported fields
}

Client represents a single unique connection with convenience methods to return a Limited bufio.Reader, Writer, and Closer. Limited Reader provides a circuit breaker for out of bound requests.

func New ¶

func New(conn Conn, n int64) *Client

func (*Client) Closer ¶

func (c *Client) Closer() io.Closer

Return Closer

func (*Client) Reader ¶

func (c *Client) Reader() *bufio.Reader

Return Limited Bufio Reader Callers should invoke ResetLimit to reset read limits to original value.

func (*Client) ResetLimit ¶

func (c *Client) ResetLimit()

Reset the read limit back to original value. It is expected to be reset for every new cmd or read "session".

func (*Client) Writer ¶

func (c *Client) Writer() io.Writer

Return Writer

type Conn ¶

type Conn interface {
	io.Reader
	io.Writer
	io.Closer
	SetKeepAlive(keepalive bool) error
	SetKeepAlivePeriod(d time.Duration) error
}

Conn interface to clarify actual behavior required and for easier integration testing.

Source Files ¶

View all Source files

client.go

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