Documentation
¶
Overview ¶
Package "issue74" provides primitives to interact with the AsyncAPI specification.
Code generated by github.com/lerenn/asyncapi-codegen version (devel) DO NOT EDIT.
Index ¶
- type AppController
- func (c *AppController) Close(ctx context.Context)
- func (c *AppController) SubscribeAll(ctx context.Context, as AppSubscriber) error
- func (c *AppController) SubscribeTestChannel(ctx context.Context, fn func(ctx context.Context, msg TestMessage)) error
- func (c *AppController) UnsubscribeAll(ctx context.Context)
- func (c *AppController) UnsubscribeTestChannel(ctx context.Context)
- type AppSubscriber
- type ControllerOption
- type Error
- type HeaderSchema
- type MessageWithCorrelationID
- type TestMessage
- type TestSchemaSchema
- type UserController
Constants ¶
This section is empty.
Variables ¶
This section is empty.
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) SubscribeTestChannel ¶
func (c *AppController) SubscribeTestChannel(ctx context.Context, fn func(ctx context.Context, msg TestMessage)) error
SubscribeTestChannel will subscribe to new messages from 'testChannel' 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) UnsubscribeTestChannel ¶
func (c *AppController) UnsubscribeTestChannel(ctx context.Context)
UnsubscribeTestChannel will unsubscribe messages from 'testChannel' channel
type AppSubscriber ¶
type AppSubscriber interface {
// TestChannel subscribes to messages placed on the 'testChannel' channel
TestChannel(ctx context.Context, msg TestMessage)
}
AppSubscriber represents all handlers that are expecting messages for App
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 HeaderSchema ¶
type HeaderSchema struct {
// Description: Date in UTC format "YYYY-MM-DDThh:mm:ss.sZ".
DateTime time.Time `json:"date_time"`
// Description: Schema version
Version string `json:"version"`
}
HeaderSchema is a schema from the AsyncAPI specification required in messages Description: header
type TestMessage ¶
type TestMessage struct {
// Headers will be used to fill the message headers
Headers HeaderSchema
// Payload will be inserted in the message payload
Payload struct {
Obj1 struct {
// Description: reference ID.
ReferenceID string `json:"reference_id"`
} `json:"obj1"`
}
}
TestMessage is the message expected for 'Test' channel test message
func NewTestMessage ¶
func NewTestMessage() TestMessage
type TestSchemaSchema ¶
type TestSchemaSchema struct {
Obj1 struct {
// Description: reference ID.
ReferenceID string `json:"reference_id"`
} `json:"obj1"`
}
TestSchemaSchema is a schema from the AsyncAPI specification required in messages
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) PublishTestChannel ¶ added in v0.20.0
func (c *UserController) PublishTestChannel(ctx context.Context, msg TestMessage) error
PublishTestChannel will publish messages to 'testChannel' channel
Source Files