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 ClientController
  • func NewClientController(bc broker.Controller) (*ClientController, error)
  • func (c *ClientController) AddMiddlewares(middleware ...middleware.Middleware)
  • func (c *ClientController) Close(ctx context.Context)
  • func (c *ClientController) PublishHello(ctx context.Context, msg HelloMessage) error
  • func (c *ClientController) SetLogger(logger log.Interface)
• 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 ClientController

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

ClientController is the structure that provides publishing capabilities to the developer and and connect the broker with the Client

func NewClientController

func NewClientController(bc broker.Controller) (*ClientController, error)

NewClientController links the Client to the broker

func (*ClientController) AddMiddlewares

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

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

func (*ClientController) Close

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

Close will clean up any existing resources on the controller

func (*ClientController) PublishHello

func (c *ClientController) PublishHello(ctx context.Context, msg HelloMessage) error

PublishHello will publish messages to 'hello' channel

func (*ClientController) SetLogger

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

SetLogger attaches a logger that will log operations on controller

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
}