Package: github.com/huin/goupnp

package goupnp Import Path github.com/huin/goupnp (on go.dev) Dependency Relation imports 14 packages, and imported by 3 packages

Involved Source Files device.go d goupnp.go goupnp is an implementation of a client for various UPnP services. For most uses, it is recommended to use the code-generated packages under github.com/huin/goupnp/dcps. Example use is shown at http://godoc.org/github.com/huin/goupnp/example A commonly used client is internetgateway1.WANPPPConnection1: http://godoc.org/github.com/huin/goupnp/dcps/internetgateway1#WANPPPConnection1 Currently only a couple of schemas have code generated for them from the UPnP example XML specifications. Not all methods will work on these clients, because the generated stubs contain the full set of specified methods from the XML specifications, and the discovered services will likely support a subset of those methods. network.go service_client.go

Package-Level Functions (total 9)

func DeviceByURL(loc *url.URL) (*RootDevice, error)

func DeviceByURLCtx(ctx context.Context, loc *url.URL) (*RootDevice, error)

func DiscoverDevices(searchTarget string) ([]MaybeRootDevice, error) DiscoverDevices is the legacy version of DiscoverDevicesCtx, but uses context.Background() as the context.

func DiscoverDevicesCtx(ctx context.Context, searchTarget string) ([]MaybeRootDevice, error) DiscoverDevicesCtx attempts to find targets of the given type. This is typically the entry-point for this package. searchTarget is typically a URN in the form "urn:schemas-upnp-org:device:..." or "urn:schemas-upnp-org:service:...". A single error is returned for errors while attempting to send the query. An error or RootDevice is returned for each discovered RootDevice.

func NewServiceClients(searchTarget string) (clients []ServiceClient, errors []error, err error) NewServiceClients is the legacy version of NewServiceClientsCtx, but uses context.Background() as the context.

func NewServiceClientsByURL(loc *url.URL, searchTarget string) ([]ServiceClient, error) NewServiceClientsByURL is the legacy version of NewServiceClientsByURLCtx, but uses context.Background() as the context.

func NewServiceClientsByURLCtx(ctx context.Context, loc *url.URL, searchTarget string) ([]ServiceClient, error) NewServiceClientsByURLCtx creates client(s) for the given service URN, for a root device at the given URL.

func NewServiceClientsCtx(ctx context.Context, searchTarget string) (clients []ServiceClient, errors []error, err error) NewServiceClientsCtx discovers services, and returns clients for them. err will report any error with the discovery process (blocking any device/service discovery), errors reports errors on a per-root-device basis.

func NewServiceClientsFromRootDevice(rootDevice *RootDevice, loc *url.URL, searchTarget string) ([]ServiceClient, error) NewServiceClientsFromDevice creates client(s) for the given service URN, in a given root device. The loc parameter is simply assigned to the Location attribute of the returned ServiceClient(s).

Package-Level Variables (total 2)

var CharsetReaderDefault (charset string, input io.Reader) (io.Reader, error) CharsetReaderDefault specifies the charset reader used while decoding the output from a UPnP server. It can be modified in an init function to allow for non-utf8 encodings, but should not be changed after requesting clients.

var HTTPClientDefault *http.Client HTTPClient specifies the http.Client object used when fetching the XML from the UPnP server. HTTPClient defaults the http.DefaultClient. This may be overridden by the importing application.

Package-Level Constants (only one)

const DeviceXMLNamespace = "urn:schemas-upnp-org:device-1-0"