socket

Documentation

Index

• Constants
• Variables
• type Client
  • func Dial(addr string) (*Client, error)
  • func (c *Client) Close() error
  • func (c *Client) Recv() ([]byte, error)
  • func (c *Client) SetMaxMessageSize(s int64)
• type Socket
  • func NewSocket(addr string, log logging.Logger) *Socket
  • func (s *Socket) Close() error
  • func (s *Socket) Listen() error
  • func (s *Socket) Running() bool
  • func (s *Socket) Send(msg []byte)

Constants

const (
	// DefaultMaxMessageSize is the number of bytes to cap messages at by default
	DefaultMaxMessageSize = 2 * units.MiB
)

Variables

var ErrMessageTooLarge = errors.New("message to large")

ErrMessageTooLarge is returned when reading a message that is larger than our max size

Types

type Client

type Client struct {
	net.Conn
	// contains filtered or unexported fields
}

Client is a read-only connection to a socket

func Dial

func Dial(addr string) (*Client, error)

Dial creates a new *Client connected to the given address over a Unix socket

func (*Client) Close

func (c *Client) Close() error

Close closes the underlying socket connection

func (*Client) Recv

func (c *Client) Recv() ([]byte, error)

Recv waits for a message from the socket. It's guaranteed to either return a complete message or an error

func (*Client) SetMaxMessageSize

func (c *Client) SetMaxMessageSize(s int64)

SetMaxMessageSize sets the maximum size to allow for messages

type Socket

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

Socket manages sending messages over a socket to many subscribed clients

func NewSocket

func NewSocket(addr string, log logging.Logger) *Socket

NewSocket creates a new socket object for the given address. It does not open the socket until Listen is called.

func (*Socket) Close

func (s *Socket) Close() error

Close closes the socket by cutting off new connections, closing all existing ones, and then zero'ing out the connection pool

func (*Socket) Listen

func (s *Socket) Listen() error

Listen starts listening on the socket for new connection

func (*Socket) Running

func (s *Socket) Running() bool

func (*Socket) Send

func (s *Socket) Send(msg []byte)

Send writes the given message to all connection clients