prism

Documentation

Overview

Package prism downloads, unzips, boots up a prism binary to run a pipeline against.

Index

• type Handle
  • func Start(ctx context.Context, opts Options) (*Handle, error)
  • func (h *Handle) Addr() string
  • func (h *Handle) Terminate()
• type Options

Types

type Handle

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

Handle provides a shared handle into a prism process.

func Start

func Start(ctx context.Context, opts Options) (*Handle, error)

Start downloads and begins a prism process.

Returns a cancellation function to be called once the process is no longer needed.

func (*Handle) Addr

func (h *Handle) Addr() string

Addr returns the determined port and host address for the prism process.

func (*Handle) Terminate

func (h *Handle) Terminate()

Terminate ends the prism process.

type Options

type Options struct {
	Location string // if specified, indicates where a prism binary or zip of the binary can be found.
	Port     string // if specified, provdies the connection port Prism should use. Otherwise uses the default port a random port.
}