Documentation
¶
Index ¶
Constants ¶
const Description = `The event sink microservice handles events that are fired by the event source microservice.`
Description is the human-readable summary of the microservice, surfaced in OpenAPI and discovery.
const Hostname = "eventsink.example"
Hostname is the default hostname of the microservice.
const Name = "EventSink"
Name is the decorative PascalCase name of the microservice.
const Version = 261
Version is a generation counter bumped on each regeneration, not a semantic version.
Variables ¶
var OnAllowRegister = define.InboundEvent{ Source: eventsourceapi.OnAllowRegister, }
OnAllowRegister blocks registrations from gmail and hotmail domains.
var OnRegistered = define.InboundEvent{ Source: eventsourceapi.OnRegistered, }
OnRegistered keeps track of registrations.
var Registered = define.Function{ Host: Hostname, Method: "ANY", Route: ":443/registered", In: RegisteredIn{}, Out: RegisteredOut{}, }
Registered returns the list of registered users.
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) 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 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) Registered ¶
func (_c MulticastClient) Registered(ctx context.Context) iter.Seq[*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,omitzero"`
}
RegisteredOut are the output arguments of Registered.
type RegisteredResponse ¶
type RegisteredResponse multicastResponse // MARKER: Registered
RegisteredResponse packs the response of Registered.
func (*RegisteredResponse) Get ¶
func (_res *RegisteredResponse) Get() (emails []string, err error)
Get unpacks the return arguments of Registered.
Source Files