checkip

Documentation

Index

• Constants
• type Client
• type ClientObj
  • func New() *ClientObj
  • func NewWithHTTPClient(httpClient httpclient.Client) *ClientObj
  • func (c *ClientObj) GetPublicIPV4() (string, error)

Constants

const IPv4CheckURL string = "https://checkip.amazonaws.com"

IPv4CheckURL is the endpoint to detect the public IPv4

Types

type Client

type Client interface {
	GetPublicIPV4() (string, error)
}

Client is the interface for the checkip package

type ClientObj

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

ClientObj implements the Cliet interface per default

func New

func New() *ClientObj

New returns a new pointer instance of ClientObj with default values

func NewWithHTTPClient

func NewWithHTTPClient(httpClient httpclient.Client) *ClientObj

NewWithHTTPClient returns a new pointer instance of ClientObj with a custom http.Client

func (*ClientObj) GetPublicIPV4

func (c *ClientObj) GetPublicIPV4() (string, error)

GetPublicIPV4 fetches the current public IPv4 of this machine and network from an endpoint