Documentation
¶
Overview ¶
Package eventsinkapi implements the public API of the eventsink.example microservice, including clients and data structures.
The event sink microservice handles events that are fired by the event source microservice.
Index ¶
Constants ¶
const Hostname = "eventsink.example"
Hostname is the default hostname of the microservice: eventsink.example.
Variables ¶
var (
URLOfRegistered = httpx.JoinHostAndPath(Hostname, `:443/registered`)
)
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 eventsink.example microservice.
func NewClient ¶
NewClient creates a new unicast client proxy to the eventsink.example microservice.
func (Client) ForHost ¶
ForHost returns a copy of the client with a different hostname to be applied to requests.
func (Client) Registered ¶
Registered returns the list of registered users.
type MulticastClient ¶
type MulticastClient struct {
// contains filtered or unexported fields
}
MulticastClient is a lightweight proxy for making multicast calls to the eventsink.example microservice.
func NewMulticastClient ¶
func NewMulticastClient(caller service.Publisher) MulticastClient
NewMulticastClient creates a new multicast client proxy to the eventsink.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) Registered ¶
func (_c MulticastClient) Registered(ctx context.Context) <-chan *RegisteredResponse
Registered returns the list of registered users.
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 RegisteredIn ¶
type RegisteredIn struct {
}
RegisteredIn are the input arguments of Registered.
type RegisteredOut ¶
type RegisteredOut struct {
Emails []string `json:"emails"`
}
RegisteredOut are the return values of Registered.
type RegisteredResponse ¶
type RegisteredResponse struct {
HTTPResponse *http.Response
// contains filtered or unexported fields
}
RegisteredResponse is the response to Registered.
func (*RegisteredResponse) Get ¶
func (_out *RegisteredResponse) Get() (emails []string, err error)
Get retrieves the return values.
Source Files