kebab

Documentation

Overview

Package "kebab" provides primitives to interact with the AsyncAPI specification.

Code generated by github.com/lerenn/asyncapi-codegen version (devel) DO NOT EDIT.

Index

• Constants
• Variables
• type ControllerOption
  • func WithErrorHandler(handler extensions.ErrorHandler) ControllerOption
  • func WithLogger(logger extensions.Logger) ControllerOption
  • func WithMiddlewares(middlewares ...extensions.Middleware) ControllerOption
• type Error
  • func (e *Error) Error() string
• type MessageWithCorrelationID
• type TestMessageFromTestChannel
  • func NewTestMessageFromTestChannel() TestMessageFromTestChannel
• type TestSchema
• type UserController
  • func NewUserController(bc extensions.BrokerController, options ...ControllerOption) (*UserController, error)
  • func (c *UserController) Close(ctx context.Context)
  • func (c *UserController) SendToReceiveTestOperation(ctx context.Context, msg TestMessageFromTestChannel) error

Constants

const AsyncAPIVersion = ""

AsyncAPIVersion is the version of the used AsyncAPI document

const (
	// TestChannelPath is the constant representing the 'TestChannel' channel path.
	TestChannelPath = "v3.issue129.test"
)

Variables

var ChannelsPaths = []string{
	TestChannelPath,
}

ChannelsPaths is an array of all channels paths

Types

type ControllerOption

type ControllerOption func(controller *controller)

ControllerOption is the type of the options that can be passed when creating a new Controller

func WithErrorHandler

func WithErrorHandler(handler extensions.ErrorHandler) ControllerOption

WithErrorHandler attaches a errorhandler to handle errors from subscriber functions

func WithLogger

func WithLogger(logger extensions.Logger) ControllerOption

WithLogger attaches a logger to the controller

func WithMiddlewares

func WithMiddlewares(middlewares ...extensions.Middleware) ControllerOption

WithMiddlewares attaches middlewares that will be executed when sending or receiving messages

type Error

type Error struct {
	Channel string
	Err     error
}

func (*Error) Error

func (e *Error) Error() string

type MessageWithCorrelationID

type MessageWithCorrelationID interface {
	CorrelationID() string
	SetCorrelationID(id string)
}

type TestMessageFromTestChannel

type TestMessageFromTestChannel struct {
	// Payload will be inserted in the message payload
	Payload TestSchema
}

TestMessageFromTestChannel is the message expected for 'TestMessageFromTestChannel' channel.

func NewTestMessageFromTestChannel

func NewTestMessageFromTestChannel() TestMessageFromTestChannel

type TestSchema

type TestSchema struct {
	ThisIsAProperty *string `json:"this-is-a-property"`
}

TestSchema is a schema from the AsyncAPI specification required in messages

type UserController

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

UserController is the structure that provides sending capabilities to the developer and and connect the broker with the User

func NewUserController

func NewUserController(bc extensions.BrokerController, options ...ControllerOption) (*UserController, error)

NewUserController links the User to the broker

func (*UserController) Close

func (c *UserController) Close(ctx context.Context)

Close will clean up any existing resources on the controller

func (*UserController) SendToReceiveTestOperation

func (c *UserController) SendToReceiveTestOperation(
	ctx context.Context,
	msg TestMessageFromTestChannel,
) error

SendToReceiveTestOperation will send a TestMessageFromTestChannel message on Test channel.

NOTE: for now, this only support the first message from AsyncAPI list. If you need support for other messages, please raise an issue.