api

package

v0.0.0-...-2ccd479 Latest Latest Go to latest Published: Nov 25, 2022 License: GPL-3.0 Imports: 16 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/stensonb/go-sheepit-client

Links

Open Source Insights

Documentation ¶

Index ¶

type Api
- func New(c common.Configuration) (*Api, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Api ¶

type Api struct {
	Server string
	// contains filtered or unexported fields
}

func New ¶

func New(c common.Configuration) (*Api, error)

/server/config.php

<?xml version="1.0" encoding="utf-8" ?> <config status="0">

<request type="validate-job" path="/server/send_frame.php" />
<request type="request-job" path="/server/request_job.php" />
<request type="download-archive" path="/server/archive.php" />
<request type="error" path="/server/error.php" />
<request type="keepmealive" path="/server/keepmealive.php" max-period="800" />
<request type="logout" path="/account.php?mode=logout&amp;worker=1" />
<request type="last-render-frame" path="/ajax.php?action=webclient_get_last_render_frame_ui&amp;type=raw" />

</config>

func (*Api) DownloadArchive ¶

func (api *Api) DownloadArchive(job *common.Job, archive common.FileArchive) error

func (*Api) RequestJob ¶

func (api *Api) RequestJob(c common.Configuration) (*common.Job, error)

</script>

</job>

</jobrequest>

func (*Api) SendHeartbeat ¶

func (api *Api) SendHeartbeat(job *common.Job) (time.Duration, error)

A function to call periodically with details on current progress. Also doubles as a session keepalive. Returns duration until next report is required.

func (*Api) UploadResult ¶

func (api *Api) UploadResult(job *common.Job) error

Source Files ¶

View all Source files

api.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL