service

type Credentials struct {
	User     string
	Password string
}

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

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

type Host struct {
	// Hostname  must be a publicly available IP/FQDN if the service is public or a private IP/FQDN id the service is private.
	Hostname string `json:"name"`
	// Name of the service which this host store. This will be overwritten by the Register Function
	Name string `json:"service_name"`
	// Ports is the ports accessible on a public network if the service is Public or the ports accessible on a private network if the service is private
	Ports Ports `json:"ports"`
	// User name used to authenticate to this service. The Register function can override this at any time if the service is public
	User string `json:"user,omitempty"`
	// Password used to authenticate to this service. The Register function can override this at any time if the service is public
	Password string `json:"password,omitempty"`
	// Public is set to true if the service is public
	Public bool `json:"public,omitempty"`
	// PrivateHostname is the private IP/FQDN used to communicate with this service on the private network
	// This will defaults to Hostname if empty
	PrivateHostname string `json:"private_hostname,omitempty"`
	// PrivatePorts is the private ports used to communicate with this service on the private network.
	// This will defaults to Ports if empty
	PrivatePorts Ports `json:"private_ports,omitempty"`
	// Critical will be set to true is the service is critical
	Critical bool `json:"critical,omitempty"`
	// UUID is the service UUID, this must have the following pattern: uuid-PrivateHostname
	UUID string `json:"uuid,omitempty"`
}

type HostResponse interface {
	Err() error
	Host() (*Host, error)
	URL(scheme, path string) (string, error)
	PrivateURL(scheme, path string) (string, error)
}

type Hosts []*Host

type Ports map[string]string

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

type RegistrationWrapper interface {
	Ready() bool                       // Ready return strue if the service registred yet? This method should no be blocking
	WaitRegistration()                 // WaitRegistration wait for the first registration
	Credentials() (Credentials, error) // Credentials return the current credentials or an error if the service is not registred yet
	UUID() string                      // UUID return the host UUID
}

type Service struct {
	Name     string `json:"name"`               // Name of the service
	Critical bool   `json:"critical"`           // Is the service critical to the infrastructure health?
	Hostname string `json:"hostname,omitempty"` // The service private hostname
	User     string `json:"user,omitempty"`     // The service username
	Password string `json:"password,omitempty"` // The service password
	Ports    Ports  `json:"ports,omitempty"`    // The service private ports
	Public   bool   `json:"public,omitempty"`   // Is the service public?
}

type ServiceResponse interface {
	// Err is the method used to check if the Response is errored.
	Err() error
	// Service return the Service struct representing the requested service
	Service() (*Service, error)
	// One return a host of the service choosen randomly
	One() HostResponse
	// First return the first host of the serice
	First() HostResponse
	// All return all the hosts registred for this service
	All() (Hosts, error)
	// URL returns a valid url for this service
	URL(scheme, path string) (string, error)
}