extension

Documentation

Overview

Package extension defines the Extension API used between the ePoxy server and extension services.

Index

• type Request
  • func (req *Request) Decode(msg io.Reader) error
  • func (req *Request) Encode() string
• type V1

Types

type Request

type Request struct {

	// V1 contains information to send to an extension service.
	V1 *V1 `json:"v1,omitempty"`
}

Request contains information about a booting machine

func (*Request) Decode

func (req *Request) Decode(msg io.Reader) error

Decode unmarshals a Request from a JSON message.

func (*Request) Encode

func (req *Request) Encode() string

Encode marshals a Request to JSON.

type V1

type V1 struct {
	// Hostname is the FQDN for the booting machine.
	Hostname string `json:"hostname"`

	// IPv4Address is the IPv4 address the booting machine.
	IPv4Address string `json:"ipv4_address"`

	// IPv6Address is the IPv6 address the booting machine.
	IPv6Address string `json:"ipv6_address"`

	// LastBoot is the most recent time when the booting machine reached stage1.
	LastBoot time.Time `json:"last_boot"`

	// The raw query string from the request to ePoxy. Extensions may use this
	// to extract arbitrary data sent by the client.
	RawQuery string `json:"raw_query"`
}

V1 contains information about a booting machine. The ePoxy server guarantees that a booting machine is registered and all requests have used valid session IDs.