Documentation
¶
Overview ¶
Package "generated" provides primitives to interact with the AsyncAPI specification.
Code generated by github.com/lerenn/asyncapi-codegen version (devel) DO NOT EDIT.
Package "generated" 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 ...middleware.Middleware)
- func (c *AppController) Close(ctx context.Context)
- func (c *AppController) PublishPong(ctx context.Context, msg PongMessage) error
- func (c *AppController) SetLogger(logger log.Interface)
- func (c *AppController) SubscribeAll(ctx context.Context, as AppSubscriber) error
- func (c *AppController) SubscribePing(ctx context.Context, fn func(ctx context.Context, msg PingMessage, done bool)) error
- func (c *AppController) UnsubscribeAll(ctx context.Context)
- func (c *AppController) UnsubscribePing(ctx context.Context)
- type AppSubscriber
- type Error
- type MessageWithCorrelationID
- type PingMessage
- type PongMessage
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 broker.Controller) (*AppController, error)
NewAppController links the App to the broker
func (*AppController) AddMiddlewares ¶ added in v0.17.0
func (c *AppController) AddMiddlewares(middleware ...middleware.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) PublishPong ¶
func (c *AppController) PublishPong(ctx context.Context, msg PongMessage) error
PublishPong will publish messages to 'pong' channel
func (*AppController) SetLogger ¶ added in v0.15.0
func (c *AppController) SetLogger(logger log.Interface)
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) SubscribePing ¶
func (c *AppController) SubscribePing(ctx context.Context, fn func(ctx context.Context, msg PingMessage, done bool)) error
SubscribePing will subscribe to new messages from 'ping' 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) UnsubscribePing ¶
func (c *AppController) UnsubscribePing(ctx context.Context)
UnsubscribePing will unsubscribe messages from 'ping' channel
type AppSubscriber ¶
type AppSubscriber interface {
// Ping
Ping(ctx context.Context, msg PingMessage, done bool)
}
AppSubscriber represents all handlers that are expecting messages for App
type MessageWithCorrelationID ¶ added in v0.4.0
type MessageWithCorrelationID interface {
CorrelationID() string
}
type PingMessage ¶
type PingMessage struct {
// Headers will be used to fill the message headers
Headers struct {
// Description: Correlation ID set by client
CorrelationID *string `json:"correlation_id"`
}
// Payload will be inserted in the message payload
Payload string
}
PingMessage is the message expected for 'Ping' channel
func NewPingMessage ¶
func NewPingMessage() PingMessage
func (PingMessage) CorrelationID ¶ added in v0.4.0
func (msg PingMessage) CorrelationID() string
CorrelationID will give the correlation ID of the message, based on AsyncAPI spec
func (*PingMessage) SetAsResponseFrom ¶ added in v0.5.0
func (msg *PingMessage) SetAsResponseFrom(req MessageWithCorrelationID)
SetAsResponseFrom will correlate the message with the one passed in parameter. It will assign the 'req' message correlation ID to the message correlation ID, both specified in AsyncAPI spec.
type PongMessage ¶
type PongMessage struct {
// Headers will be used to fill the message headers
Headers struct {
// Description: Correlation ID set by client on corresponding request
CorrelationID *string `json:"correlation_id"`
}
// Payload will be inserted in the message payload
Payload struct {
// Description: Pong message
Message string `json:"message"`
// Description: Pong creation time
Time time.Time `json:"time"`
}
}
PongMessage is the message expected for 'Pong' channel
func NewPongMessage ¶
func NewPongMessage() PongMessage
func (PongMessage) CorrelationID ¶ added in v0.4.0
func (msg PongMessage) CorrelationID() string
CorrelationID will give the correlation ID of the message, based on AsyncAPI spec
func (*PongMessage) SetAsResponseFrom ¶ added in v0.5.0
func (msg *PongMessage) SetAsResponseFrom(req MessageWithCorrelationID)
SetAsResponseFrom will correlate the message with the one passed in parameter. It will assign the 'req' message correlation ID to the message correlation ID, both specified in AsyncAPI spec.
Source Files