ipc

Documentation

Index

• Constants
• Variables
• type Command
• type Error
  • func (err Error) Error() string
  • func (err Error) Is(other error) bool
• type HandlerFunc
• type Message
• type OutgoingMessage
• type Processor
  • func NewCustomProcessor(output io.Writer, input io.Reader, logger log.Logger, printPayloadContent bool) *Processor
  • func NewStdioProcessor(logger log.Logger, printPayloadContent bool) *Processor
  • func (ipc *Processor) Loop()
  • func (ipc *Processor) Request(ctx context.Context, cmd Command, reqData interface{}, respData interface{}) error
  • func (ipc *Processor) RequestAsync(cmd Command, data interface{}) (<-chan *Message, int, error)
  • func (ipc *Processor) Send(cmd Command, data interface{}) error
  • func (ipc *Processor) SetHandler(command Command, handler HandlerFunc)

Constants

const (
	CommandResponse = "response"
	CommandError    = "error"
)

Variables

var (
	ErrIPCTimeout        = errors.New("ipc request timeout")
	ErrUnknownCommand    = Error{"unknown-command", "Unknown command"}
	ErrSizeLimitExceeded = Error{Code: "size_limit_exceeded"}
	ErrTimeoutError      = Error{Code: "timeout"}
	ErrUnsupportedError  = Error{Code: "unsupported"}
	ErrNotFound          = Error{Code: "not_found"}
)

Types

type Command

type Command string

type Error

type Error struct {
	Code    string `json:"code"`
	Message string `json:"message"`
}

func (Error) Error

func (err Error) Error() string

func (Error) Is

func (err Error) Is(other error) bool

type HandlerFunc

type HandlerFunc func(message json.RawMessage) interface{}

type Message

type Message struct {
	Command Command         `json:"command"`
	ID      int             `json:"id"`
	Data    json.RawMessage `json:"data"`
}

type OutgoingMessage

type OutgoingMessage struct {
	Command Command     `json:"command"`
	ID      int         `json:"id,omitempty"`
	Data    interface{} `json:"data,omitempty"`
}

type Processor

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

func NewCustomProcessor

func NewCustomProcessor(output io.Writer, input io.Reader, logger log.Logger, printPayloadContent bool) *Processor

func NewStdioProcessor

func NewStdioProcessor(logger log.Logger, printPayloadContent bool) *Processor

func (*Processor) Loop

func (ipc *Processor) Loop()

func (*Processor) Request

func (ipc *Processor) Request(ctx context.Context, cmd Command, reqData interface{}, respData interface{}) error

func (*Processor) RequestAsync

func (ipc *Processor) RequestAsync(cmd Command, data interface{}) (<-chan *Message, int, error)

func (*Processor) Send

func (ipc *Processor) Send(cmd Command, data interface{}) error

func (*Processor) SetHandler

func (ipc *Processor) SetHandler(command Command, handler HandlerFunc)