Documentation
¶
Overview ¶
Package "issue186" provides primitives to interact with the AsyncAPI specification.
Code generated by github.com/akmalsyrf/asyncapi-codegen version (devel) DO NOT EDIT.
Index ¶
- Constants
- Variables
- type AppController
- func (c *AppController) Close(ctx context.Context)
- func (c *AppController) SubscribeAll(ctx context.Context, as AppSubscriber) error
- func (c *AppController) SubscribeV2Issue186Angle(ctx context.Context, ...) error
- func (c *AppController) SubscribeV2Issue186Star(ctx context.Context, ...) error
- func (c *AppController) UnsubscribeAll(ctx context.Context)
- func (c *AppController) UnsubscribeV2Issue186Angle(ctx context.Context)
- func (c *AppController) UnsubscribeV2Issue186Star(ctx context.Context)
- type AppSubscriber
- type ControllerOption
- type Error
- type MessageWithCorrelationID
- type UserController
- type V2Issue186AngleMessage
- type V2Issue186StarMessage
Constants ¶
const ( // V2Issue186AnglePath is the constant representing the 'V2Issue186Angle' channel path. V2Issue186AnglePath = "v2.issue186.angle.>" // V2Issue186StarPath is the constant representing the 'V2Issue186Star' channel path. V2Issue186StarPath = "v2.issue186.star.*.*" )
const AsyncAPIVersion = "1.0.0"
AsyncAPIVersion is the version of the used AsyncAPI document
Variables ¶
var ChannelsPaths = []string{ V2Issue186AnglePath, V2Issue186StarPath, }
ChannelsPaths is an array of all channels paths
Functions ¶
This section is empty.
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) SubscribeV2Issue186Angle ¶
func (c *AppController) SubscribeV2Issue186Angle( ctx context.Context, fn func(ctx context.Context, msg V2Issue186AngleMessage) error, ) error
SubscribeV2Issue186Angle will subscribe to new messages from 'v2.issue186.angle.>' channel.
Callback function 'fn' will be called each time a new message is received.
func (*AppController) SubscribeV2Issue186Star ¶
func (c *AppController) SubscribeV2Issue186Star( ctx context.Context, fn func(ctx context.Context, msg V2Issue186StarMessage) error, ) error
SubscribeV2Issue186Star will subscribe to new messages from 'v2.issue186.star.*.*' 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) UnsubscribeV2Issue186Angle ¶
func (c *AppController) UnsubscribeV2Issue186Angle(ctx context.Context)
UnsubscribeV2Issue186Angle will unsubscribe messages from 'v2.issue186.angle.>' channel. A timeout can be set in context to avoid blocking operation, if needed.
func (*AppController) UnsubscribeV2Issue186Star ¶
func (c *AppController) UnsubscribeV2Issue186Star(ctx context.Context)
UnsubscribeV2Issue186Star will unsubscribe messages from 'v2.issue186.star.*.*' channel. A timeout can be set in context to avoid blocking operation, if needed.
type AppSubscriber ¶
type AppSubscriber interface {
// V2Issue186Angle subscribes to messages placed on the 'v2.issue186.angle.>' channel
V2Issue186Angle(ctx context.Context, msg V2Issue186AngleMessage) error
// V2Issue186Star subscribes to messages placed on the 'v2.issue186.star.*.*' channel
V2Issue186Star(ctx context.Context, msg V2Issue186StarMessage) 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 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) PublishV2Issue186Angle ¶
func (c *UserController) PublishV2Issue186Angle( ctx context.Context, msg V2Issue186AngleMessage, ) error
PublishV2Issue186Angle will publish messages to 'v2.issue186.angle.>' channel
func (*UserController) PublishV2Issue186Star ¶
func (c *UserController) PublishV2Issue186Star( ctx context.Context, msg V2Issue186StarMessage, ) error
PublishV2Issue186Star will publish messages to 'v2.issue186.star.*.*' channel
type V2Issue186AngleMessage ¶
type V2Issue186AngleMessage struct {
// Payload will be inserted in the message payload
Payload string
}
V2Issue186AngleMessage is the message expected for 'V2Issue186AngleMessage' channel.
func NewV2Issue186AngleMessage ¶
func NewV2Issue186AngleMessage() V2Issue186AngleMessage
type V2Issue186StarMessage ¶
type V2Issue186StarMessage struct {
// Payload will be inserted in the message payload
Payload string
}
V2Issue186StarMessage is the message expected for 'V2Issue186StarMessage' channel.
func NewV2Issue186StarMessage ¶
func NewV2Issue186StarMessage() V2Issue186StarMessage
Source Files