ipc

Documentation

Index

• func FromCustomCfg(cfg Custom) (io.ReadWriteCloser, error)
• func Hijackify(conn net.Conn, timeout time.Duration) (net.Conn, error)
• func NewClientIPC(logger logging.Logger, sockConn io.ReadWriteCloser, handler http.Handler, ...) (io.Closer, *http.Client, error)
• func NewHijackAcceptor(logger logging.Logger, cb func(context.Context, io.ReadWriteCloser)) (string, http.Handler)
• func NewServerIPC(logger logging.Logger, sockConn io.ReadWriteCloser, handler http.Handler, ...) (io.Closer, *http.Client, error)
• type CloseWriter
• type Custom
  • func FakeTestCustom(fd int) Custom
• type FdWrapper
  • func NewConnectionPair(cmd *exec.Cmd) (net.Conn, *FdWrapper, error)
  • func (p *FdWrapper) Close() error
  • func (p *FdWrapper) ToCustomCfg() Custom
• type Option
  • func WithShutdownTimeout(d time.Duration) Option
• type PluginConfigFromEngine
  • func NewPluginConfigFromEngineEnv(in string) (*PluginConfigFromEngine, error)
  • func (c *PluginConfigFromEngine) ToString() (string, error)

Functions

func FromCustomCfg

func FromCustomCfg(cfg Custom) (io.ReadWriteCloser, error)

FromCustomCfg is the counter part of ToCustomCfg(). Turns an file descriptor back into a connection object.

func Hijackify

func Hijackify(conn net.Conn, timeout time.Duration) (net.Conn, error)

Hijackify to be used in conjunction with HijackAcceptor. Tells the server to perform hijack operation on the connection which means the server will retrieve the underlying tcp connection and hand it over / no longer serves requests to it. -> we can use it as a long-running server-client connection and re-purpose it to run our IPC/yamux stack on top.

func NewClientIPC

func NewClientIPC(logger logging.Logger, sockConn io.ReadWriteCloser, handler http.Handler, onServerClosed func(error), option ...Option) (io.Closer, *http.Client, error)

func NewHijackAcceptor

func NewHijackAcceptor(logger logging.Logger, cb func(context.Context, io.ReadWriteCloser)) (string, http.Handler)

func NewServerIPC

func NewServerIPC(logger logging.Logger, sockConn io.ReadWriteCloser, handler http.Handler, onServerClosed func(error), option ...Option) (io.Closer, *http.Client, error)

Types

type CloseWriter

type CloseWriter interface {
	CloseWrite() error
}

type Custom

type Custom struct {
	Fd int `json:"fd"`
}

func FakeTestCustom

func FakeTestCustom(fd int) Custom

type FdWrapper

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

func NewConnectionPair

func NewConnectionPair(cmd *exec.Cmd) (net.Conn, *FdWrapper, error)

func (*FdWrapper) Close

func (p *FdWrapper) Close() error

func (*FdWrapper) ToCustomCfg

func (p *FdWrapper) ToCustomCfg() Custom

type Option

type Option func(*cfg) *cfg

func WithShutdownTimeout

func WithShutdownTimeout(d time.Duration) Option

type PluginConfigFromEngine

type PluginConfigFromEngine struct {
	Name                string        `json:"name"`
	RegistrationTimeout time.Duration `json:"timeout"`
	Custom
}

func NewPluginConfigFromEngineEnv

func NewPluginConfigFromEngineEnv(in string) (*PluginConfigFromEngine, error)

func (*PluginConfigFromEngine) ToString

func (c *PluginConfigFromEngine) ToString() (string, error)