protocol

Documentation

Index

• func IsStreamable(p string) (bool, error)
• type ContainerIO
  • func New(p Protocol, in io.Writer, out io.Reader) (ContainerIO, error)
• type DefaultProtocol
  • func (p *DefaultProtocol) Dispatch(ctx context.Context, t task.Request) error
  • func (p *DefaultProtocol) IsStreamable() bool
• type HTTPProtocol
  • func (p *HTTPProtocol) Dispatch(ctx context.Context, t task.Request) error
  • func (p *HTTPProtocol) IsStreamable() bool
• type Protocol

Functions

func IsStreamable

func IsStreamable(p string) (bool, error)

IsStreamable says whether the given protocol can be used for streaming into hot functions.

Types

type ContainerIO

type ContainerIO interface {
	IsStreamable() bool
	Dispatch(ctx context.Context, t task.Request) error
}

ContainerIO defines the interface used to talk to a hot function. Internally, a protocol must know when to alternate between stdin and stdout. It returns any protocol error, if present.

func New

func New(p Protocol, in io.Writer, out io.Reader) (ContainerIO, error)

New creates a valid protocol handler from a I/O pipe representing containers stdin/stdout.

type DefaultProtocol

type DefaultProtocol struct {
}

DefaultProtocol is the protocol used by cold-containers

func (*DefaultProtocol) Dispatch

func (p *DefaultProtocol) Dispatch(ctx context.Context, t task.Request) error

func (*DefaultProtocol) IsStreamable

func (p *DefaultProtocol) IsStreamable() bool

type HTTPProtocol

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

HTTPProtocol converts stdin/stdout streams into HTTP/1.1 compliant communication. It relies on Content-Length to know when to stop reading from containers stdout. It also mandates valid HTTP headers back and forth, thus returning errors in case of parsing problems.

func (*HTTPProtocol) Dispatch

func (p *HTTPProtocol) Dispatch(ctx context.Context, t task.Request) error

func (*HTTPProtocol) IsStreamable

func (p *HTTPProtocol) IsStreamable() bool

type Protocol

type Protocol string

Protocol defines all protocols that operates a ContainerIO.

const (
	Default Protocol = models.FormatDefault
	HTTP    Protocol = models.FormatHTTP
	Empty   Protocol = ""
)

hot function protocols