messagingapi

package
v1.41.0 Latest Latest
Warning

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

Go to latest
Published: Jun 19, 2026 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source
const Description = `The Messaging microservice demonstrates service-to-service communication patterns.`

Description is the human-readable summary of the microservice, surfaced in OpenAPI and discovery.

View Source
const Hostname = "messaging.example"

Hostname is the default hostname of the microservice.

View Source
const Name = "Messaging"

Name is the decorative PascalCase name of the microservice.

View Source
const Version = 230

Version is a generation counter bumped on each regeneration, not a semantic version.

Variables

View Source
var CacheLoad = define.Web{
	Host: Hostname, Method: "GET", Route: "/cache-load",
}

CacheLoad looks up an element in the distributed cache of the microservice.

View Source
var CacheStore = define.Web{
	Host: Hostname, Method: "GET", Route: "/cache-store",
}

CacheStore stores an element in the distributed cache of the microservice.

View Source
var DefaultQueue = define.Web{
	Host: Hostname, Method: "GET", Route: "/default-queue",
}

DefaultQueue demonstrates how the DefaultQueue subscription option is used to create a unicast request/response communication pattern. Only one of the instances of this microservice will respond to each request.

View Source
var Home = define.Web{
	Host: Hostname, Method: "GET", Route: "/home",
}

Home demonstrates making requests using multicast and unicast request/response patterns.

View Source
var NoQueue = define.Web{
	Host: Hostname, Method: "GET", Route: "/no-queue",
	LoadBalancing: define.None,
}

NoQueue demonstrates how the NoQueue subscription option is used to create a multicast request/response communication pattern. All instances of this microservice will respond to each request.

Functions

This section is empty.

Types

type Client

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

Client is a lightweight proxy for making unicast calls to the microservice.

func NewClient

func NewClient(caller service.Publisher) Client

NewClient creates a new unicast client proxy to the microservice.

func (Client) CacheLoad

func (_c Client) CacheLoad(ctx context.Context, relativeURL string) (res *http.Response, err error)

CacheLoad looks up an element in the distributed cache of the microservice.

func (Client) CacheStore

func (_c Client) CacheStore(ctx context.Context, relativeURL string) (res *http.Response, err error)

CacheStore stores an element in the distributed cache of the microservice.

func (Client) DefaultQueue

func (_c Client) DefaultQueue(ctx context.Context, relativeURL string) (res *http.Response, err error)

DefaultQueue demonstrates how the DefaultQueue subscription option is used to create a unicast request/response communication pattern. Only one of the instances of this microservice will respond to each request.

func (Client) ForHost

func (_c Client) ForHost(host string) Client

ForHost returns a copy of the client with a different hostname to be applied to requests.

func (Client) Home

func (_c Client) Home(ctx context.Context, relativeURL string) (res *http.Response, err error)

Home demonstrates making requests using multicast and unicast request/response patterns.

func (Client) NoQueue

func (_c Client) NoQueue(ctx context.Context, relativeURL string) (res *http.Response, err error)

NoQueue demonstrates how the NoQueue subscription option is used to create a multicast request/response communication pattern. All instances of this microservice will respond to each request.

func (Client) WithOptions added in v1.13.1

func (_c Client) WithOptions(opts ...pub.Option) Client

WithOptions returns a copy of the client with options to be applied to requests.

type MulticastClient

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

MulticastClient is a lightweight proxy for making multicast calls to the microservice.

func NewMulticastClient

func NewMulticastClient(caller service.Publisher) MulticastClient

NewMulticastClient creates a new multicast client proxy to the microservice.

func (MulticastClient) CacheLoad

func (_c MulticastClient) CacheLoad(ctx context.Context, relativeURL string) iter.Seq[*pub.Response]

CacheLoad looks up an element in the distributed cache of the microservice.

func (MulticastClient) CacheStore

func (_c MulticastClient) CacheStore(ctx context.Context, relativeURL string) iter.Seq[*pub.Response]

CacheStore stores an element in the distributed cache of the microservice.

func (MulticastClient) DefaultQueue

func (_c MulticastClient) DefaultQueue(ctx context.Context, relativeURL string) iter.Seq[*pub.Response]

DefaultQueue demonstrates how the DefaultQueue subscription option is used to create a unicast request/response communication pattern. Only one of the instances of this microservice will respond to each request.

func (MulticastClient) ForHost

func (_c MulticastClient) ForHost(host string) MulticastClient

ForHost returns a copy of the client with a different hostname to be applied to requests.

func (MulticastClient) Home

func (_c MulticastClient) Home(ctx context.Context, relativeURL string) iter.Seq[*pub.Response]

Home demonstrates making requests using multicast and unicast request/response patterns.

func (MulticastClient) NoQueue

func (_c MulticastClient) NoQueue(ctx context.Context, relativeURL string) iter.Seq[*pub.Response]

NoQueue demonstrates how the NoQueue subscription option is used to create a multicast request/response communication pattern. All instances of this microservice will respond to each request.

func (MulticastClient) WithOptions added in v1.13.1

func (_c MulticastClient) WithOptions(opts ...pub.Option) MulticastClient

WithOptions returns a copy of the client with options to be applied to requests.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL