Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var DefaultResponseLimit = 100
DefaultResponseLimit is the default number of responses to return on requests that can be limited.
Functions ¶
func CheckConnection ¶
CheckConnection checks that the user is connected to a network and the URL points to a valid controller.
func CreateHTTPClient ¶
CreateHTTPClient creates a HTTP Client with proper SSL options.
Types ¶
type Client ¶
type Client struct {
// HTTP client used to communicate with the API.
HTTPClient *http.Client
// SSLVerify determines whether or not to verify SSL conections.
SSLVerify bool
// URL used to communicate with the controller.
ControllerURL url.URL
// Token is used to authenticate the request against the API.
Token string
// Username is the name of the user performing requests against the API.
Username string
// ResponseLimit is the number of results to return on requests that can be limited.
ResponseLimit int
}
Client oversees the interaction between the client and controller
func (Client) BasicRequest ¶
BasicRequest makes a simple http request on the controller.
func (Client) LimitedRequest ¶
LimitedRequest allows limiting the number of responses in a request.
Click to show internal directories.
Click to hide internal directories.