rpcServer

Documentation

Overview

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

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

Index

• Variables
• type AppController
  • func NewAppController(bc extensions.BrokerController) (*AppController, error)
  • func (c *AppController) AddMiddlewares(middleware ...extensions.Middleware)
  • func (c *AppController) Close(ctx context.Context)
  • func (c *AppController) PublishQueue(ctx context.Context, params QueueParameters, msg QueueMessage) error
  • func (c *AppController) SetLogger(logger extensions.Logger)
  • func (c *AppController) SubscribeAll(ctx context.Context, as AppSubscriber) error
  • func (c *AppController) SubscribeRpcQueue(ctx context.Context, ...) error
  • func (c *AppController) UnsubscribeAll(ctx context.Context)
  • func (c *AppController) UnsubscribeRpcQueue(ctx context.Context)
• type AppSubscriber
• type ClientController
  • func NewClientController(bc extensions.BrokerController) (*ClientController, error)
  • func (c *ClientController) AddMiddlewares(middleware ...extensions.Middleware)
  • func (c *ClientController) Close(ctx context.Context)
  • func (c *ClientController) PublishRpcQueue(ctx context.Context, msg RpcQueueMessage) error
  • func (c *ClientController) SetLogger(logger extensions.Logger)
  • func (c *ClientController) SubscribeAll(ctx context.Context, as ClientSubscriber) error
  • func (c *ClientController) SubscribeQueue(ctx context.Context, params QueueParameters, ...) error
  • func (c *ClientController) UnsubscribeAll(ctx context.Context)
  • func (c *ClientController) UnsubscribeQueue(ctx context.Context, params QueueParameters)
  • func (cc *ClientController) WaitForQueue(ctx context.Context, params QueueParameters, ...) (QueueMessage, error)
• type ClientSubscriber
• type Error
  • func (e *Error) Error() string
• type MessageWithCorrelationID
• type QueueMessage
  • func NewQueueMessage() QueueMessage
  • func (msg QueueMessage) CorrelationID() string
  • func (msg *QueueMessage) SetAsResponseFrom(req MessageWithCorrelationID)
  • func (msg *QueueMessage) SetCorrelationID(id string)
• type QueueParameters
• type RpcQueueMessage
  • func NewRpcQueueMessage() RpcQueueMessage
  • func (msg RpcQueueMessage) CorrelationID() string
  • func (msg *RpcQueueMessage) SetAsResponseFrom(req MessageWithCorrelationID)
  • func (msg *RpcQueueMessage) SetCorrelationID(id string)

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(bc extensions.BrokerController) (*AppController, error)

NewAppController links the App to the broker

func (*AppController) AddMiddlewares

func (c *AppController) AddMiddlewares(middleware ...extensions.Middleware)

AddMiddlewares attaches middlewares that will be executed when sending or receiving messages

func (*AppController) Close

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

Close will clean up any existing resources on the controller

func (*AppController) PublishQueue

func (c *AppController) PublishQueue(ctx context.Context, params QueueParameters, msg QueueMessage) error

PublishQueue will publish messages to '{queue}' channel

func (*AppController) SetLogger

func (c *AppController) SetLogger(logger extensions.Logger)

SetLogger attaches a logger that will log operations on controller

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

func (c *AppController) SubscribeRpcQueue(ctx context.Context, fn func(ctx context.Context, msg RpcQueueMessage, done bool)) error

SubscribeRpcQueue will subscribe to new messages from 'rpc_queue' 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 (*AppController) UnsubscribeAll

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

UnsubscribeAll will unsubscribe all remaining subscribed channels

func (*AppController) UnsubscribeRpcQueue

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

UnsubscribeRpcQueue will unsubscribe messages from 'rpc_queue' channel

type AppSubscriber

type AppSubscriber interface {
	// RpcQueue
	RpcQueue(ctx context.Context, msg RpcQueueMessage, done bool)
}

AppSubscriber represents all handlers that are expecting messages for App

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(bc extensions.BrokerController) (*ClientController, error)

NewClientController links the Client to the broker

