eventsinkapi

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
• Variables
• type Client
  • func NewClient(caller service.Publisher) *Client
  • func (_c *Client) ForHost(host string) *Client
  • func (_c *Client) Registered(ctx context.Context) (emails []string, err error)
• type MulticastClient
  • func NewMulticastClient(caller service.Publisher) *MulticastClient
  • func (_c *MulticastClient) ForHost(host string) *MulticastClient
  • func (_c *MulticastClient) Registered(ctx context.Context) <-chan *RegisteredResponse
• type RegisteredIn
• type RegisteredOut
• type RegisteredResponse
  • func (_out *RegisteredResponse) Get() (emails []string, err error)

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.

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client is an interface to calling the endpoints of the eventsink.example microservice. This simple version is for unicast calls.

func NewClient

func NewClient(caller service.Publisher) *Client

NewClient creates a new unicast client to the eventsink.example microservice.

func (*Client) ForHost

func (_c *Client) ForHost(host string) *Client

ForHost replaces the default hostname of this client.

func (*Client) Registered

func (_c *Client) Registered(ctx context.Context) (emails []string, err error)

Registered returns the list of registered users.

type MulticastClient

type MulticastClient struct {
	// contains filtered or unexported fields
}

MulticastClient is an interface to calling the endpoints of the eventsink.example microservice. This advanced version is for multicast calls.

func NewMulticastClient

func NewMulticastClient(caller service.Publisher) *MulticastClient

NewMulticastClient creates a new multicast client to the eventsink.example microservice.

func (*MulticastClient) ForHost

func (_c *MulticastClient) ForHost(host string) *MulticastClient

ForHost replaces the default hostname of this client.

func (*MulticastClient) Registered

func (_c *MulticastClient) Registered(ctx context.Context) <-chan *RegisteredResponse

Registered returns the list of registered users.

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.