simple

Documentation

Overview

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

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

Index

• Constants
• Variables
• type AppController
  • func NewAppController(bs BrokerController) (*AppController, error)
  • func (c *AppController) AttachLogger(logger Logger)
  • func (c *AppController) Close()
  • func (c *AppController) PublishUserSignedup(msg UserSignedUpMessage) error
• type BrokerController
• type ClientController
  • func NewClientController(bs BrokerController) (*ClientController, error)
  • func (c *ClientController) AttachLogger(logger Logger)
  • func (c *ClientController) Close()
  • func (c *ClientController) SubscribeAll(as ClientSubscriber) error
  • func (c *ClientController) SubscribeUserSignedup(fn func(msg UserSignedUpMessage, done bool)) error
  • func (c *ClientController) UnsubscribeAll()
  • func (c *ClientController) UnsubscribeUserSignedup()
• type ClientSubscriber
• type Error
  • func (e *Error) Error() string
• type Logger
• type MessageWithCorrelationID
• type UniversalMessage
• type UserSignedUpMessage
  • func NewUserSignedUpMessage() UserSignedUpMessage

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

	// ErrContextCanceled is given when a given context is canceled
	ErrContextCanceled = fmt.Errorf("%w: context canceled", 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)

	// ErrSubscriptionCanceled is raised when expecting something and the subscription has been canceled before it happens
	ErrSubscriptionCanceled = fmt.Errorf("%w: the subscription has been canceled", 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 App to the broker

func (*AppController) AttachLogger

func (c *AppController) AttachLogger(logger Logger)

AttachLogger attaches a logger that will log operations on controller

func (*AppController) Close

func (c *AppController) Close()

Close will clean up any existing resources on the controller

func (*AppController) PublishUserSignedup

func (c *AppController) PublishUserSignedup(msg UserSignedUpMessage) error

PublishUserSignedup will publish messages to 'user/signedup' channel

type BrokerController

type BrokerController interface {
	// AttachLogger attaches a logger that will log operations on broker controller
	AttachLogger(logger Logger)

	// 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) AttachLogger

func (c *ClientController) AttachLogger(logger Logger)

AttachLogger attaches a logger that will log operations on controller

func (*ClientController) Close

func (c *ClientController) Close()

Close will clean up any existing resources on the controller

func (*ClientController) SubscribeAll

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

SubscribeAll will subscribe to channels without parameters on which the app is expecting messages. For channels with parameters, they should be subscribed independently.

func (*ClientController) SubscribeUserSignedup

func (c *ClientController) SubscribeUserSignedup(fn func(msg UserSignedUpMessage, done bool)) error

SubscribeUserSignedup will subscribe to new messages from 'user/signedup' channel.

Callback function 'fn' will be called each time a new message is received. The 'done' argument indicates when the subscription is canceled and can be used to clean up resources.

func (*ClientController) UnsubscribeAll

func (c *ClientController) UnsubscribeAll()

UnsubscribeAll will unsubscribe all remaining subscribed channels

func (*ClientController) UnsubscribeUserSignedup

func (c *ClientController) UnsubscribeUserSignedup()

UnsubscribeUserSignedup will unsubscribe messages from 'user/signedup' channel

type ClientSubscriber

type ClientSubscriber interface {
	// UserSignedup
	UserSignedup(msg UserSignedUpMessage, done bool)
}

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 Logger

type Logger interface {
	// Info logs information based on a message and key-value elements
	Info(msg string, keyvals ...interface{})

	// Error logs error based on a message and key-value elements
	Error(msg string, keyvals ...interface{})
}

type MessageWithCorrelationID

type MessageWithCorrelationID interface {
	CorrelationID() string
}

type UniversalMessage

type UniversalMessage struct {
	CorrelationID *string
	Payload       []byte
}

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

type UserSignedUpMessage

type UserSignedUpMessage struct {
	// Payload will be inserted in the message payload
	Payload struct {
		// Description: Name of the user
		DisplayName *string `json:"display_name"`

		// Description: Email of the user
		Email *string `json:"email"`
	}
}

UserSignedUpMessage is the message expected for 'UserSignedUp' channel

func NewUserSignedUpMessage

func NewUserSignedUpMessage() UserSignedUpMessage