run

Documentation

Overview

Copyright Nitric Pty Ltd.

SPDX-License-Identifier: Apache-2.0

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at:

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright Nitric Pty Ltd.

SPDX-License-Identifier: Apache-2.0

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at:

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright Nitric Pty Ltd.

SPDX-License-Identifier: Apache-2.0

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at:

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• func NewEvents(pool worker.WorkerPool) (events.EventService, error)
• func NewGateway(address string) (gateway.GatewayService, error)
• type BaseHttpGateway
  • func (s *BaseHttpGateway) Start(pool worker.WorkerPool) error
  • func (s *BaseHttpGateway) Stop() error
• type Function
  • func FunctionsFromHandlers(p *project.Project) ([]*Function, error)
  • func (f *Function) Name() string
  • func (f *Function) Start(envMap map[string]string) error
  • func (f *Function) Stop() error
• type FunctionOpts
• type HttpMiddleware
• type LocalServices
  • func NewLocalServices(s *project.Project) LocalServices
• type LocalServicesStatus
• type MinioServer
  • func NewMinio(dir string, name string, buckets []string) (*MinioServer, error)
  • func (m *MinioServer) GetApiPort() int
  • func (m *MinioServer) Start() error
  • func (m *MinioServer) Stop() error
• type RunProcessPool
  • func NewRunProcessPool() *RunProcessPool
  • func (r *RunProcessPool) AddWorker(w worker.Worker) error
  • func (r *RunProcessPool) Listen(l WorkerListener)
  • func (r *RunProcessPool) RemoveWorker(w worker.Worker) error
• type RunStackState
  • func NewStackState() *RunStackState
  • func (r *RunStackState) ApiTable(port int) (string, int)
  • func (r *RunStackState) SchedulesTable(port int) (string, int)
  • func (r *RunStackState) TopicTable(port int) (string, int)
  • func (r *RunStackState) UpdateFromWorkerEvent(evt WorkerEvent)
• type WorkerEvent
• type WorkerEventType
• type WorkerListener
• type WorkerPoolEventService
  • func (s *WorkerPoolEventService) Publish(topic string, event *events.NitricEvent) error

Functions

func NewEvents

func NewEvents(pool worker.WorkerPool) (events.EventService, error)

Create new Dev EventService

func NewGateway

func NewGateway(address string) (gateway.GatewayService, error)

Create new HTTP gateway XXX: No External Args for function atm (currently the plugin loader does not pass any argument information)

Types

type BaseHttpGateway

type BaseHttpGateway struct {
	gateway.UnimplementedGatewayPlugin
	// contains filtered or unexported fields
}

func (*BaseHttpGateway) Start

func (s *BaseHttpGateway) Start(pool worker.WorkerPool) error

func (*BaseHttpGateway) Stop

func (s *BaseHttpGateway) Stop() error

type Function

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

func FunctionsFromHandlers

func FunctionsFromHandlers(p *project.Project) ([]*Function, error)

func (*Function) Name

func (f *Function) Name() string

func (*Function) Start

func (f *Function) Start(envMap map[string]string) error

func (*Function) Stop

func (f *Function) Stop() error

type FunctionOpts

type FunctionOpts struct {
	ProjectName     string
	Handler         string
	RunCtx          string
	ContainerEngine containerengine.ContainerEngine
}

type HttpMiddleware

type HttpMiddleware func(*fasthttp.RequestCtx, worker.WorkerPool) bool

type LocalServices

type LocalServices interface {
	Start(pool worker.WorkerPool) error
	Stop() error
	Running() bool
	Status() *LocalServicesStatus
}

func NewLocalServices

func NewLocalServices(s *project.Project) LocalServices

type LocalServicesStatus

type LocalServicesStatus struct {
	RunDir          string `yaml:"runDir"`
	GatewayAddress  string `yaml:"gatewayAddress"`
	MembraneAddress string `yaml:"membraneAddress"`
	MinioEndpoint   string `yaml:"minioEndpoint"`
}

type MinioServer

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

func NewMinio

func NewMinio(dir string, name string, buckets []string) (*MinioServer, error)

func (*MinioServer) GetApiPort

func (m *MinioServer) GetApiPort() int

func (*MinioServer) Start

func (m *MinioServer) Start() error

Start - Start the local Minio server

func (*MinioServer) Stop

func (m *MinioServer) Stop() error

type RunProcessPool

type RunProcessPool struct {
	worker.WorkerPool
	// contains filtered or unexported fields
}

func NewRunProcessPool

func NewRunProcessPool() *RunProcessPool

func (*RunProcessPool) AddWorker

func (r *RunProcessPool) AddWorker(w worker.Worker) error

func (*RunProcessPool) Listen

func (r *RunProcessPool) Listen(l WorkerListener)

func (*RunProcessPool) RemoveWorker

func (r *RunProcessPool) RemoveWorker(w worker.Worker) error

type RunStackState

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

func NewStackState

func NewStackState() *RunStackState

func (*RunStackState) ApiTable

func (r *RunStackState) ApiTable(port int) (string, int)

func (*RunStackState) SchedulesTable

func (r *RunStackState) SchedulesTable(port int) (string, int)

func (*RunStackState) TopicTable

func (r *RunStackState) TopicTable(port int) (string, int)

func (*RunStackState) UpdateFromWorkerEvent

func (r *RunStackState) UpdateFromWorkerEvent(evt WorkerEvent)

type WorkerEvent

type WorkerEvent struct {
	Type   WorkerEventType
	Worker worker.Worker
}

type WorkerEventType

type WorkerEventType string

const (
	WorkerEventType_Add    WorkerEventType = "add"
	WorkerEventType_Remove WorkerEventType = "remove"
)

type WorkerListener

type WorkerListener = func(WorkerEvent)

type WorkerPoolEventService

type WorkerPoolEventService struct {
	events.UnimplementedeventsPlugin
	// contains filtered or unexported fields
}

func (*WorkerPoolEventService) Publish

func (s *WorkerPoolEventService) Publish(topic string, event *events.NitricEvent) error

Publish a message to a given topic