issue169

Documentation

Overview

Package "issue169" 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)
  • func (c *AppController) SubscribeAll(ctx context.Context, as AppSubscriber) error
  • func (c *AppController) SubscribeIssue169Msg(ctx context.Context, ...) error
  • func (c *AppController) UnsubscribeAll(ctx context.Context)
  • func (c *AppController) UnsubscribeIssue169Msg(ctx context.Context)
• type AppSubscriber
• 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 Issue169MsgMessage
  • func NewIssue169MsgMessage() Issue169MsgMessage
• type MessageWithCorrelationID
• type UserController
  • func NewUserController(bc extensions.BrokerController, options ...ControllerOption) (*UserController, error)
  • func (c *UserController) Close(ctx context.Context)
  • func (c *UserController) PublishIssue169Msg(ctx context.Context, msg Issue169MsgMessage) error

Constants

const AsyncAPIVersion = "1.0.0"

AsyncAPIVersion is the version of the used AsyncAPI document

const (
	// Issue169MsgPath is the constant representing the 'Issue169Msg' channel path.
	Issue169MsgPath = "issue169.msg"
)

Variables

var ChannelsPaths = []string{
	Issue169MsgPath,
}

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

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

func (c *AppController) SubscribeIssue169Msg(
	ctx context.Context,
	fn func(ctx context.Context, msg Issue169MsgMessage) error,
) error

SubscribeIssue169Msg will subscribe to new messages from 'issue169.msg' channel.

Callback function 'fn' will be called each time a new message is received.

func (*AppController) UnsubscribeAll

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

UnsubscribeAll will unsubscribe all remaining subscribed channels

func (*AppController) UnsubscribeIssue169Msg

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

UnsubscribeIssue169Msg will unsubscribe messages from 'issue169.msg' channel. A timeout can be set in context to avoid blocking operation, if needed.

type AppSubscriber

type AppSubscriber interface {
	// Issue169Msg subscribes to messages placed on the 'issue169.msg' channel
	Issue169Msg(ctx context.Context, msg Issue169MsgMessage) error
}

AppSubscriber represents all handlers that are expecting messages for App

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 Issue169MsgMessage

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

Issue169MsgMessage is the message expected for 'Issue169MsgMessage' channel.

func NewIssue169MsgMessage

func NewIssue169MsgMessage() Issue169MsgMessage

type MessageWithCorrelationID

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

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

func (c *UserController) PublishIssue169Msg(
	ctx context.Context,
	msg Issue169MsgMessage,
) error

PublishIssue169Msg will publish messages to 'issue169.msg' channel