issue181

Documentation

Overview

Package "issue181" 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) ReplyToGetServiceInfoOperation(ctx context.Context, recvMsg RequestMessage, ...) error
  • func (c *AppController) SendAsReplyToGetServiceInfoOperation(ctx context.Context, chanAddr string, msg ReplyMessageFromReplyChannel) error
  • func (c *AppController) SubscribeToAllChannels(ctx context.Context, as AppSubscriber) error
  • func (c *AppController) SubscribeToGetServiceInfoOperation(ctx context.Context, fn func(ctx context.Context, msg RequestMessage) error) error
  • func (c *AppController) UnsubscribeFromAllChannels(ctx context.Context)
  • func (c *AppController) UnsubscribeFromGetServiceInfoOperation(ctx context.Context)
• 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 HeadersFromRequestMessage
• type MessageWithCorrelationID
• type ReplyMessageFromReplyChannel
  • func NewReplyMessageFromReplyChannel() ReplyMessageFromReplyChannel
• type RequestMessage
  • func NewRequestMessage() RequestMessage
• type UserController
  • func NewUserController(bc extensions.BrokerController, options ...ControllerOption) (*UserController, error)
  • func (c *UserController) Close(ctx context.Context)
  • func (c *UserController) RequestToGetServiceInfoOperation(ctx context.Context, msg RequestMessage) (ReplyMessageFromReplyChannel, error)
  • func (c *UserController) SendToGetServiceInfoOperation(ctx context.Context, msg RequestMessage) error

Constants

const (
	// ReplyChannelPath is the constant representing the 'ReplyChannel' channel path.
	ReplyChannelPath = ""
	// RequestChannelPath is the constant representing the 'RequestChannel' channel path.
	RequestChannelPath = "v3.issue181.reception"
)

const AsyncAPIVersion = ""

AsyncAPIVersion is the version of the used AsyncAPI document

Variables

var ChannelsPaths = []string{
	ReplyChannelPath,
	RequestChannelPath,
}

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

func (c *AppController) ReplyToGetServiceInfoOperation(ctx context.Context, recvMsg RequestMessage, fn func(replyMsg *ReplyMessageFromReplyChannel)) error

ReplyToGetServiceInfoOperation is a helper function to reply to a Request message with a ReplyMessageFromReplyChannel message on Reply channel.

func (*AppController) SendAsReplyToGetServiceInfoOperation

func (c *AppController) SendAsReplyToGetServiceInfoOperation(
	ctx context.Context,
	chanAddr string,
	msg ReplyMessageFromReplyChannel,
) error

SendAsReplyToGetServiceInfoOperation will send a ReplyMessageFromReplyChannel message on Reply 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 (*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) SubscribeToGetServiceInfoOperation

func (c *AppController) SubscribeToGetServiceInfoOperation(
	ctx context.Context,
	fn func(ctx context.Context, msg RequestMessage) error,
) error

SubscribeToGetServiceInfoOperation will receive Request messages from Request 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) UnsubscribeFromGetServiceInfoOperation

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

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

type AppSubscriber

type AppSubscriber interface {
	// GetServiceInfoOperationReceived receive all Request messages from Request channel.
	GetServiceInfoOperationReceived(ctx context.Context, msg RequestMessage) 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 HeadersFromRequestMessage

type HeadersFromRequestMessage struct {
	// Description: Channel used to respond to request
	ReplyTo string `json:"replyTo" validate:"required"`
}

HeadersFromRequestMessage is a schema from the AsyncAPI specification required in messages

type MessageWithCorrelationID

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

type ReplyMessageFromReplyChannel

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

ReplyMessageFromReplyChannel is the message expected for 'ReplyMessageFromReplyChannel' channel.

func NewReplyMessageFromReplyChannel

func NewReplyMessageFromReplyChannel() ReplyMessageFromReplyChannel

type RequestMessage

type RequestMessage struct {
	// Headers will be used to fill the message headers
	Headers HeadersFromRequestMessage

	// Payload will be inserted in the message payload
	Payload string
}

RequestMessage is the message expected for 'RequestMessage' channel.

func NewRequestMessage

func NewRequestMessage() RequestMessage

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

func (c *UserController) RequestToGetServiceInfoOperation(
	ctx context.Context,
	msg RequestMessage,
) (ReplyMessageFromReplyChannel, error)

func (*UserController) SendToGetServiceInfoOperation

func (c *UserController) SendToGetServiceInfoOperation(
	ctx context.Context,
	msg RequestMessage,
) error

SendToGetServiceInfoOperation will send a Request message on Request channel.

NOTE: this won't wait for reply, use the normal version to get the reply or do the catching reply manually. NOTE: for now, this only support the first message from AsyncAPI list. If you need support for other messages, please raise an issue.