Documentation
¶
Overview ¶
Package messagingapi implements the public API of the messaging.example microservice, including clients and data structures.
The Messaging microservice demonstrates service-to-service communication patterns.
Index ¶
- Constants
- Variables
- type Client
- func (_c Client) CacheLoad(ctx context.Context, relURL string) (res *http.Response, err error)
- func (_c Client) CacheStore(ctx context.Context, relURL string) (res *http.Response, err error)
- func (_c Client) DefaultQueue(ctx context.Context, relURL string) (res *http.Response, err error)
- func (_c Client) ForHost(host string) Client
- func (_c Client) Home(ctx context.Context, relURL string) (res *http.Response, err error)
- func (_c Client) NoQueue(ctx context.Context, relURL string) (res *http.Response, err error)
- func (_c Client) WithOptions(opts ...pub.Option) Client
- type MulticastClient
- func (_c MulticastClient) CacheLoad(ctx context.Context, relURL string) <-chan *pub.Response
- func (_c MulticastClient) CacheStore(ctx context.Context, relURL string) <-chan *pub.Response
- func (_c MulticastClient) DefaultQueue(ctx context.Context, relURL string) <-chan *pub.Response
- func (_c MulticastClient) ForHost(host string) MulticastClient
- func (_c MulticastClient) Home(ctx context.Context, relURL string) <-chan *pub.Response
- func (_c MulticastClient) NoQueue(ctx context.Context, relURL string) <-chan *pub.Response
- func (_c MulticastClient) WithOptions(opts ...pub.Option) MulticastClient
Constants ¶
const Hostname = "messaging.example"
Hostname is the default hostname of the microservice: messaging.example.
Variables ¶
var ( URLOfHome = httpx.JoinHostAndPath(Hostname, `:443/home`) URLOfNoQueue = httpx.JoinHostAndPath(Hostname, `:443/no-queue`) URLOfDefaultQueue = httpx.JoinHostAndPath(Hostname, `:443/default-queue`) URLOfCacheLoad = httpx.JoinHostAndPath(Hostname, `:443/cache-load`) URLOfCacheStore = httpx.JoinHostAndPath(Hostname, `:443/cache-store`) )
Fully-qualified URLs of the microservice's endpoints.
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 messaging.example microservice.
func NewClient ¶
NewClient creates a new unicast client proxy to the messaging.example microservice.
func (Client) CacheLoad ¶
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 ¶
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 ¶
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.
If a URL is provided, it is resolved relative to the URL of the endpoint.
func (Client) ForHost ¶
ForHost returns a copy of the client with a different hostname to be applied to requests.
func (Client) Home ¶
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.
type MulticastClient ¶
type MulticastClient struct {
// contains filtered or unexported fields
}
MulticastClient is a lightweight proxy for making multicast calls to the messaging.example microservice.
func NewMulticastClient ¶
func NewMulticastClient(caller service.Publisher) MulticastClient
NewMulticastClient creates a new multicast client proxy to the messaging.example microservice.
func (MulticastClient) CacheLoad ¶
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 ¶
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 ¶
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.
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 ¶
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 ¶
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.
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.
Source Files