issue211

Documentation

Overview

Package "issue211" 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 EventSuccessMessage
  • func NewEventSuccessMessage() EventSuccessMessage
• type EventSuccessMessagePayload
• type MessageWithCorrelationID

Constants

const AsyncAPIVersion = "0.1.0"

AsyncAPIVersion is the version of the used AsyncAPI document

const (
	// EventSuccessChannelPath is the constant representing the 'EventSuccessChannel' channel path.
	EventSuccessChannelPath = "v3.issue211.topic"
)

Variables

var ChannelsPaths = []string{
	EventSuccessChannelPath,
}

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 EventSuccessMessage

type EventSuccessMessage struct {
	// Payload will be inserted in the message payload
	Payload EventSuccessMessagePayload
}

EventSuccessMessage is the message expected for 'EventSuccessMessage' channel.

func NewEventSuccessMessage

func NewEventSuccessMessage() EventSuccessMessage

type EventSuccessMessagePayload

type EventSuccessMessagePayload struct {
	// Description: The timestamp of the event
	Timestamp *int64 `json:"timestamp,omitempty"`
}

EventSuccessMessagePayload is a schema from the AsyncAPI specification required in messages

type MessageWithCorrelationID

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