issue145

Documentation

Overview

Package "issue145" 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) PublishPongOnPongChannel(ctx context.Context, chanAddr string, msg PongMessage) error
  • func (c *AppController) ReplyToPingWithPongOnPongChannel(ctx context.Context, recvMsg PingMessage, fn func(replyMsg *PongMessage)) error
  • func (c *AppController) SubscribeToAllChannels(ctx context.Context, as AppSubscriber) error
  • func (c *AppController) SubscribeToPingFromPingChannel(ctx context.Context, fn func(ctx context.Context, msg PingMessage)) error
  • func (c *AppController) UnsubscribeFromAllChannels(ctx context.Context)
  • func (c *AppController) UnsubscribeFromPingFromPingChannel(ctx context.Context)
• type AppSubscriber
• type ControllerOption
  • func WithLogger(logger extensions.Logger) ControllerOption
  • func WithMiddlewares(middlewares ...extensions.Middleware) ControllerOption
• type Error
  • func (e *Error) Error() string
• type MessageWithCorrelationID
• type PingMessage
  • func NewPingMessage() PingMessage
• type PongMessage
  • func NewPongMessage() PongMessage
• type UserController
  • func NewUserController(bc extensions.BrokerController, options ...ControllerOption) (*UserController, error)
  • func (c *UserController) Close(ctx context.Context)
  • func (c *UserController) PublishPingOnPingChannel(ctx context.Context, msg PingMessage) error
  • func (c *UserController) RequestPongOnPongChannelWithPingOnPingChannel(ctx context.Context, msg PingMessage) (PongMessage, error)

Constants

const (
	// PingChannelPath is the constant representing the 'PingChannel' channel path.
	PingChannelPath = "ping"
	// PongChannelPath is the constant representing the 'PongChannel' channel path.
	PongChannelPath = ""
)

const AsyncAPIVersion = "1.0.0"

AsyncAPIVersion is the version of the used AsyncAPI document

Variables

var ChannelsPaths = []string{
	PingChannelPath,
	PongChannelPath,
}

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

func (c *AppController) PublishPongOnPongChannel(
	ctx context.Context,
	chanAddr string,
	msg PongMessage,
) error

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

func (c *AppController) ReplyToPingWithPongOnPongChannel(ctx context.Context, recvMsg PingMessage, fn func(replyMsg *PongMessage)) error

ReplyToPingWithPongOnPongChannel is a helper function to reply to a Ping message with a Pong message on Pong channel.

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

func (c *AppController) SubscribeToPingFromPingChannel(ctx context.Context, fn func(ctx context.Context, msg PingMessage)) error

SubscribeToPingFromPingChannel will receive Ping messages from Ping 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) UnsubscribeFromPingFromPingChannel

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

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

type AppSubscriber

type AppSubscriber interface {
	// PingReceivedFromPingChannel receive all Ping messages from Ping channel.
	PingReceivedFromPingChannel(ctx context.Context, msg PingMessage)
}

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 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 PingMessage

type PingMessage struct {
	// Headers will be used to fill the message headers
	Headers struct {
		// Description: Provide path to which reply must be provided
		ReplyTo *string `json:"reply_to"`

		// Description: Provide request id that you will use to identify the reply match
		RequestId *string `json:"request_id"`
	}

	// Payload will be inserted in the message payload
	Payload struct {
		Event *string `json:"event"`
	}
}

PingMessage is the golang representation of the AsyncAPI message

func NewPingMessage

func NewPingMessage() PingMessage

type PongMessage

type PongMessage struct {
	// Headers will be used to fill the message headers
	Headers struct {
		// Description: Reply message must contain id of the request message
		RequestId *string `json:"request_id"`
	}

	// Payload will be inserted in the message payload
	Payload struct {
		Event *string `json:"event"`
	}
}

PongMessage is the golang representation of the AsyncAPI message

func NewPongMessage

func NewPongMessage() PongMessage

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

func (c *UserController) PublishPingOnPingChannel(
	ctx context.Context,
	msg PingMessage,
) error

PublishPingOnPingChannel will send a Ping message on Ping 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.

func (*UserController) RequestPongOnPongChannelWithPingOnPingChannel

func (c *UserController) RequestPongOnPongChannelWithPingOnPingChannel(
	ctx context.Context,
	msg PingMessage,
) (PongMessage, error)