out

Documentation

Index

• type Socket
  • func NewSocket(path string) (s *Socket, err error)
  • func (s *Socket) Close() error
  • func (s *Socket) Write(frame []byte) (int, error)
• type TCP
  • func NewTCP(address string) *TCP
  • func (s *TCP) Close() error
  • func (s *TCP) Flush() error
  • func (s *TCP) Write(frame []byte) (n int, err error)

Types

type Socket

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

Socket is a Frame Streams encoder over a UNIX socket.

func NewSocket

func NewSocket(path string) (s *Socket, err error)

NewSocket will always return a new Socket. err if nothing is listening to it, it will attempt to reconnect on the next Write.

func (*Socket) Close

func (s *Socket) Close() error

Close the socket and flush the remaining frames.

func (*Socket) Write

func (s *Socket) Write(frame []byte) (int, error)

Write a single Frame Streams frame.

type TCP

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

TCP is a Frame Streams encoder over TCP.

func NewTCP

func NewTCP(address string) *TCP

NewTCP returns a TCP writer.

func (*TCP) Close

func (s *TCP) Close() error

Close is an alias to Flush to satisfy io.WriteCloser similarly to type Socket.

func (*TCP) Flush

func (s *TCP) Flush() error

Flush the remaining frames.

func (*TCP) Write

func (s *TCP) Write(frame []byte) (n int, err error)

Write a single Frame Streams frame.