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 BrokerController
• type ClientController
  • func NewClientController(bs BrokerController) (*ClientController, error)
  • func (c *ClientController) Close()
  • func (c ClientController) Errors() <-chan Error
  • func (c *ClientController) Listen(irq <-chan interface{})
  • func (c *ClientController) PublishPing(msg PingMessage) error
  • func (c *ClientController) SubscribeAll(as ClientSubscriber) error
  • func (c *ClientController) SubscribePong(fn func(msg PongMessage)) error
  • func (c *ClientController) UnsubscribeAll()
  • func (c *ClientController) UnsubscribePong()
  • func (cc *ClientController) WaitForPong(correlationID string, pub func() error, timeout time.Duration) (PongMessage, error)
• type ClientSubscriber
• 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 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 ClientController

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

ClientController is the structure that provides publishing capabilities to the developer and and connect the broker with the Client

func NewClientController

func NewClientController(bs BrokerController) (*ClientController, error)

NewClientController links the Client to the broker

func (*ClientController) Close

func (c *ClientController) Close()

Close will clean up any existing resources on the controller

func (ClientController) Errors

func (c ClientController) 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 (*ClientController) Listen

func (c *ClientController) 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 (*ClientController) PublishPing

func (c *ClientController) PublishPing(msg PingMessage) error

PublishPing will publish messages to 'ping' channel

func (*ClientController) SubscribeAll

func (c *ClientController) SubscribeAll(as ClientSubscriber) error

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

func (*ClientController) SubscribePong

func (c *ClientController) SubscribePong(fn func(msg PongMessage)) error

SubscribePong will subscribe to new messages from 'pong' channel

func (*ClientController) UnsubscribeAll

func (c *ClientController) UnsubscribeAll()

UnsubscribeAll will unsubscribe all remaining subscribed channels

func (*ClientController) UnsubscribePong

func (c *ClientController) UnsubscribePong()

UnsubscribePong will unsubscribe messages from 'pong' channel

func (*ClientController) WaitForPong

func (cc *ClientController) WaitForPong(correlationID string, pub func() error, timeout time.Duration) (PongMessage, error)

WaitForPong will wait for a specific message by its correlation ID

The pub function is the publication function that should be used to send the message It will be called after subscribing to the channel to avoid race condition, and potentially loose the message

type ClientSubscriber

type ClientSubscriber interface {
	// Pong
	Pong(msg PongMessage)
}

ClientSubscriber represents all handlers that are expecting messages for 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 {
		// CorrelationID is 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 {
		// CorrelationID is 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