issue49

package
v0.45.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 26, 2024 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Overview

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

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

Index

Constants

View Source 
const (
	// V2Issue49ChatPath is the constant representing the 'V2Issue49Chat' channel path.
	V2Issue49ChatPath = "v2.issue49.chat"
	// V2Issue49StatusPath is the constant representing the 'V2Issue49Status' channel path.
	V2Issue49StatusPath = "v2.issue49.status"
)
View Source 
const AsyncAPIVersion = "1.0.0"

AsyncAPIVersion is the version of the used AsyncAPI document

Variables

View Source 
var ChannelsPaths = []string{
	V2Issue49ChatPath,
	V2Issue49StatusPath,
}

ChannelsPaths is an array of all channels paths

Functions

This section is empty.

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(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) PublishV2Issue49Chat added in v0.35.2 

func (c *AppController) PublishV2Issue49Chat(
	ctx context.Context,
	msg V2Issue49ChatPublishMessage,
) error

PublishV2Issue49Chat will publish messages to 'v2.issue49.chat' channel

func (*AppController) PublishV2Issue49Status added in v0.35.2 

func (c *AppController) PublishV2Issue49Status(
	ctx context.Context,
	msg V2Issue49StatusMessage,
) error

PublishV2Issue49Status will publish messages to 'v2.issue49.status' channel

func (*AppController) SubscribeAll 

func (c *AppController) SubscribeAll(ctx context.Context, as AppSubscriber) 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 (*AppController) SubscribeV2Issue49Chat added in v0.35.2 

func (c *AppController) SubscribeV2Issue49Chat(
	ctx context.Context,
	fn func(ctx context.Context, msg V2Issue49ChatSubscribeMessage) error,
) error

SubscribeV2Issue49Chat will subscribe to new messages from 'v2.issue49.chat' channel.

Callback function 'fn' will be called each time a new message is received.

func (*AppController) UnsubscribeAll 

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

UnsubscribeAll will unsubscribe all remaining subscribed channels

func (*AppController) UnsubscribeV2Issue49Chat added in v0.35.2 

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

UnsubscribeV2Issue49Chat will unsubscribe messages from 'v2.issue49.chat' channel. A timeout can be set in context to avoid blocking operation, if needed.

type AppSubscriber 

type AppSubscriber interface {
	// V2Issue49Chat subscribes to messages placed on the 'v2.issue49.chat' channel
	V2Issue49Chat(ctx context.Context, msg V2Issue49ChatSubscribeMessage) error
}

AppSubscriber represents all handlers that are expecting 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 added in v0.35.0 

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 MessageWithCorrelationID 

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

type UserController 

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

UserController is the structure that provides publishing 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) PublishV2Issue49Chat added in v0.35.2 

func (c *UserController) PublishV2Issue49Chat(
	ctx context.Context,
	msg V2Issue49ChatPublishMessage,
) error

PublishV2Issue49Chat will publish messages to 'v2.issue49.chat' channel

func (*UserController) SubscribeAll 

func (c *UserController) SubscribeAll(ctx context.Context, as UserSubscriber) 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 (*UserController) SubscribeV2Issue49Chat added in v0.35.2 

func (c *UserController) SubscribeV2Issue49Chat(
	ctx context.Context,
	fn func(ctx context.Context, msg V2Issue49ChatSubscribeMessage) error,
) error

SubscribeV2Issue49Chat will subscribe to new messages from 'v2.issue49.chat' channel.

Callback function 'fn' will be called each time a new message is received.

func (*UserController) SubscribeV2Issue49Status added in v0.35.2 

func (c *UserController) SubscribeV2Issue49Status(
	ctx context.Context,
	fn func(ctx context.Context, msg V2Issue49StatusMessage) error,
) error

SubscribeV2Issue49Status will subscribe to new messages from 'v2.issue49.status' channel.

Callback function 'fn' will be called each time a new message is received.

func (*UserController) UnsubscribeAll 

func (c *UserController) UnsubscribeAll(ctx context.Context)

UnsubscribeAll will unsubscribe all remaining subscribed channels

func (*UserController) UnsubscribeV2Issue49Chat added in v0.35.2 

func (c *UserController) UnsubscribeV2Issue49Chat(ctx context.Context)

UnsubscribeV2Issue49Chat will unsubscribe messages from 'v2.issue49.chat' channel. A timeout can be set in context to avoid blocking operation, if needed.

func (*UserController) UnsubscribeV2Issue49Status added in v0.35.2 

func (c *UserController) UnsubscribeV2Issue49Status(ctx context.Context)

UnsubscribeV2Issue49Status will unsubscribe messages from 'v2.issue49.status' channel. A timeout can be set in context to avoid blocking operation, if needed.

type UserSubscriber 

type UserSubscriber interface {
	// V2Issue49Chat subscribes to messages placed on the 'v2.issue49.chat' channel
	V2Issue49Chat(ctx context.Context, msg V2Issue49ChatSubscribeMessage) error

	// V2Issue49Status subscribes to messages placed on the 'v2.issue49.status' channel
	V2Issue49Status(ctx context.Context, msg V2Issue49StatusMessage) error
}

UserSubscriber represents all handlers that are expecting messages for User

type V2Issue49ChatPublishMessage added in v0.35.2 

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

V2Issue49ChatPublishMessage is the message expected for 'V2Issue49ChatPublishMessage' channel.

func NewV2Issue49ChatPublishMessage added in v0.35.2 

func NewV2Issue49ChatPublishMessage() V2Issue49ChatPublishMessage

type V2Issue49ChatSubscribeMessage added in v0.35.2 

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

V2Issue49ChatSubscribeMessage is the message expected for 'V2Issue49ChatSubscribeMessage' channel.

func NewV2Issue49ChatSubscribeMessage added in v0.35.2 

func NewV2Issue49ChatSubscribeMessage() V2Issue49ChatSubscribeMessage

type V2Issue49StatusMessage added in v0.35.2 

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

V2Issue49StatusMessage is the message expected for 'V2Issue49StatusMessage' channel.

func NewV2Issue49StatusMessage added in v0.35.2 

func NewV2Issue49StatusMessage() V2Issue49StatusMessage

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.