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 ¶
- Variables
- type AppController
- func (c *AppController) AddMiddlewares(middleware ...extensions.Middleware)
- func (c *AppController) Close(ctx context.Context)
- func (c *AppController) SetLogger(logger extensions.Logger)
- func (c *AppController) SubscribeAll(ctx context.Context, as AppSubscriber) error
- func (c *AppController) SubscribeTestChannel(ctx context.Context, fn func(ctx context.Context, msg TestMessage, done bool)) error
- func (c *AppController) UnsubscribeAll(ctx context.Context)
- func (c *AppController) UnsubscribeTestChannel(ctx context.Context)
- type AppSubscriber
- type ClientController
- type Error
- type HeaderSchema
- type MessageWithCorrelationID
- type TestMessage
- type TestSchemaSchema
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) // ErrNilClientSubscriber is raised when a nil client subscriber is user ErrNilClientSubscriber = fmt.Errorf("%w: nil client 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) (*AppController, error)
NewAppController links the App to the broker
func (*AppController) AddMiddlewares ¶
func (c *AppController) AddMiddlewares(middleware ...extensions.Middleware)
AddMiddlewares attaches middlewares that will be executed when sending or receiving messages
func (*AppController) Close ¶
func (c *AppController) Close(ctx context.Context)
Close will clean up any existing resources on the controller
func (*AppController) SetLogger ¶
func (c *AppController) SetLogger(logger extensions.Logger)
SetLogger attaches a logger that will log operations on 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, done bool)) 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
TestChannel(ctx context.Context, msg TestMessage, done bool)
}
AppSubscriber represents all handlers that are expecting messages for App
type ClientController ¶
type ClientController struct {
// contains filtered or unexported fields
}
ClientController is the structure that provides publishing capabilities to the developer and and connect the broker with the Client
func NewClientController ¶
func NewClientController(bc extensions.BrokerController) (*ClientController, error)
NewClientController links the Client to the broker
func (*ClientController) AddMiddlewares ¶
func (c *ClientController) AddMiddlewares(middleware ...extensions.Middleware)
AddMiddlewares attaches middlewares that will be executed when sending or receiving messages
func (*ClientController) Close ¶
func (c *ClientController) Close(ctx context.Context)
Close will clean up any existing resources on the controller
func (*ClientController) PublishTestChannel ¶
func (c *ClientController) PublishTestChannel(ctx context.Context, msg TestMessage) error
PublishTestChannel will publish messages to 'testChannel' channel
func (*ClientController) SetLogger ¶
func (c *ClientController) SetLogger(logger extensions.Logger)
SetLogger attaches a logger that will log operations on controller
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
Source Files