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 ¶
- Variables
- type AppController
- func (c *AppController) Close(ctx context.Context)
- func (c *AppController) PublishStatus(ctx context.Context, msg StatusMessage) error
- func (c *AppController) SubscribeAll(ctx context.Context, as AppSubscriber) error
- func (c *AppController) SubscribeChat(ctx context.Context, fn func(ctx context.Context, msg ChatMessage, done bool)) error
- func (c *AppController) UnsubscribeAll(ctx context.Context)
- func (c *AppController) UnsubscribeChat(ctx context.Context)
- type AppSubscriber
- type ChatMessage
- type ControllerOption
- type Error
- type Message
- type MessageWithCorrelationID
- type StatusMessage
- type UserController
- func (c *UserController) Close(ctx context.Context)
- func (c *UserController) PublishChat(ctx context.Context, msg ChatMessage) error
- func (c *UserController) SubscribeAll(ctx context.Context, as UserSubscriber) error
- func (c *UserController) SubscribeStatus(ctx context.Context, ...) error
- func (c *UserController) UnsubscribeAll(ctx context.Context)
- func (c *UserController) UnsubscribeStatus(ctx context.Context)
- type UserSubscriber
Constants ¶
This section is empty.
Variables ¶
var ( // Generic error for AsyncAPI generated code ErrAsyncAPI = errors.New("error when using AsyncAPI") // ErrContextCanceled is given when a given context is canceled ErrContextCanceled = fmt.Errorf("%w: context canceled", ErrAsyncAPI) // ErrNilBrokerController is raised when a nil broker controller is user ErrNilBrokerController = fmt.Errorf("%w: nil broker controller has been used", ErrAsyncAPI) // ErrNilAppSubscriber is raised when a nil app subscriber is user ErrNilAppSubscriber = fmt.Errorf("%w: nil app subscriber has been used", ErrAsyncAPI) // ErrNilUserSubscriber is raised when a nil user subscriber is user ErrNilUserSubscriber = fmt.Errorf("%w: nil user subscriber has been used", ErrAsyncAPI) // ErrAlreadySubscribedChannel is raised when a subscription is done twice // or more without unsubscribing ErrAlreadySubscribedChannel = fmt.Errorf("%w: the channel has already been subscribed", ErrAsyncAPI) // ErrSubscriptionCanceled is raised when expecting something and the subscription has been canceled before it happens ErrSubscriptionCanceled = fmt.Errorf("%w: the subscription has been canceled", ErrAsyncAPI) )
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) PublishStatus ¶
func (c *AppController) PublishStatus(ctx context.Context, msg StatusMessage) error
PublishStatus will publish messages to '/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) SubscribeChat ¶
func (c *AppController) SubscribeChat(ctx context.Context, fn func(ctx context.Context, msg ChatMessage, done bool)) error
SubscribeChat will subscribe to new messages from '/chat' channel.
Callback function 'fn' will be called each time a new message is received. The 'done' argument indicates when the subscription is canceled and can be used to clean up resources.
func (*AppController) UnsubscribeAll ¶
func (c *AppController) UnsubscribeAll(ctx context.Context)
UnsubscribeAll will unsubscribe all remaining subscribed channels
func (*AppController) UnsubscribeChat ¶
func (c *AppController) UnsubscribeChat(ctx context.Context)
UnsubscribeChat will unsubscribe messages from '/chat' channel
type AppSubscriber ¶
type AppSubscriber interface {
// Chat subscribes to messages placed on the '/chat' channel
Chat(ctx context.Context, msg ChatMessage, done bool)
}
AppSubscriber represents all handlers that are expecting messages for App
type ChatMessage ¶
type ChatMessage struct {
// Payload will be inserted in the message payload
Payload string
}
ChatMessage is the message expected for 'Chat' channel
func NewChatMessage ¶
func NewChatMessage() ChatMessage
type ControllerOption ¶ added in v0.21.0
type ControllerOption func(controller *controller)
ControllerOption is the type of the options that can be passed when creating a new Controller
func WithLogger ¶ added in v0.21.0
func WithLogger(logger extensions.Logger) ControllerOption
WithLogger attaches a logger to the controller
func WithMiddlewares ¶ added in v0.21.0
func WithMiddlewares(middlewares ...extensions.Middleware) ControllerOption
WithMiddlewares attaches middlewares that will be executed when sending or receiving messages
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 StatusMessage ¶
type StatusMessage struct {
// Payload will be inserted in the message payload
Payload string
}
StatusMessage is the message expected for 'Status' channel
func NewStatusMessage ¶
func NewStatusMessage() StatusMessage
type UserController ¶ added in v0.20.0
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 ¶ added in v0.20.0
func NewUserController(bc extensions.BrokerController, options ...ControllerOption) (*UserController, error)
NewUserController links the User to the broker
func (*UserController) Close ¶ added in v0.20.0
func (c *UserController) Close(ctx context.Context)
Close will clean up any existing resources on the controller
func (*UserController) PublishChat ¶ added in v0.20.0
func (c *UserController) PublishChat(ctx context.Context, msg ChatMessage) error
PublishChat will publish messages to '/chat' channel
func (*UserController) SubscribeAll ¶ added in v0.20.0
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) SubscribeStatus ¶ added in v0.20.0
func (c *UserController) SubscribeStatus(ctx context.Context, fn func(ctx context.Context, msg StatusMessage, done bool)) error
SubscribeStatus will subscribe to new messages from '/status' channel.
Callback function 'fn' will be called each time a new message is received. The 'done' argument indicates when the subscription is canceled and can be used to clean up resources.
func (*UserController) UnsubscribeAll ¶ added in v0.20.0
func (c *UserController) UnsubscribeAll(ctx context.Context)
UnsubscribeAll will unsubscribe all remaining subscribed channels
func (*UserController) UnsubscribeStatus ¶ added in v0.20.0
func (c *UserController) UnsubscribeStatus(ctx context.Context)
UnsubscribeStatus will unsubscribe messages from '/status' channel
type UserSubscriber ¶ added in v0.20.0
type UserSubscriber interface {
// Chat subscribes to messages placed on the '/chat' channel
Chat(ctx context.Context, msg ChatMessage, done bool)
// Status subscribes to messages placed on the '/status' channel
Status(ctx context.Context, msg StatusMessage, done bool)
}
UserSubscriber represents all handlers that are expecting messages for User
Source Files