issue49

Documentation

Overview

Package "issue49" 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) PublishIssue49Chat(ctx context.Context, msg Issue49ChatMessage) error
  • func (c *AppController) PublishIssue49Status(ctx context.Context, msg Issue49StatusMessage) error
  • func (c *AppController) SubscribeAll(ctx context.Context, as AppSubscriber) error
  • func (c *AppController) SubscribeIssue49Chat(ctx context.Context, fn func(ctx context.Context, msg Issue49ChatMessage)) error
  • func (c *AppController) UnsubscribeAll(ctx context.Context)
  • func (c *AppController) UnsubscribeIssue49Chat(ctx context.Context)
• type AppSubscriber
• type ControllerOption
  • func WithLogger(logger extensions.Logger) ControllerOption
  • func WithMiddlewares(middlewares ...extensions.Middleware) ControllerOption
• type Error
  • func (e *Error) Error() string
• type Issue49ChatMessage
  • func NewIssue49ChatMessage() Issue49ChatMessage
• type Issue49StatusMessage
  • func NewIssue49StatusMessage() Issue49StatusMessage
• type Message
  • func NewMessage() Message
• type MessageWithCorrelationID
• type UserController
  • func NewUserController(bc extensions.BrokerController, options ...ControllerOption) (*UserController, error)
  • func (c *UserController) Close(ctx context.Context)
  • func (c *UserController) PublishIssue49Chat(ctx context.Context, msg Issue49ChatMessage) error
  • func (c *UserController) SubscribeAll(ctx context.Context, as UserSubscriber) error
  • func (c *UserController) SubscribeIssue49Chat(ctx context.Context, fn func(ctx context.Context, msg Issue49ChatMessage)) error
  • func (c *UserController) SubscribeIssue49Status(ctx context.Context, fn func(ctx context.Context, msg Issue49StatusMessage)) error
  • func (c *UserController) UnsubscribeAll(ctx context.Context)
  • func (c *UserController) UnsubscribeIssue49Chat(ctx context.Context)
  • func (c *UserController) UnsubscribeIssue49Status(ctx context.Context)
• type UserSubscriber

Constants

const (
	// Issue49ChatPath is the constant representing the 'Issue49.chat' channel path.
	Issue49ChatPath = "issue49.chat"
	// Issue49StatusPath is the constant representing the 'Issue49.status' channel path.
	Issue49StatusPath = "issue49.status"
)

const AsyncAPIVersion = "1.0.0"

AsyncAPIVersion is the version of the used AsyncAPI document

Variables

var ChannelsPaths = []string{
	Issue49ChatPath,
	Issue49StatusPath,
}

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

func (c *AppController) PublishIssue49Chat(ctx context.Context, msg Issue49ChatMessage) error

PublishIssue49Chat will publish messages to 'issue49.chat' channel

func (*AppController) PublishIssue49Status

func (c *AppController) PublishIssue49Status(ctx context.Context, msg Issue49StatusMessage) error

PublishIssue49Status will publish messages to 'issue49.status' channel

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

func (c *AppController) SubscribeIssue49Chat(ctx context.Context, fn func(ctx context.Context, msg Issue49ChatMessage)) error

SubscribeIssue49Chat will subscribe to new messages from 'issue49.chat' 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) UnsubscribeIssue49Chat

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

UnsubscribeIssue49Chat will unsubscribe messages from 'issue49.chat' channel. A timeout can be set in context to avoid blocking operation, if needed.

type AppSubscriber

type AppSubscriber interface {
	// Issue49Chat subscribes to messages placed on the 'issue49.chat' channel
	Issue49Chat(ctx context.Context, msg Issue49ChatMessage)
}

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

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

Issue49ChatMessage is the message expected for 'Issue49Chat' channel

func NewIssue49ChatMessage

func NewIssue49ChatMessage() Issue49ChatMessage

type Issue49StatusMessage

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

Issue49StatusMessage is the message expected for 'Issue49Status' channel

func NewIssue49StatusMessage

func NewIssue49StatusMessage() Issue49StatusMessage

type Message

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

Message is the message expected for ” channel

func NewMessage

func NewMessage() Message

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

func (c *UserController) PublishIssue49Chat(ctx context.Context, msg Issue49ChatMessage) error

PublishIssue49Chat will publish messages to 'issue49.chat' channel

func (*UserController) SubscribeAll

func (c *UserController) SubscribeAll(ctx context.Context, as UserSubscriber) 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 (*UserController) SubscribeIssue49Chat

func (c *UserController) SubscribeIssue49Chat(ctx context.Context, fn func(ctx context.Context, msg Issue49ChatMessage)) error

SubscribeIssue49Chat will subscribe to new messages from 'issue49.chat' channel.

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

func (*UserController) SubscribeIssue49Status

func (c *UserController) SubscribeIssue49Status(ctx context.Context, fn func(ctx context.Context, msg Issue49StatusMessage)) error

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

func (*UserController) UnsubscribeAll

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

UnsubscribeAll will unsubscribe all remaining subscribed channels

func (*UserController) UnsubscribeIssue49Chat

func (c *UserController) UnsubscribeIssue49Chat(ctx context.Context)

UnsubscribeIssue49Chat will unsubscribe messages from 'issue49.chat' channel. A timeout can be set in context to avoid blocking operation, if needed.

func (*UserController) UnsubscribeIssue49Status

func (c *UserController) UnsubscribeIssue49Status(ctx context.Context)

UnsubscribeIssue49Status will unsubscribe messages from 'issue49.status' channel. A timeout can be set in context to avoid blocking operation, if needed.

type UserSubscriber

type UserSubscriber interface {
	// Issue49Chat subscribes to messages placed on the 'issue49.chat' channel
	Issue49Chat(ctx context.Context, msg Issue49ChatMessage)

	// Issue49Status subscribes to messages placed on the 'issue49.status' channel
	Issue49Status(ctx context.Context, msg Issue49StatusMessage)
}

UserSubscriber represents all handlers that are expecting messages for User