snake

package
v0.42.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 20, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Overview

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

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

Index

Constants

View Source
const AsyncAPIVersion = ""

AsyncAPIVersion is the version of the used AsyncAPI document

View Source
const (
	// V2Issue129TestPath is the constant representing the 'V2Issue129Test' channel path.
	V2Issue129TestPath = "v2.issue129.test"
)

Variables

View Source
var ChannelsPaths = []string{
	V2Issue129TestPath,
}

ChannelsPaths is an array of all channels paths

Functions

This section is empty.

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 MessageWithCorrelationID

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

type TestSchema

type TestSchema struct {
	ThisIsAProperty *string `json:"this_is_a_property"`
}

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) PublishV2Issue129Test

func (c *UserController) PublishV2Issue129Test(
	ctx context.Context,
	msg V2Issue129TestMessage,
) error

PublishV2Issue129Test will publish messages to 'v2.issue129.test' channel

type V2Issue129TestMessage

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

V2Issue129TestMessage is the message expected for 'V2Issue129TestMessage' channel.

func NewV2Issue129TestMessage

func NewV2Issue129TestMessage() V2Issue129TestMessage

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL