generated

Documentation

Overview

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

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

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

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

Index

• Variables
• type AppController
  • func NewAppController(bc broker.Controller) (*AppController, error)
  • func (c *AppController) AddMiddlewares(middleware ...middleware.Middleware)
  • func (c *AppController) Close(ctx context.Context)
  • func (c *AppController) SetLogger(logger log.Interface)
  • func (c *AppController) SubscribeAll(ctx context.Context, as AppSubscriber) error
  • func (c *AppController) SubscribeHello(ctx context.Context, fn func(ctx context.Context, msg HelloMessage, done bool)) error
  • func (c *AppController) UnsubscribeAll(ctx context.Context)
  • func (c *AppController) UnsubscribeHello(ctx context.Context)
• type AppSubscriber
• type Error
  • func (e *Error) Error() string
• type HelloMessage
  • func NewHelloMessage() HelloMessage
• type MessageWithCorrelationID

Variables

var (
	// Generic error for AsyncAPI generated code
	ErrAsyncAPI = errors.New("error when using AsyncAPI")

	// ErrContextCanceled is given when a given context is canceled
	ErrContextCanceled = fmt.Errorf("%w: context canceled", ErrAsyncAPI)

	// ErrNilBrokerController is raised when a nil broker controller is user
	ErrNilBrokerController = fmt.Errorf("%w: nil broker controller has been used", ErrAsyncAPI)

	// ErrNilAppSubscriber is raised when a nil app subscriber is user
	ErrNilAppSubscriber = fmt.Errorf("%w: nil app subscriber has been used", ErrAsyncAPI)

	// ErrNilClientSubscriber is raised when a nil client subscriber is user
	ErrNilClientSubscriber = fmt.Errorf("%w: nil client subscriber has been used", ErrAsyncAPI)

	// ErrAlreadySubscribedChannel is raised when a subscription is done twice
	// or more without unsubscribing
	ErrAlreadySubscribedChannel = fmt.Errorf("%w: the channel has already been subscribed", ErrAsyncAPI)

	// ErrSubscriptionCanceled is raised when expecting something and the subscription has been canceled before it happens
	ErrSubscriptionCanceled = fmt.Errorf("%w: the subscription has been canceled", ErrAsyncAPI)
)

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 broker.Controller) (*AppController, error)

NewAppController links the App to the broker

func (*AppController) AddMiddlewares

func (c *AppController) AddMiddlewares(middleware ...middleware.Middleware)

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

func (*AppController) Close

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

Close will clean up any existing resources on the controller

func (*AppController) SetLogger

func (c *AppController) SetLogger(logger log.Interface)

SetLogger attaches a logger that will log operations on controller

func (*AppController) SubscribeAll

func (c *AppController) SubscribeAll(ctx context.Context, as AppSubscriber) 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 (*AppController) SubscribeHello

func (c *AppController) SubscribeHello(ctx context.Context, fn func(ctx context.Context, msg HelloMessage, done bool)) error

SubscribeHello will subscribe to new messages from 'hello' channel.

Callback function 'fn' will be called each time a new message is received. The 'done' argument indicates when the subscription is canceled and can be used to clean up resources.

func (*AppController) UnsubscribeAll

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

UnsubscribeAll will unsubscribe all remaining subscribed channels

func (*AppController) UnsubscribeHello

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

UnsubscribeHello will unsubscribe messages from 'hello' channel

type AppSubscriber

type AppSubscriber interface {
	// Hello
	Hello(ctx context.Context, msg HelloMessage, done bool)
}

AppSubscriber represents all handlers that are expecting messages for App

type Error

type Error struct {
	Channel string
	Err     error
}

func (*Error) Error

func (e *Error) Error() string

type HelloMessage

type HelloMessage struct {
	// Payload will be inserted in the message payload
	Payload string
}

HelloMessage is the message expected for 'Hello' channel

func NewHelloMessage

func NewHelloMessage() HelloMessage

type MessageWithCorrelationID

type MessageWithCorrelationID interface {
	CorrelationID() string
}