workers

Documentation

Index

• func HandleStream[ClientMessage any, RegistrationResponse any, ...](ctx context.Context, ...) error
• type Manager
  • func GetDefaultManager() *Manager
  • func New() *Manager
  • func (m *Manager) AddWorker(name string, s StreamWorker)
  • func (m *Manager) RegisterPolicy(res *v1.ResourceIdentifier, actions ...v1.Action) error
  • func (m *Manager) RegisterResource(request *v1.ResourceDeclareRequest) <-chan RegisterResult
  • func (m *Manager) Run(ctx context.Context) error
• type RegisterResult
• type StdServerMsg
• type Stream
• type StreamWorker

Functions

func HandleStream

func HandleStream[ClientMessage any, RegistrationResponse any, ServerMessage StdServerMsg[RegistrationResponse]](
	ctx context.Context,
	createStream func(ctx context.Context) (Stream[ClientMessage, RegistrationResponse, ServerMessage], error),
	initReq *ClientMessage,
	handleServerMsg func(msg ServerMessage) (*ClientMessage, error),
) error

HandleStream runs a nitric worker, in the standard request/response pattern. No changes needed here other than the updated types in the signature.

Types

type Manager

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

func GetDefaultManager

func GetDefaultManager() *Manager

func New

func New() *Manager

New is used to create the top level resource manager. Note: this is not required if you are using resources.NewApi() and the like. These use a default manager instance.

func (*Manager) AddWorker

func (m *Manager) AddWorker(name string, s StreamWorker)

func (*Manager) RegisterPolicy

func (m *Manager) RegisterPolicy(res *v1.ResourceIdentifier, actions ...v1.Action) error

func (*Manager) RegisterResource

func (m *Manager) RegisterResource(request *v1.ResourceDeclareRequest) <-chan RegisterResult

func (*Manager) Run

func (m *Manager) Run(ctx context.Context) error

type RegisterResult

type RegisterResult struct {
	Identifier *v1.ResourceIdentifier
	Err        error
}

type StdServerMsg

type StdServerMsg[RegistrationResponse any] interface {
	GetRegistrationResponse() *RegistrationResponse
}

type Stream

type Stream[ClientMessage any, RegistrationResponse any, ServerMessage StdServerMsg[RegistrationResponse]] interface {
	Send(*ClientMessage) error
	Recv() (ServerMessage, error)
	grpc.ClientStream
}

type StreamWorker

type StreamWorker interface {
	Start(context.Context) error
}