membrane

Documentation

Index

• type Membrane
  • func New(options *MembraneOptions) (*Membrane, error)
  • func (s *Membrane) Start() error
  • func (s *Membrane) Stop()
• type MembraneOptions
• type Mode
  • func ModeFromString(modeString string) (Mode, error)
  • func (m Mode) String() string

Types

type Membrane

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

func New

func New(options *MembraneOptions) (*Membrane, error)

Create a new Membrane server

func (*Membrane) Start

func (s *Membrane) Start() error

Start the membrane

func (*Membrane) Stop

func (s *Membrane) Stop()

type MembraneOptions

type MembraneOptions struct {
	ServiceAddress string
	// The address the child will be listening on
	ChildAddress string
	// The command that will be used to invoke the child process
	ChildCommand []string
	// The total time to wait for the child process to be available in seconds
	ChildTimeoutSeconds int

	DocumentPlugin document.DocumentService
	EventsPlugin   events.EventService
	StoragePlugin  storage.StorageService
	QueuePlugin    queue.QueueService
	GatewayPlugin  gateway.GatewayService

	SuppressLogs            bool
	TolerateMissingServices bool

	// The operating mode of the membrane
	Mode *Mode

	// Supply your own worker pool
	Pool worker.WorkerPool
}

type Mode

type Mode int

SourceType enum

const (
	// Mode_Faas Facilitates FaaS via gRPC FaaS Server
	Mode_Faas Mode = iota
	// Mode_HttpFaas Facilitates FaaS via HTTP Request/Response
	Mode_HttpFaas
	// Mode_HttpProxy is designed for integration of monoliths into a nitric application
	Mode_HttpProxy
)

func ModeFromString

func ModeFromString(modeString string) (Mode, error)

func (Mode) String

func (m Mode) String() string