camel

Documentation

Overview

Package "camel" 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 AppController
  • func NewAppController(bc extensions.BrokerController, options ...ControllerOption) (*AppController, error)
  • func (c *AppController) Close(ctx context.Context)
  • func (c *AppController) PublishV2Issue220Test(ctx context.Context, msg V2Issue220TestMessage) error
• 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 TestSchema
• type UserController
  • func NewUserController(bc extensions.BrokerController, options ...ControllerOption) (*UserController, error)
  • func (c *UserController) Close(ctx context.Context)
  • func (c *UserController) SubscribeAll(ctx context.Context, as UserSubscriber) error
  • func (c *UserController) SubscribeV2Issue220Test(ctx context.Context, ...) error
  • func (c *UserController) UnsubscribeAll(ctx context.Context)
  • func (c *UserController) UnsubscribeV2Issue220Test(ctx context.Context)
• type UserSubscriber
• type V2Issue220TestMessage
  • func NewV2Issue220TestMessage() V2Issue220TestMessage

Constants

const AsyncAPIVersion = "1.2.3"

AsyncAPIVersion is the version of the used AsyncAPI document

const (
	// V2Issue220TestPath is the constant representing the 'V2Issue220Test' channel path.
	V2Issue220TestPath = "v2.issue220.test"
)

Variables

var ChannelsPaths = []string{
	V2Issue220TestPath,
}

ChannelsPaths is an array of all channels paths

Types

type AppController

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

AppController is the structure that provides publishing capabilities to the developer and and connect the broker with the App

func NewAppController

func NewAppController(bc extensions.BrokerController, options ...ControllerOption) (*AppController, error)

NewAppController links the App to the broker

func (*AppController) Close

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

Close will clean up any existing resources on the controller

func (*AppController) PublishV2Issue220Test

func (c *AppController) PublishV2Issue220Test(
	ctx context.Context,
	msg V2Issue220TestMessage,
) error

PublishV2Issue220Test will publish messages to 'v2.issue220.test' channel

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 TestSchema

type TestSchema struct {
	AnotherProp2 *string `json:"ANOTHER_PROP_2"`
	AProp1       *string `json:"A_PROP_1"`
}

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 publishing 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) SubscribeAll

func (c *UserController) SubscribeAll(ctx context.Context, as UserSubscriber) error

SubscribeAll will subscribe to channels without parameters on which the app is expecting messages. For channels with parameters, they should be subscribed independently.

func (*UserController) SubscribeV2Issue220Test

func (c *UserController) SubscribeV2Issue220Test(
	ctx context.Context,
	fn func(ctx context.Context, msg V2Issue220TestMessage) error,
) error

SubscribeV2Issue220Test will subscribe to new messages from 'v2.issue220.test' channel.

Callback function 'fn' will be called each time a new message is received.

func (*UserController) UnsubscribeAll

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

UnsubscribeAll will unsubscribe all remaining subscribed channels

func (*UserController) UnsubscribeV2Issue220Test

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

UnsubscribeV2Issue220Test will unsubscribe messages from 'v2.issue220.test' channel. A timeout can be set in context to avoid blocking operation, if needed.

type UserSubscriber

type UserSubscriber interface {
	// V2Issue220Test subscribes to messages placed on the 'v2.issue220.test' channel
	V2Issue220Test(ctx context.Context, msg V2Issue220TestMessage) error
}

UserSubscriber represents all handlers that are expecting messages for User

type V2Issue220TestMessage

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

V2Issue220TestMessage is the message expected for 'V2Issue220TestMessage' channel.

func NewV2Issue220TestMessage

func NewV2Issue220TestMessage() V2Issue220TestMessage