Documentation
¶
Overview ¶
Package stream provides a client that can be used on a *uds.Client or *uds.Conn to send streaming binary proto values. This package uses chunk underneath and therefore expects the other side to understand its data format.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides a wrapper around an *uds.Client or *uds.Server that can send and receive JSON messages.
func New ¶
func New(rwc io.ReadWriteCloser, options ...Option) (client *Client, err error)
New is the constructor for Client. rwc must be a *uds.Client or *uds.Conn.
func (*Client) CloseSend ¶ added in v1.2.2
CloseSend closes the send side of the connection. The Context can be used to timeout waiting for the other side to acknowledge the close. This is not thread safe and you cannot call it multiple times.
type Option ¶
type Option func(c *Client)
Option is an optional argument to New.
func MaxSize ¶
MaxSize is the maximum size a read message is allowed to be. If a message is larger than this, Next() will fail and the underlying connection will be closed.
func SharedPool ¶
SharedPool allows the use of a shared pool of buffers between Client instead of a pool per client. This is useful when clients are short lived and have similar message sizes.
Source Files
Directories