httpegressapi

package
v1.45.0 Latest Latest
Warning

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

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

Documentation

Index

Constants

View Source
const Description = `The HTTP egress microservice relays HTTP requests to the internet.`

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

View Source
const Hostname = "http.egress.core"

Hostname is the default hostname of the microservice.

View Source
const Name = "HTTPEgress"

Name is the decorative PascalCase name of the microservice.

View Source
const Version = 158

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

Variables

View Source
var MakeRequest = define.Web{
	Host: Hostname, Method: "POST", Route: ":444/make-request",
}

MakeRequest proxies a request to a URL and returns the HTTP response, respecting the timeout set in the context. The proxied request is expected to be posted in the body of the request in binary form (RFC7231).

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

func (c Client) Do(ctx context.Context, req *http.Request) (resp *http.Response, err error)

Do makes a request to a URL, respecting the timeout set in the context.

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

func (c Client) Get(ctx context.Context, url string) (resp *http.Response, err error)

Get makes a GET request to a URL, respecting the timeout set in the context.

func (Client) MakeRequest

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

MakeRequest proxies a request to a URL and returns the HTTP response, respecting the timeout set in the context. The proxied request is expected to be posted in the body of the request in binary form (RFC7231).

func (Client) Post

func (c Client) Post(ctx context.Context, url string, contentType string, body any) (resp *http.Response, err error)

Post makes a POST request to a URL, respecting the timeout set in the context.

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

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

MakeRequest proxies a request to a URL and returns the HTTP response, respecting the timeout set in the context. The proxied request is expected to be posted in the body of the request in binary form (RFC7231).

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