helloworldapi

package
v1.17.1 Latest Latest
Warning

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

Go to latest
Published: Oct 17, 2025 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Overview

Package helloworldapi implements the public API of the helloworld.example microservice, including clients and data structures.

The HelloWorld microservice demonstrates the classic minimalist example.

Index

Constants

View Source
const Hostname = "helloworld.example"

Hostname is the default hostname of the microservice: helloworld.example.

Variables

View Source
var (
	URLOfHelloWorld = httpx.JoinHostAndPath(Hostname, `:443/hello-world`)
)

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 helloworld.example microservice.

func NewClient

func NewClient(caller service.Publisher) Client

NewClient creates a new unicast client proxy to the helloworld.example microservice.

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

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

HelloWorld prints the classic greeting.

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 MulticastClient

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

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

func NewMulticastClient

func NewMulticastClient(caller service.Publisher) MulticastClient

NewMulticastClient creates a new multicast client proxy to the helloworld.example microservice.

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

func (_c MulticastClient) HelloWorld(ctx context.Context, relURL string) <-chan *pub.Response

HelloWorld prints the classic greeting.

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.

Jump to

Keyboard shortcuts

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