messagingapi

package
v1.23.0 Latest Latest
Warning

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

 Go to latest Published: Mar 1, 2026 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

View Source 
const Hostname = "messaging.example"

Hostname is the default hostname of the microservice.

Variables

View Source 
var (
	// HINT: Insert endpoint definitions here
	Home         = Def{Method: "GET", Route: "/home"}          // MARKER: Home
	NoQueue      = Def{Method: "GET", Route: "/no-queue"}      // MARKER: NoQueue
	DefaultQueue = Def{Method: "GET", Route: "/default-queue"} // MARKER: DefaultQueue
	CacheLoad    = Def{Method: "GET", Route: "/cache-load"}    // MARKER: CacheLoad
	CacheStore   = Def{Method: "GET", Route: "/cache-store"}   // MARKER: CacheStore
)

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.

If a URL is provided, it is resolved relative to the URL of the endpoint.

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.

If a URL is provided, it is resolved relative to the URL of the endpoint.

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 instance responds.

If a URL is provided, it is resolved relative to the URL of the endpoint.

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.

If a URL is provided, it is resolved relative to the URL of the endpoint.

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 respond.

If a URL is provided, it is resolved relative to the URL of the endpoint.

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 Def added in v1.23.0 

type Def struct {
	Method string
	Route  string
}

Def defines an endpoint of the microservice.

func (*Def) URL added in v1.23.0 

func (d *Def) URL() string

URL is the full URL to the endpoint.

type Hook added in v1.22.0 

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

Hook assists in the subscription to the events of the microservice.

func NewHook added in v1.22.0 

func NewHook(listener service.Subscriber) Hook

NewHook creates a new hook to the events of the microservice.

func (Hook) ForHost added in v1.22.0 

func (c Hook) ForHost(host string) Hook

ForHost returns a copy of the hook with a different hostname to be applied to the subscription.

func (Hook) WithOptions added in v1.22.0 

func (c Hook) WithOptions(opts ...sub.Option) Hook

WithOptions returns a copy of the hook with options to be applied to subscriptions.

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.

If a URL is provided, it is resolved relative to the URL of the endpoint.

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.

If a URL is provided, it is resolved relative to the URL of the endpoint.

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 instance responds.

If a URL is provided, it is resolved relative to the URL of the endpoint.

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.

If a URL is provided, it is resolved relative to the URL of the endpoint.

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 respond.

If a URL is provided, it is resolved relative to the URL of the endpoint.

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.

type MulticastTrigger added in v1.22.0 

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

MulticastTrigger is a lightweight proxy for triggering the events of the microservice.

func NewMulticastTrigger added in v1.22.0 

func NewMulticastTrigger(caller service.Publisher) MulticastTrigger

NewMulticastTrigger creates a new multicast trigger of events of the microservice.

func (MulticastTrigger) ForHost added in v1.22.0 

func (_c MulticastTrigger) ForHost(host string) MulticastTrigger

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

func (MulticastTrigger) WithOptions added in v1.22.0 

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

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

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.