generated

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.

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

• Constants
• Variables
• type AppController
  • func NewAppController(bs BrokerController) (*AppController, error)
  • func (ac *AppController) Close()
  • func (ac AppController) Errors() <-chan Error
  • func (ac *AppController) Listen(irq <-chan interface{})
  • func (ac *AppController) PublishPong(msg PongMessage) error
  • func (ac *AppController) SubscribeAll(as AppSubscriber) error
  • func (ac *AppController) SubscribePing(fn func(msg PingMessage)) error
  • func (ac *AppController) UnsubscribeAll()
  • func (ac *AppController) UnsubscribePing()
• type AppSubscriber
• type Book
• type BrokerController
• type Error
  • func (e *Error) Error() string
• type NATSController
  • func NewNATSController(connection *nats.Conn) *NATSController
  • func (c *NATSController) Publish(channel string, um UniversalMessage) error
  • func (c *NATSController) Subscribe(channel string) (msgs chan UniversalMessage, stop chan interface{}, err error)
• type PingMessage
  • func NewPingMessage() PingMessage
• type PongMessage
  • func NewPongMessage() PongMessage
• type UniversalMessage

Constants

const (
	// CorrelationIDField is the name of the field that will contain the correlation ID
	CorrelationIDField = "correlation_id"
)

Variables

var (
	// Generic error for AsyncAPI generated code
	ErrAsyncAPI = errors.New("error when using AsyncAPI")

	// ErrTimedOut is given when any timeout happen
	ErrTimedOut = fmt.Errorf("%w: time out", 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)
)

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(bs BrokerController) (*AppController, error)

NewAppController links the application to the broker

func (*AppController) Close

func (ac *AppController) Close()

Close will clean up any existing resources on the controller

func (AppController) Errors

func (ac AppController) Errors() <-chan Error

Errors will give back the channel that contains errors and that you can listen to handle errors Please take a look at Error struct form information on error

func (*AppController) Listen

func (ac *AppController) Listen(irq <-chan interface{})

Listen will let the controller handle subscriptions and will be interrupted only when an struct is sent on the interrupt channel

func (*AppController) PublishPong

func (ac *AppController) PublishPong(msg PongMessage) error

PublishPong will publish messages to 'pong' channel

func (*AppController) SubscribeAll

func (ac *AppController) SubscribeAll(as AppSubscriber) error

SubscribeAll will subscribe to channels on which the app is expecting messages

func (*AppController) SubscribePing

func (ac *AppController) SubscribePing(fn func(msg PingMessage)) error

SubscribePing will subscribe to new messages from 'ping' channel

func (*AppController) UnsubscribeAll

func (ac *AppController) UnsubscribeAll()

UnsubscribeAll will unsubscribe all remaining subscribed channels

func (*AppController) UnsubscribePing

func (ac *AppController) UnsubscribePing()

UnsubscribePing will unsubscribe messages from 'ping' channel

type AppSubscriber

type AppSubscriber interface {
	// Ping
	Ping(msg PingMessage)
}

AppSubscriber represents all application handlers that are expecting messages from clients

type Book

type Book struct {
	// Title
	Title string `json:"title"`
}

Book is a component of the AsyncAPI specification required in messages Book Information

type BrokerController

type BrokerController interface {
	// Publish a message to the broker
	Publish(channel string, mw UniversalMessage) error

	// Subscribe to messages from the broker
	Subscribe(channel string) (msgs chan UniversalMessage, stop chan interface{}, err error)
}

BrokerController represents the functions that should be implemented to connect the broker to the application or the client

type Error

type Error struct {
	Channel string
	Err     error
}

func (*Error) Error

func (e *Error) Error() string

type NATSController

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

NATSController is the NATS implementation for asyncapi-codegen

func NewNATSController

func NewNATSController(connection *nats.Conn) *NATSController

NewNATSController creates a new NATSController that fulfill the BrokerLinker interface

func (*NATSController) Publish

func (c *NATSController) Publish(channel string, um UniversalMessage) error

Publish a message to the broker

func (*NATSController) Subscribe

func (c *NATSController) Subscribe(channel string) (msgs chan UniversalMessage, stop chan interface{}, err error)

Subscribe to messages from the broker

type PingMessage

type PingMessage struct {
	// Headers will be used to fill the message headers
	Headers struct {
		// 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

type PongMessage

type PongMessage struct {
	// Headers will be used to fill the message headers
	Headers struct {
		// Correlation ID set by client on corresponding request
		CorrelationID string `json:"correlation_id"`
	}

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

PongMessage is the message expected for 'Pong' channel

func NewPongMessage

func NewPongMessage() PongMessage

type UniversalMessage

type UniversalMessage struct {
	CorrelationID string
	Payload       []byte
}

UniversalMessage is a wrapper that will contain all information regarding a message