ipify

Documentation

Overview

Package ipify allows to retrieve the public IP address of a service instance using the external ipify API (https://www.ipify.org/).

Index

• type Client
  • func New(opts ...Option) (*Client, error)
  • func (c *Client) GetPublicIP(ctx context.Context) (string, error)
• type HTTPClient
• type Option
  • func WithErrorIP(s string) Option
  • func WithHTTPClient(hc HTTPClient) Option
  • func WithTimeout(timeout time.Duration) Option
  • func WithURL(addr string) Option

Types

type Client

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

Client represents the config options required by this client.

func New

func New(opts ...Option) (*Client, error)

New creates a new ipify client instance.

func (*Client) GetPublicIP

func (c *Client) GetPublicIP(ctx context.Context) (string, error)

GetPublicIP retrieves the public IP of this service instance via ipify.com API.

type HTTPClient

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

HTTPClient contains the function to perform the actual HTTP request.

type Option

type Option func(c *Client)

Option is the interface that allows to set client options.

func WithErrorIP

func WithErrorIP(s string) Option

WithErrorIP overrides the default error return string.

func WithHTTPClient

func WithHTTPClient(hc HTTPClient) Option

WithHTTPClient overrides the default HTTP client.

func WithTimeout

func WithTimeout(timeout time.Duration) Option

WithTimeout overrides the default request timeout.

func WithURL

func WithURL(addr string) Option

WithURL overrides the default service URL.