socket

Documentation

Index

• Constants
• Variables
• type Signal
• type Socket
  • func New(socket string) *Socket
  • func (s *Socket) Close() error
  • func (s *Socket) Listen(handler func(event []byte) []byte) error
  • func (s *Socket) Request(event []byte) ([]byte, error)

Constants

const (
	// ControlCharacter defines the end of socket communication.
	ControlCharacter byte = '\a'
	// ControlCharacterString defines the end of socket communication.
	ControlCharacterString = "\a"
)

Variables

var SignalReload = Signal("reload")

SignalReload is the event for reloading all the Baito.

Types

type Signal

type Signal []byte

A Signal is an event sent through a socket.

type Socket

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

A Socket is used to send and receive signals through socket.

func New

func New(socket string) *Socket

New returns a new Socket.

func (*Socket) Close

func (s *Socket) Close() error

Close closes the listener if Listen as been called.

func (*Socket) Listen

func (s *Socket) Listen(handler func(event []byte) []byte) error

Listen opens the socket and wait for incoming events.

func (*Socket) Request

func (s *Socket) Request(event []byte) ([]byte, error)

Request dials the socket with the given event.