Documentation
¶
Index ¶
- Constants
- Variables
- type Client
- func (c Client) Do(ctx context.Context, req *http.Request) (resp *http.Response, err error)
- func (_c Client) ForHost(host string) Client
- func (c Client) Get(ctx context.Context, url string) (resp *http.Response, err error)
- func (_c Client) MakeRequest(ctx context.Context, relativeURL string, body any) (res *http.Response, err error)
- func (c Client) Post(ctx context.Context, url string, contentType string, body any) (resp *http.Response, err error)
- func (_c Client) WithOptions(opts ...pub.Option) Client
- type Hook
- type MulticastClient
- type MulticastTrigger
Constants ¶
const Hostname = "http.egress.core"
Hostname is the default hostname of the microservice.
const (
RouteOfMakeRequest = `:444/make-request` // MARKER: MakeRequest
)
Endpoint routes.
Variables ¶
var (
URLOfMakeRequest = httpx.JoinHostAndPath(Hostname, RouteOfMakeRequest) // MARKER: MakeRequest
)
Endpoint URLs.
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 (Client) ForHost ¶
ForHost returns a copy of the client with a different hostname to be applied to requests.
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).
If a URL is provided, it is resolved relative to the URL of the endpoint. If the body is of type io.Reader, []byte or string, it is serialized in binary form. If it is of type url.Values, it is serialized as form data. All other types are serialized as JSON.
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.
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) <-chan *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).
If a URL is provided, it is resolved relative to the URL of the endpoint. If the body is of type io.Reader, []byte or string, it is serialized in binary form. If it is of type url.Values, it is serialized as form data. All other types are serialized as JSON.
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