client

Documentation

Index

• Variables
• type Client
  • func New(conn Conn, n int64) *Client
  • func (c *Client) Closer() io.Closer
  • func (c *Client) Reader() *bufio.Reader
  • func (c *Client) ResetLimit()
  • func (c *Client) Writer() io.Writer
• type Conn

Variables

var (
	KeepAlivePeriod = 300
)

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.