issue186

package
v0.0.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 1, 2026 License: Apache-2.0 Imports: 3 Imported by: 0

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

View Source 
const (
	// AngleChannelPath is the constant representing the 'AngleChannel' channel path.
	AngleChannelPath = "v2.issue186.angle.>"
	// StarChannelPath is the constant representing the 'StarChannel' channel path.
	StarChannelPath = "v2.issue186.star.*.*"
)
View Source 
const AsyncAPIVersion = "1.2.3"

AsyncAPIVersion is the version of the used AsyncAPI document

Variables

View Source 
var ChannelsPaths = []string{
	AngleChannelPath,
	StarChannelPath,
}

ChannelsPaths is an array of all channels paths

Functions

This section is empty.

Types

type AngleMessage 

type AngleMessage struct {
	// Payload will be inserted in the message payload
	Payload string
}

AngleMessage is the message expected for 'AngleMessage' channel.

func NewAngleMessage 

func NewAngleMessage() AngleMessage

type AppController 

type AppController struct {
	// contains filtered or unexported fields
}

AppController is the structure that provides sending 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) SubscribeToAllChannels 

func (c *AppController) SubscribeToAllChannels(ctx context.Context, as AppSubscriber) error

SubscribeToAllChannels will receive messages from channels where channel has no parameter on which the app is expecting messages. For channels with parameters, they should be subscribed independently.

func (*AppController) SubscribeToAngleRequestOperation 

func (c *AppController) SubscribeToAngleRequestOperation(
	ctx context.Context,
	fn func(ctx context.Context, msg AngleMessage) error,
) error

SubscribeToAngleRequestOperation will receive Angle messages from Angle channel.

Callback function 'fn' will be called each time a new message is received.

NOTE: for now, this only support the first message from AsyncAPI list.

NOTE: for now, this only support the first message from AsyncAPI list. If you need support for other messages, please raise an issue.

func (*AppController) SubscribeToStarRequestOperation 

func (c *AppController) SubscribeToStarRequestOperation(
	ctx context.Context,
	fn func(ctx context.Context, msg StarMessage) error,
) error

Callback function 'fn' will be called each time a new message is received.

NOTE: for now, this only support the first message from AsyncAPI list.

NOTE: for now, this only support the first message from AsyncAPI list. If you need support for other messages, please raise an issue.

func (*AppController) UnsubscribeFromAllChannels 

func (c *AppController) UnsubscribeFromAllChannels(ctx context.Context)

UnsubscribeFromAllChannels will stop the subscription of all remaining subscribed channels

func (*AppController) UnsubscribeFromAngleRequestOperation 

func (c *AppController) UnsubscribeFromAngleRequestOperation(
	ctx context.Context,
)

UnsubscribeFromAngleRequestOperation will stop the reception of Angle messages from Angle channel. A timeout can be set in context to avoid blocking operation, if needed.

func (*AppController) UnsubscribeFromStarRequestOperation 

func (c *AppController) UnsubscribeFromStarRequestOperation(
	ctx context.Context,
)

UnsubscribeFromStarRequestOperation will stop the reception of Star messages from Star channel. A timeout can be set in context to avoid blocking operation, if needed.

type AppSubscriber 

type AppSubscriber interface {
	// AngleRequestOperationReceived receive all Angle messages from Angle channel.
	AngleRequestOperationReceived(ctx context.Context, msg AngleMessage) error

	// StarRequestOperationReceived receive all Star messages from Star channel.
	StarRequestOperationReceived(ctx context.Context, msg StarMessage) error
}

AppSubscriber contains all handlers that are listening 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 Error 

type Error struct {
	Channel string
	Err     error
}

func (*Error) Error 

func (e *Error) Error() string

type MessageWithCorrelationID 

type MessageWithCorrelationID interface {
	CorrelationID() string
	SetCorrelationID(id string)
}

type StarMessage 

type StarMessage struct {
	// Payload will be inserted in the message payload
	Payload string
}

StarMessage is the message expected for 'StarMessage' channel.

func NewStarMessage 

func NewStarMessage() StarMessage

type UserController 

type UserController struct {
	// contains filtered or unexported fields
}

UserController is the structure that provides sending 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) SendToAngleRequestOperation 

func (c *UserController) SendToAngleRequestOperation(
	ctx context.Context,
	msg AngleMessage,
) error

SendToAngleRequestOperation will send a Angle message on Angle channel.

NOTE: for now, this only support the first message from AsyncAPI list. If you need support for other messages, please raise an issue.

func (*UserController) SendToStarRequestOperation 

func (c *UserController) SendToStarRequestOperation(
	ctx context.Context,
	msg StarMessage,
) error

SendToStarRequestOperation will send a Star message on Star channel.

NOTE: for now, this only support the first message from AsyncAPI list. If you need support for other messages, please raise an issue.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.