ipc

Documentation

Index

• type AercServer
  • func StartServer(handler Handler, startup context.Context) (*AercServer, error)
  • func (as *AercServer) Close()
  • func (as *AercServer) Serve()
• type Handler
• type Request
  • func DecodeMessage(data []byte) (*Request, error)
  • func DecodeRequest(data []byte) (*Request, error)
  • func (msg *Request) Encode() ([]byte, error)
• type Response
  • func ConnectAndExec(args []string) (*Response, error)
  • func DecodeResponse(data []byte) (*Response, error)
  • func (msg *Response) Encode() ([]byte, error)

Types

type AercServer

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

func StartServer

func StartServer(handler Handler, startup context.Context) (*AercServer, error)

func (*AercServer) Close

func (as *AercServer) Close()

func (*AercServer) Serve

func (as *AercServer) Serve()

type Handler

type Handler interface {
	Command(args []string) error
}

type Request

type Request struct {
	// Arguments contains the commandline arguments. The detection of what
	// action to take is left to the receiver.
	Arguments []string `json:"arguments"`
}

Request contains all parameters needed for the main instance to respond to a request.

func DecodeMessage

func DecodeMessage(data []byte) (*Request, error)

DecodeMessage consumes a raw message and returns the message contained within.

func DecodeRequest

func DecodeRequest(data []byte) (*Request, error)

DecodeRequest consumes a raw message and returns the message contained within.

func (*Request) Encode

func (msg *Request) Encode() ([]byte, error)

Encode transforms the message in an easier to transfer format

type Response

type Response struct {
	// Error contains the success-state of the command. Error is an empty
	// string if everything ran successfully.
	Error string `json:"error"`
}

Response is used to report the results of a command.

func ConnectAndExec

func ConnectAndExec(args []string) (*Response, error)

func DecodeResponse

func DecodeResponse(data []byte) (*Response, error)

DecodeResponse consumes a raw message and returns the message contained within.

func (*Response) Encode

func (msg *Response) Encode() ([]byte, error)

Encode transforms the message in an easier to transfer format