issue333

Documentation

Overview

Package "issue333" 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)
• 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 EventIdSchema
• type HeadersFromPingMessageFromTestChannel
• type MessageWithCorrelationID
• type PingMessageFromTestChannel
  • func NewPingMessageFromTestChannel() PingMessageFromTestChannel
• type PingMessageFromTestChannelPayload
• type UserController
  • func NewUserController(bc extensions.BrokerController, options ...ControllerOption) (*UserController, error)
  • func (c *UserController) Close(ctx context.Context)

Constants

const AsyncAPIVersion = "1.0.0"

AsyncAPIVersion is the version of the used AsyncAPI document

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

Variables

var ChannelsPaths = []string{
	TestChannelPath,
}

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 sending 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

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 EventIdSchema

type EventIdSchema string

EventIdSchema is a schema from the AsyncAPI specification required in messages

type HeadersFromPingMessageFromTestChannel

type HeadersFromPingMessageFromTestChannel struct {
	EventId         EventIdSchema  `json:"event_id"`
	OptionalEventId *EventIdSchema `json:"optional_event_id,omitempty"`
}

HeadersFromPingMessageFromTestChannel is a schema from the AsyncAPI specification required in messages

type MessageWithCorrelationID

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

type PingMessageFromTestChannel

type PingMessageFromTestChannel struct {
	// Headers will be used to fill the message headers
	Headers HeadersFromPingMessageFromTestChannel

	// Payload will be inserted in the message payload
	Payload PingMessageFromTestChannelPayload
}

PingMessageFromTestChannel is the message expected for 'PingMessageFromTestChannel' channel.

func NewPingMessageFromTestChannel

func NewPingMessageFromTestChannel() PingMessageFromTestChannel

type PingMessageFromTestChannelPayload

type PingMessageFromTestChannelPayload struct {
	Event *string `json:"event,omitempty" validate:"omitempty,eq=ping"`
}

PingMessageFromTestChannelPayload 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