network

Documentation

Index

• func CreateResponse(msg string, params ResponseParams) []byte
• func ExtractDomainFromURL(hostURL *url.URL, keepSubdomain bool) string
• func GenerateURL(host string, path string, params URLParams) (*url.URL, error)
• func ReadEndpoint(endpointURL *url.URL, auth *BasicAuth, checkStatus bool) ([]byte, error)
• func WriteEndpoint(endpointURL *url.URL, auth *BasicAuth, checkStatus bool) ([]byte, error)
• type BasicAuth
• type ResponseParams
• type URLParams

Functions

func CreateResponse

func CreateResponse(msg string, params ResponseParams) []byte

CreateResponse creates a generic HTTP response in JSON format.

func ExtractDomainFromURL

func ExtractDomainFromURL(hostURL *url.URL, keepSubdomain bool) string

ExtractDomainFromURL extracts the domain name (domain.tld or subdomain.domain.tld) from a URL.

func GenerateURL

func GenerateURL(host string, path string, params URLParams) (*url.URL, error)

GenerateURL creates a URL object from a host, path and optional parameters.

func ReadEndpoint

func ReadEndpoint(endpointURL *url.URL, auth *BasicAuth, checkStatus bool) ([]byte, error)

ReadEndpoint reads data from an HTTP endpoint via GET.

func WriteEndpoint

func WriteEndpoint(endpointURL *url.URL, auth *BasicAuth, checkStatus bool) ([]byte, error)

WriteEndpoint sends data to an HTTP endpoint via POST.

Types

type BasicAuth

type BasicAuth struct {
	User     string
	Password string
}

BasicAuth holds user credentials for basic HTTP authentication.

type ResponseParams

type ResponseParams map[string]interface{}

ResponseParams holds parameters of an HTTP response.

type URLParams

type URLParams map[string]string

URLParams holds Key-Value URL parameters; it is a simpler form of url.Values.