Documentation
¶
Index ¶
- Constants
- Variables
- type ArithmeticIn
- type ArithmeticOut
- type ArithmeticResponse
- type Client
- func (_c Client) Arithmetic(ctx context.Context, x int, op string, y int) (xEcho int, opEcho string, yEcho int, result int, err error)
- func (_c Client) Distance(ctx context.Context, p1 Point, p2 Point) (d float64, err error)
- func (_c Client) ForHost(host string) Client
- func (_c Client) Square(ctx context.Context, x int) (xEcho int, result int, err error)
- func (_c Client) WithOptions(opts ...pub.Option) Client
- type DistanceIn
- type DistanceOut
- type DistanceResponse
- type Hook
- type MulticastClient
- func (_c MulticastClient) Arithmetic(ctx context.Context, x int, op string, y int) <-chan *ArithmeticResponse
- func (_c MulticastClient) Distance(ctx context.Context, p1 Point, p2 Point) <-chan *DistanceResponse
- func (_c MulticastClient) ForHost(host string) MulticastClient
- func (_c MulticastClient) Square(ctx context.Context, x int) <-chan *SquareResponse
- func (_c MulticastClient) WithOptions(opts ...pub.Option) MulticastClient
- type MulticastTrigger
- type Point
- type SquareIn
- type SquareOut
- type SquareResponse
Constants ¶
const ( RouteOfArithmetic = `:443/arithmetic` // MARKER: Arithmetic RouteOfSquare = `:443/square` // MARKER: Square RouteOfDistance = `:443/distance` // MARKER: Distance )
Endpoint routes.
const Hostname = "calculator.example"
Hostname is the default hostname of the microservice.
Variables ¶
var ( URLOfArithmetic = httpx.JoinHostAndPath(Hostname, RouteOfArithmetic) // MARKER: Arithmetic URLOfSquare = httpx.JoinHostAndPath(Hostname, RouteOfSquare) // MARKER: Square URLOfDistance = httpx.JoinHostAndPath(Hostname, RouteOfDistance) // MARKER: Distance )
Endpoint URLs.
Functions ¶
This section is empty.
Types ¶
type ArithmeticIn ¶
type ArithmeticIn struct {
X int `json:"x,omitzero"`
Op string `json:"op,omitzero"`
Y int `json:"y,omitzero"`
}
ArithmeticIn are the input arguments of Arithmetic.
type ArithmeticOut ¶
type ArithmeticOut struct {
XEcho int `json:"xEcho,omitzero"`
OpEcho string `json:"opEcho,omitzero"`
YEcho int `json:"yEcho,omitzero"`
Result int `json:"result,omitzero"`
}
ArithmeticOut are the output arguments of Arithmetic.
type ArithmeticResponse ¶
type ArithmeticResponse struct {
HTTPResponse *http.Response
// contains filtered or unexported fields
}
ArithmeticResponse is the response to Arithmetic.
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client is a lightweight proxy for making unicast calls to the microservice.
func (Client) Arithmetic ¶
func (_c Client) Arithmetic(ctx context.Context, x int, op string, y int) (xEcho int, opEcho string, yEcho int, result int, err error)
Arithmetic performs an arithmetic operation between two integers x and y given an operator op.
func (Client) Distance ¶
Distance calculates the distance between two points. It demonstrates the use of the defined type Point.
func (Client) ForHost ¶
ForHost returns a copy of the client with a different hostname to be applied to requests.
type DistanceIn ¶
DistanceIn are the input arguments of Distance.
type DistanceOut ¶
type DistanceOut struct {
D float64 `json:"d,omitzero"`
}
DistanceOut are the output arguments of Distance.
type DistanceResponse ¶
type DistanceResponse struct {
HTTPResponse *http.Response
// contains filtered or unexported fields
}
DistanceResponse is the response to Distance.
func (*DistanceResponse) Get ¶
func (_res *DistanceResponse) Get() (d float64, err error)
Get retrieves the return values.
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) Arithmetic ¶
func (_c MulticastClient) Arithmetic(ctx context.Context, x int, op string, y int) <-chan *ArithmeticResponse
Arithmetic performs an arithmetic operation between two integers x and y given an operator op.
func (MulticastClient) Distance ¶
func (_c MulticastClient) Distance(ctx context.Context, p1 Point, p2 Point) <-chan *DistanceResponse
Distance calculates the distance between two points. It demonstrates the use of the defined type Point.
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) Square ¶
func (_c MulticastClient) Square(ctx context.Context, x int) <-chan *SquareResponse
Square prints the square of the integer x.
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.
type Point ¶
type Point struct {
X float64 `json:"x,omitzero" jsonschema:"description=X coordinate,example=6"`
Y float64 `json:"y,omitzero" jsonschema:"description=Y coordinate,example=8"`
}
Point is a 2D (X,Y) coordinate.
type SquareIn ¶
type SquareIn struct {
X int `json:"x,omitzero"`
}
SquareIn are the input arguments of Square.
type SquareResponse ¶
type SquareResponse struct {
HTTPResponse *http.Response
// contains filtered or unexported fields
}
SquareResponse is the response to Square.