go-pulse/vendor/github.com/huin/goupnp/README.md
Péter Szilágyi 289b30715d Godeps, vendor: convert dependency management to trash (#3198)
This commit converts the dependency management from Godeps to the vendor
folder, also switching the tool from godep to trash. Since the upstream tool
lacks a few features proposed via a few PRs, until those PRs are merged in
(if), use github.com/karalabe/trash.

You can update dependencies via trash --update.

All dependencies have been updated to their latest version.

Parts of the build system are reworked to drop old notions of Godeps and
invocation of the go vet command so that it doesn't run against the vendor
folder, as that will just blow up during vetting.

The conversion drops OpenCL (and hence GPU mining support) from ethash and our
codebase. The short reasoning is that there's noone to maintain and having
opencl libs in our deps messes up builds as go install ./... tries to build
them, failing with unsatisfied link errors for the C OpenCL deps.

golang.org/x/net/context is not vendored in. We expect it to be fetched by the
user (i.e. using go get). To keep ci.go builds reproducible the package is
"vendored" in build/_vendor.
2016-10-28 19:05:01 +02:00

2.2 KiB

goupnp is a UPnP client library for Go

Installation

Run go get -u github.com/huin/goupnp.

Documentation

All doc links below are for GoDoc.

Supported DCPs (you probably want to start with one of these):

  • av1 - Client for UPnP Device Control Protocol MediaServer v1 and MediaRenderer v1.
  • internetgateway1 - Client for UPnP Device Control Protocol Internet Gateway Device v1.
  • internetgateway2 - Client for UPnP Device Control Protocol Internet Gateway Device v2.

Core components:

  • (goupnp) core library - contains datastructures and utilities typically used by the implemented DCPs.
  • httpu HTTPU implementation, underlies SSDP.
  • ssdp SSDP client implementation (simple service discovery protocol) - used to discover UPnP services on a network.
  • soap SOAP client implementation (simple object access protocol) - used to communicate with discovered services.

Regenerating dcps generated source code:

  1. Install gotasks: go get -u github.com/jingweno/gotask
  2. Change to the gotasks directory: cd gotasks
  3. Run specgen task: gotask specgen

Supporting additional UPnP devices and services:

Supporting additional services is, in the trivial case, simply a matter of adding the service to the dcpMetadata whitelist in gotasks/specgen_task.go, regenerating the source code (see above), and committing that source code.

However, it would be helpful if anyone needing such a service could test the service against the service they have, and then reporting any trouble encountered as an issue on this project. If it just works, then please report at least minimal working functionality as an issue, and optionally contribute the metadata upstream.