func (*ClientController) AddMiddlewares

func (c *ClientController) AddMiddlewares(middleware ...extensions.Middleware)

AddMiddlewares attaches middlewares that will be executed when sending or receiving messages

func (*ClientController) Close

func (c *ClientController) Close(ctx context.Context)

Close will clean up any existing resources on the controller

func (*ClientController) PublishRpcQueue

func (c *ClientController) PublishRpcQueue(ctx context.Context, msg RpcQueueMessage) error

PublishRpcQueue will publish messages to 'rpc_queue' channel

func (*ClientController) SetLogger

func (c *ClientController) SetLogger(logger extensions.Logger)

SetLogger attaches a logger that will log operations on controller

func (*ClientController) SubscribeAll

func (c *ClientController) SubscribeAll(ctx context.Context, 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) SubscribeQueue

func (c *ClientController) SubscribeQueue(ctx context.Context, params QueueParameters, fn func(ctx context.Context, msg QueueMessage, done bool)) error

SubscribeQueue will subscribe to new messages from '{queue}' 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(ctx context.Context)

UnsubscribeAll will unsubscribe all remaining subscribed channels

func (*ClientController) UnsubscribeQueue

func (c *ClientController) UnsubscribeQueue(ctx context.Context, params QueueParameters)

UnsubscribeQueue will unsubscribe messages from '{queue}' channel

func (*ClientController) WaitForQueue

func (cc *ClientController) WaitForQueue(ctx context.Context, params QueueParameters, publishMsg MessageWithCorrelationID, pub func(ctx context.Context) error) (QueueMessage, error)

WaitForQueue 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 {
	// Queue
	Queue(ctx context.Context, msg QueueMessage, 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 MessageWithCorrelationID

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

type QueueMessage

type QueueMessage struct {
	// Headers will be used to fill the message headers
	Headers struct {
		CorrelationID *string `json:"correlation_id"`
	}

	// Payload will be inserted in the message payload
	Payload struct {
		Result *float64 `json:"result"`
	}
}

QueueMessage is the message expected for 'Queue' channel

func NewQueueMessage

func NewQueueMessage() QueueMessage

func (QueueMessage) CorrelationID

func (msg QueueMessage) CorrelationID() string

CorrelationID will give the correlation ID of the message, based on AsyncAPI spec

func (*QueueMessage) SetAsResponseFrom

func (msg *QueueMessage) SetAsResponseFrom(req MessageWithCorrelationID)

SetAsResponseFrom will correlate the message with the one passed in parameter. It will assign the 'req' message correlation ID to the message correlation ID, both specified in AsyncAPI spec.

func (*QueueMessage) SetCorrelationID

func (msg *QueueMessage) SetCorrelationID(id string)

SetCorrelationID will set the correlation ID of the message, based on AsyncAPI spec

type QueueParameters

type QueueParameters struct {
	Queue string
}

QueueParameters represents Queue channel parameters

type RpcQueueMessage

type RpcQueueMessage struct {
	// Headers will be used to fill the message headers
	Headers struct {
		CorrelationID *string `json:"correlation_id"`
	}

	// Payload will be inserted in the message payload
	Payload struct {
		Numbers []float64 `json:"numbers"`
	}
}

RpcQueueMessage is the message expected for 'RpcQueue' channel

func NewRpcQueueMessage

func NewRpcQueueMessage() RpcQueueMessage

func (RpcQueueMessage) CorrelationID

func (msg RpcQueueMessage) CorrelationID() string

CorrelationID will give the correlation ID of the message, based on AsyncAPI spec

func (*RpcQueueMessage) SetAsResponseFrom

func (msg *RpcQueueMessage) SetAsResponseFrom(req MessageWithCorrelationID)

SetAsResponseFrom will correlate the message with the one passed in parameter. It will assign the 'req' message correlation ID to the message correlation ID, both specified in AsyncAPI spec.

func (*RpcQueueMessage) SetCorrelationID

func (msg *RpcQueueMessage) SetCorrelationID(id string)

SetCorrelationID will set the correlation ID of the message, based on AsyncAPI spec