parameters

Documentation

Overview

Package "parameters" provides primitives to interact with the AsyncAPI specification.

Code generated by github.com/lerenn/asyncapi-codegen version (devel) DO NOT EDIT.

Index

• Constants
• Variables
• type AppController
  • func NewAppController(bc extensions.BrokerController, options ...ControllerOption) (*AppController, error)
  • func (c *AppController) Close(ctx context.Context)
  • func (c *AppController) SubscribeToAllChannels(ctx context.Context, as AppSubscriber) error
  • func (c *AppController) SubscribeToReceiveUserSignedUpOperation(ctx context.Context, params UserSignupChannelParameters, ...) error
  • func (c *AppController) UnsubscribeFromAllChannels(ctx context.Context)
  • func (c *AppController) UnsubscribeFromReceiveUserSignedUpOperation(ctx context.Context, params UserSignupChannelParameters)
• type AppSubscriber
• type ControllerOption
  • func WithErrorHandler(handler extensions.ErrorHandler) ControllerOption
  • func WithLogger(logger extensions.Logger) ControllerOption
  • func WithMiddlewares(middlewares ...extensions.Middleware) ControllerOption
• type Error
  • func (e *Error) Error() string
• type MessageWithCorrelationID
• type Suite
  • func NewSuite(broker extensions.BrokerController) *Suite
  • func (suite *Suite) SetupTest()
  • func (suite *Suite) TearDownTest()
  • func (suite *Suite) TestParameter()
• type UserController
  • func NewUserController(bc extensions.BrokerController, options ...ControllerOption) (*UserController, error)
  • func (c *UserController) Close(ctx context.Context)
  • func (c *UserController) SendToReceiveUserSignedUpOperation(ctx context.Context, params UserSignupChannelParameters, ...) error
• type UserMessageFromUserSignupChannel
  • func NewUserMessageFromUserSignupChannel() UserMessageFromUserSignupChannel
• type UserMessageFromUserSignupChannelPayload
• type UserSignupChannelParameters

Constants

const AsyncAPIVersion = ""

AsyncAPIVersion is the version of the used AsyncAPI document

const (
	// UserSignupChannelPath is the constant representing the 'UserSignupChannel' channel path.
	UserSignupChannelPath = "v3.issue130.user.{userId}.signedup"
)

Variables

var ChannelsPaths = []string{
	UserSignupChannelPath,
}

ChannelsPaths is an array of all channels paths

Types

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) SubscribeToReceiveUserSignedUpOperation

func (c *AppController) SubscribeToReceiveUserSignedUpOperation(
	ctx context.Context,
	params UserSignupChannelParameters,
	fn func(ctx context.Context, msg UserMessageFromUserSignupChannel) error,
) error

SubscribeToReceiveUserSignedUpOperation will receive UserMessageFromUserSignupChannel messages from UserSignup 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) UnsubscribeFromAllChannels

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

UnsubscribeFromAllChannels will stop the subscription of all remaining subscribed channels

func (*AppController) UnsubscribeFromReceiveUserSignedUpOperation

func (c *AppController) UnsubscribeFromReceiveUserSignedUpOperation(
	ctx context.Context,
	params UserSignupChannelParameters,
)

A timeout can be set in context to avoid blocking operation, if needed.

type AppSubscriber

type AppSubscriber interface {
	// ReceiveUserSignedUpOperationReceived receive all UserMessageFromUserSignupChannel messages from UserSignup channel.
	ReceiveUserSignedUpOperationReceived(ctx context.Context, msg UserMessageFromUserSignupChannel) 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 Suite

type Suite struct {
	suite.Suite
	// contains filtered or unexported fields
}

func NewSuite

func NewSuite(broker extensions.BrokerController) *Suite

func (*Suite) SetupTest

func (suite *Suite) SetupTest()

func (*Suite) TearDownTest

func (suite *Suite) TearDownTest()

func (*Suite) TestParameter

func (suite *Suite) TestParameter()

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) SendToReceiveUserSignedUpOperation

func (c *UserController) SendToReceiveUserSignedUpOperation(
	ctx context.Context,
	params UserSignupChannelParameters,
	msg UserMessageFromUserSignupChannel,
) error

SendToReceiveUserSignedUpOperation will send a UserMessageFromUserSignupChannel message on UserSignup channel.

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

type UserMessageFromUserSignupChannel

type UserMessageFromUserSignupChannel struct {
	// Payload will be inserted in the message payload
	Payload UserMessageFromUserSignupChannelPayload
}

UserMessageFromUserSignupChannel is the message expected for 'UserMessageFromUserSignupChannel' channel.

func NewUserMessageFromUserSignupChannel

func NewUserMessageFromUserSignupChannel() UserMessageFromUserSignupChannel

type UserMessageFromUserSignupChannelPayload

type UserMessageFromUserSignupChannelPayload struct {
	Name *string `json:"name"`
}

UserMessageFromUserSignupChannelPayload is a schema from the AsyncAPI specification required in messages

type UserSignupChannelParameters

type UserSignupChannelParameters struct {
	// UserId is a channel parameter: Id of the user.
	UserId string
}

UserSignupChannelParameters represents UserSignupChannel channel parameters