internetgateway1

package
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 25, 2021 License: MIT, BSD-2-Clause Imports: 5 Imported by: 0

Documentation

Overview

Client for UPnP Device Control Protocol Internet Gateway Device v1.

This DCP is documented in detail at: http://upnp.org/specs/gw/UPnP-gw-InternetGatewayDevice-v1-Device.pdf

Typically, use one of the New* functions to create clients for services.

Index

Constants

View Source 
const (
	URN_LANDevice_1           = "urn:schemas-upnp-org:device:LANDevice:1"
	URN_WANConnectionDevice_1 = "urn:schemas-upnp-org:device:WANConnectionDevice:1"
	URN_WANDevice_1           = "urn:schemas-upnp-org:device:WANDevice:1"
)

Device URNs:

View Source 
const (
	URN_LANHostConfigManagement_1  = "urn:schemas-upnp-org:service:LANHostConfigManagement:1"
	URN_Layer3Forwarding_1         = "urn:schemas-upnp-org:service:Layer3Forwarding:1"
	URN_WANCableLinkConfig_1       = "urn:schemas-upnp-org:service:WANCableLinkConfig:1"
	URN_WANCommonInterfaceConfig_1 = "urn:schemas-upnp-org:service:WANCommonInterfaceConfig:1"
	URN_WANDSLLinkConfig_1         = "urn:schemas-upnp-org:service:WANDSLLinkConfig:1"
	URN_WANEthernetLinkConfig_1    = "urn:schemas-upnp-org:service:WANEthernetLinkConfig:1"
	URN_WANIPConnection_1          = "urn:schemas-upnp-org:service:WANIPConnection:1"
	URN_WANPOTSLinkConfig_1        = "urn:schemas-upnp-org:service:WANPOTSLinkConfig:1"
	URN_WANPPPConnection_1         = "urn:schemas-upnp-org:service:WANPPPConnection:1"
)

Service URNs:

Variables

This section is empty.

Functions

This section is empty.

Types

type LANHostConfigManagement1 

type LANHostConfigManagement1 struct {
	goupnp.ServiceClient
}

LANHostConfigManagement1 is a client for UPnP SOAP service with URN "urn:schemas-upnp-org:service:LANHostConfigManagement:1". See goupnp.ServiceClient, which contains RootDevice and Service attributes which are provided for informational value.

func NewLANHostConfigManagement1Clients 

func NewLANHostConfigManagement1Clients() (clients []*LANHostConfigManagement1, errors []error, err error)

NewLANHostConfigManagement1Clients discovers instances of the service on the network, and returns clients to any that are found. errors will contain an error for any devices that replied but which could not be queried, and err will be set if the discovery process failed outright.

This is a typical entry calling point into this package.

func NewLANHostConfigManagement1ClientsByURL 

func NewLANHostConfigManagement1ClientsByURL(loc *url.URL) ([]*LANHostConfigManagement1, error)

NewLANHostConfigManagement1ClientsByURL discovers instances of the service at the given URL, and returns clients to any that are found. An error is returned if there was an error probing the service.

This is a typical entry calling point into this package when reusing an previously discovered service URL.

func NewLANHostConfigManagement1ClientsFromRootDevice 

func NewLANHostConfigManagement1ClientsFromRootDevice(rootDevice *goupnp.RootDevice, loc *url.URL) ([]*LANHostConfigManagement1, error)

NewLANHostConfigManagement1ClientsFromRootDevice discovers instances of the service in a given root device, and returns clients to any that are found. An error is returned if there was not at least one instance of the service within the device. The location parameter is simply assigned to the Location attribute of the wrapped ServiceClient(s).

This is a typical entry calling point into this package when reusing an previously discovered root device.

func (*LANHostConfigManagement1) DeleteDNSServer 

func (client *LANHostConfigManagement1) DeleteDNSServer(NewDNSServers string) (err error)

func (*LANHostConfigManagement1) DeleteIPRouter 

func (client *LANHostConfigManagement1) DeleteIPRouter(NewIPRouters string) (err error)

func (*LANHostConfigManagement1) DeleteReservedAddress 

func (client *LANHostConfigManagement1) DeleteReservedAddress(NewReservedAddresses string) (err error)

func (*LANHostConfigManagement1) GetAddressRange 

func (client *LANHostConfigManagement1) GetAddressRange() (NewMinAddress string, NewMaxAddress string, err error)

func (*LANHostConfigManagement1) GetDHCPRelay 

func (client *LANHostConfigManagement1) GetDHCPRelay() (NewDHCPRelay bool, err error)

func (*LANHostConfigManagement1) GetDHCPServerConfigurable 

func (client *LANHostConfigManagement1) GetDHCPServerConfigurable() (NewDHCPServerConfigurable bool, err error)

func (*LANHostConfigManagement1) GetDNSServers 

func (client *LANHostConfigManagement1) GetDNSServers() (NewDNSServers string, err error)

func (*LANHostConfigManagement1) GetDomainName 

func (client *LANHostConfigManagement1) GetDomainName() (NewDomainName string, err error)

func (*LANHostConfigManagement1) GetIPRoutersList 

func (client *LANHostConfigManagement1) GetIPRoutersList() (NewIPRouters string, err error)

func (*LANHostConfigManagement1) GetReservedAddresses 

func (client *LANHostConfigManagement1) GetReservedAddresses() (NewReservedAddresses string, err error)

func (*LANHostConfigManagement1) GetSubnetMask 

func (client *LANHostConfigManagement1) GetSubnetMask() (NewSubnetMask string, err error)

func (*LANHostConfigManagement1) SetAddressRange 

func (client *LANHostConfigManagement1) SetAddressRange(NewMinAddress string, NewMaxAddress string) (err error)

func (*LANHostConfigManagement1) SetDHCPRelay 

func (client *LANHostConfigManagement1) SetDHCPRelay(NewDHCPRelay bool) (err error)

func (*LANHostConfigManagement1) SetDHCPServerConfigurable 

func (client *LANHostConfigManagement1) SetDHCPServerConfigurable(NewDHCPServerConfigurable bool) (err error)

func (*LANHostConfigManagement1) SetDNSServer 

func (client *LANHostConfigManagement1) SetDNSServer(NewDNSServers string) (err error)

func (*LANHostConfigManagement1) SetDomainName 

func (client *LANHostConfigManagement1) SetDomainName(NewDomainName string) (err error)

func (*LANHostConfigManagement1) SetIPRouter 

func (client *LANHostConfigManagement1) SetIPRouter(NewIPRouters string) (err error)

func (*LANHostConfigManagement1) SetReservedAddress 

func (client *LANHostConfigManagement1) SetReservedAddress(NewReservedAddresses string) (err error)

func (*LANHostConfigManagement1) SetSubnetMask 

func (client *LANHostConfigManagement1) SetSubnetMask(NewSubnetMask string) (err error)

type Layer3Forwarding1 

type Layer3Forwarding1 struct {
	goupnp.ServiceClient
}

Layer3Forwarding1 is a client for UPnP SOAP service with URN "urn:schemas-upnp-org:service:Layer3Forwarding:1". See goupnp.ServiceClient, which contains RootDevice and Service attributes which are provided for informational value.

func NewLayer3Forwarding1Clients 

func NewLayer3Forwarding1Clients() (clients []*Layer3Forwarding1, errors []error, err error)

NewLayer3Forwarding1Clients discovers instances of the service on the network, and returns clients to any that are found. errors will contain an error for any devices that replied but which could not be queried, and err will be set if the discovery process failed outright.

This is a typical entry calling point into this package.

func NewLayer3Forwarding1ClientsByURL 

func NewLayer3Forwarding1ClientsByURL(loc *url.URL) ([]*Layer3Forwarding1, error)

NewLayer3Forwarding1ClientsByURL discovers instances of the service at the given URL, and returns clients to any that are found. An error is returned if there was an error probing the service.

This is a typical entry calling point into this package when reusing an previously discovered service URL.

func NewLayer3Forwarding1ClientsFromRootDevice 

func NewLayer3Forwarding1ClientsFromRootDevice(rootDevice *goupnp.RootDevice, loc *url.URL) ([]*Layer3Forwarding1, error)

NewLayer3Forwarding1ClientsFromRootDevice discovers instances of the service in a given root device, and returns clients to any that are found. An error is returned if there was not at least one instance of the service within the device. The location parameter is simply assigned to the Location attribute of the wrapped ServiceClient(s).

This is a typical entry calling point into this package when reusing an previously discovered root device.

func (*Layer3Forwarding1) GetDefaultConnectionService 

func (client *Layer3Forwarding1) GetDefaultConnectionService() (NewDefaultConnectionService string, err error)

func (*Layer3Forwarding1) SetDefaultConnectionService 

func (client *Layer3Forwarding1) SetDefaultConnectionService(NewDefaultConnectionService string) (err error)

type WANCableLinkConfig1 

type WANCableLinkConfig1 struct {
	goupnp.ServiceClient
}

WANCableLinkConfig1 is a client for UPnP SOAP service with URN "urn:schemas-upnp-org:service:WANCableLinkConfig:1". See goupnp.ServiceClient, which contains RootDevice and Service attributes which are provided for informational value.

func NewWANCableLinkConfig1Clients 

func NewWANCableLinkConfig1Clients() (clients []*WANCableLinkConfig1, errors []error, err error)

NewWANCableLinkConfig1Clients discovers instances of the service on the network, and returns clients to any that are found. errors will contain an error for any devices that replied but which could not be queried, and err will be set if the discovery process failed outright.

This is a typical entry calling point into this package.

func NewWANCableLinkConfig1ClientsByURL 

func NewWANCableLinkConfig1ClientsByURL(loc *url.URL) ([]*WANCableLinkConfig1, error)

NewWANCableLinkConfig1ClientsByURL discovers instances of the service at the given URL, and returns clients to any that are found. An error is returned if there was an error probing the service.

This is a typical entry calling point into this package when reusing an previously discovered service URL.

func NewWANCableLinkConfig1ClientsFromRootDevice 

func NewWANCableLinkConfig1ClientsFromRootDevice(rootDevice *goupnp.RootDevice, loc *url.URL) ([]*WANCableLinkConfig1, error)

NewWANCableLinkConfig1ClientsFromRootDevice discovers instances of the service in a given root device, and returns clients to any that are found. An error is returned if there was not at least one instance of the service within the device. The location parameter is simply assigned to the Location attribute of the wrapped ServiceClient(s).

This is a typical entry calling point into this package when reusing an previously discovered root device.

func (*WANCableLinkConfig1) GetBPIEncryptionEnabled 

func (client *WANCableLinkConfig1) GetBPIEncryptionEnabled() (NewBPIEncryptionEnabled bool, err error)

func (*WANCableLinkConfig1) GetCableLinkConfigInfo 

func (client *WANCableLinkConfig1) GetCableLinkConfigInfo() (NewCableLinkConfigState string, NewLinkType string, err error)

Return values:

* NewCableLinkConfigState: allowed values: notReady, dsSyncComplete, usParamAcquired, rangingComplete, ipComplete, todEstablished, paramTransferComplete, registrationComplete, operational, accessDenied

* NewLinkType: allowed values: Ethernet

func (*WANCableLinkConfig1) GetConfigFile 

func (client *WANCableLinkConfig1) GetConfigFile() (NewConfigFile string, err error)

func (*WANCableLinkConfig1) GetDownstreamFrequency 

func (client *WANCableLinkConfig1) GetDownstreamFrequency() (NewDownstreamFrequency uint32, err error)

func (*WANCableLinkConfig1) GetDownstreamModulation 

func (client *WANCableLinkConfig1) GetDownstreamModulation() (NewDownstreamModulation string, err error)

Return values:

* NewDownstreamModulation: allowed values: 64QAM, 256QAM

func (*WANCableLinkConfig1) GetTFTPServer 

func (client *WANCableLinkConfig1) GetTFTPServer() (NewTFTPServer string, err error)

func (*WANCableLinkConfig1) GetUpstreamChannelID 

func (client *WANCableLinkConfig1) GetUpstreamChannelID() (NewUpstreamChannelID uint32, err error)

func (*WANCableLinkConfig1) GetUpstreamFrequency 

func (client *WANCableLinkConfig1) GetUpstreamFrequency() (NewUpstreamFrequency uint32, err error)

func (*WANCableLinkConfig1) GetUpstreamModulation 

func (client *WANCableLinkConfig1) GetUpstreamModulation() (NewUpstreamModulation string, err error)

Return values:

* NewUpstreamModulation: allowed values: QPSK, 16QAM

func (*WANCableLinkConfig1) GetUpstreamPowerLevel 

func (client *WANCableLinkConfig1) GetUpstreamPowerLevel() (NewUpstreamPowerLevel uint32, err error)

type WANCommonInterfaceConfig1 

type WANCommonInterfaceConfig1 struct {
	goupnp.ServiceClient
}

WANCommonInterfaceConfig1 is a client for UPnP SOAP service with URN "urn:schemas-upnp-org:service:WANCommonInterfaceConfig:1". See goupnp.ServiceClient, which contains RootDevice and Service attributes which are provided for informational value.

func NewWANCommonInterfaceConfig1Clients 

func NewWANCommonInterfaceConfig1Clients() (clients []*WANCommonInterfaceConfig1, errors []error, err error)

NewWANCommonInterfaceConfig1Clients discovers instances of the service on the network, and returns clients to any that are found. errors will contain an error for any devices that replied but which could not be queried, and err will be set if the discovery process failed outright.

This is a typical entry calling point into this package.

func NewWANCommonInterfaceConfig1ClientsByURL 

func NewWANCommonInterfaceConfig1ClientsByURL(loc *url.URL) ([]*WANCommonInterfaceConfig1, error)

NewWANCommonInterfaceConfig1ClientsByURL discovers instances of the service at the given URL, and returns clients to any that are found. An error is returned if there was an error probing the service.

This is a typical entry calling point into this package when reusing an previously discovered service URL.

func NewWANCommonInterfaceConfig1ClientsFromRootDevice 

func NewWANCommonInterfaceConfig1ClientsFromRootDevice(rootDevice *goupnp.RootDevice, loc *url.URL) ([]*WANCommonInterfaceConfig1, error)

NewWANCommonInterfaceConfig1ClientsFromRootDevice discovers instances of the service in a given root device, and returns clients to any that are found. An error is returned if there was not at least one instance of the service within the device. The location parameter is simply assigned to the Location attribute of the wrapped ServiceClient(s).

This is a typical entry calling point into this package when reusing an previously discovered root device.

func (*WANCommonInterfaceConfig1) GetActiveConnection 

func (client *WANCommonInterfaceConfig1) GetActiveConnection(NewActiveConnectionIndex uint16) (NewActiveConnDeviceContainer string, NewActiveConnectionServiceID string, err error)

func (*WANCommonInterfaceConfig1) GetCommonLinkProperties 

func (client *WANCommonInterfaceConfig1) GetCommonLinkProperties() (NewWANAccessType string, NewLayer1UpstreamMaxBitRate uint32, NewLayer1DownstreamMaxBitRate uint32, NewPhysicalLinkStatus string, err error)

Return values:

* NewWANAccessType: allowed values: DSL, POTS, Cable, Ethernet

* NewPhysicalLinkStatus: allowed values: Up, Down

func (*WANCommonInterfaceConfig1) GetEnabledForInternet 

func (client *WANCommonInterfaceConfig1) GetEnabledForInternet() (NewEnabledForInternet bool, err error)

func (*WANCommonInterfaceConfig1) GetMaximumActiveConnections 

func (client *WANCommonInterfaceConfig1) GetMaximumActiveConnections() (NewMaximumActiveConnections uint16, err error)

Return values:

* NewMaximumActiveConnections: allowed value range: minimum=1, step=1

func (*WANCommonInterfaceConfig1) GetTotalBytesReceived 

func (client *WANCommonInterfaceConfig1) GetTotalBytesReceived() (NewTotalBytesReceived uint32, err error)

func (*WANCommonInterfaceConfig1) GetTotalBytesSent 

func (client *WANCommonInterfaceConfig1) GetTotalBytesSent() (NewTotalBytesSent uint32, err error)

func (*WANCommonInterfaceConfig1) GetTotalPacketsReceived 

func (client *WANCommonInterfaceConfig1) GetTotalPacketsReceived() (NewTotalPacketsReceived uint32, err error)

func (*WANCommonInterfaceConfig1) GetTotalPacketsSent 

func (client *WANCommonInterfaceConfig1) GetTotalPacketsSent() (NewTotalPacketsSent uint32, err error)

func (*WANCommonInterfaceConfig1) GetWANAccessProvider 

func (client *WANCommonInterfaceConfig1) GetWANAccessProvider() (NewWANAccessProvider string, err error)

func (*WANCommonInterfaceConfig1) SetEnabledForInternet 

func (client *WANCommonInterfaceConfig1) SetEnabledForInternet(NewEnabledForInternet bool) (err error)

type WANDSLLinkConfig1 

type WANDSLLinkConfig1 struct {
	goupnp.ServiceClient
}

WANDSLLinkConfig1 is a client for UPnP SOAP service with URN "urn:schemas-upnp-org:service:WANDSLLinkConfig:1". See goupnp.ServiceClient, which contains RootDevice and Service attributes which are provided for informational value.

func NewWANDSLLinkConfig1Clients 

func NewWANDSLLinkConfig1Clients() (clients []*WANDSLLinkConfig1, errors []error, err error)

NewWANDSLLinkConfig1Clients discovers instances of the service on the network, and returns clients to any that are found. errors will contain an error for any devices that replied but which could not be queried, and err will be set if the discovery process failed outright.

This is a typical entry calling point into this package.

func NewWANDSLLinkConfig1ClientsByURL 

func NewWANDSLLinkConfig1ClientsByURL(loc *url.URL) ([]*WANDSLLinkConfig1, error)

NewWANDSLLinkConfig1ClientsByURL discovers instances of the service at the given URL, and returns clients to any that are found. An error is returned if there was an error probing the service.

This is a typical entry calling point into this package when reusing an previously discovered service URL.

func NewWANDSLLinkConfig1ClientsFromRootDevice 

func NewWANDSLLinkConfig1ClientsFromRootDevice(rootDevice *goupnp.RootDevice, loc *url.URL) ([]*WANDSLLinkConfig1, error)

NewWANDSLLinkConfig1ClientsFromRootDevice discovers instances of the service in a given root device, and returns clients to any that are found. An error is returned if there was not at least one instance of the service within the device. The location parameter is simply assigned to the Location attribute of the wrapped ServiceClient(s).

This is a typical entry calling point into this package when reusing an previously discovered root device.

func (*WANDSLLinkConfig1) GetATMEncapsulation 

func (client *WANDSLLinkConfig1) GetATMEncapsulation() (NewATMEncapsulation string, err error)

func (*WANDSLLinkConfig1) GetAutoConfig 

func (client *WANDSLLinkConfig1) GetAutoConfig() (NewAutoConfig bool, err error)

func (*WANDSLLinkConfig1) GetDSLLinkInfo 

func (client *WANDSLLinkConfig1) GetDSLLinkInfo() (NewLinkType string, NewLinkStatus string, err error)

Return values:

* NewLinkStatus: allowed values: Up, Down

func (*WANDSLLinkConfig1) GetDestinationAddress 

func (client *WANDSLLinkConfig1) GetDestinationAddress() (NewDestinationAddress string, err error)

func (*WANDSLLinkConfig1) GetFCSPreserved 

func (client *WANDSLLinkConfig1) GetFCSPreserved() (NewFCSPreserved bool, err error)

func (*WANDSLLinkConfig1) GetModulationType 

func (client *WANDSLLinkConfig1) GetModulationType() (NewModulationType string, err error)

func (*WANDSLLinkConfig1) SetATMEncapsulation 

func (client *WANDSLLinkConfig1) SetATMEncapsulation(NewATMEncapsulation string) (err error)

func (*WANDSLLinkConfig1) SetDSLLinkType 

func (client *WANDSLLinkConfig1) SetDSLLinkType(NewLinkType string) (err error)

func (*WANDSLLinkConfig1) SetDestinationAddress 

func (client *WANDSLLinkConfig1) SetDestinationAddress(NewDestinationAddress string) (err error)

func (*WANDSLLinkConfig1) SetFCSPreserved 

func (client *WANDSLLinkConfig1) SetFCSPreserved(NewFCSPreserved bool) (err error)

type WANEthernetLinkConfig1 

type WANEthernetLinkConfig1 struct {
	goupnp.ServiceClient
}

WANEthernetLinkConfig1 is a client for UPnP SOAP service with URN "urn:schemas-upnp-org:service:WANEthernetLinkConfig:1". See goupnp.ServiceClient, which contains RootDevice and Service attributes which are provided for informational value.

func NewWANEthernetLinkConfig1Clients 

func NewWANEthernetLinkConfig1Clients() (clients []*WANEthernetLinkConfig1, errors []error, err error)

NewWANEthernetLinkConfig1Clients discovers instances of the service on the network, and returns clients to any that are found. errors will contain an error for any devices that replied but which could not be queried, and err will be set if the discovery process failed outright.

This is a typical entry calling point into this package.

func NewWANEthernetLinkConfig1ClientsByURL 

func NewWANEthernetLinkConfig1ClientsByURL(loc *url.URL) ([]*WANEthernetLinkConfig1, error)

NewWANEthernetLinkConfig1ClientsByURL discovers instances of the service at the given URL, and returns clients to any that are found. An error is returned if there was an error probing the service.

This is a typical entry calling point into this package when reusing an previously discovered service URL.

func NewWANEthernetLinkConfig1ClientsFromRootDevice 

func NewWANEthernetLinkConfig1ClientsFromRootDevice(rootDevice *goupnp.RootDevice, loc *url.URL) ([]*WANEthernetLinkConfig1, error)

NewWANEthernetLinkConfig1ClientsFromRootDevice discovers instances of the service in a given root device, and returns clients to any that are found. An error is returned if there was not at least one instance of the service within the device. The location parameter is simply assigned to the Location attribute of the wrapped ServiceClient(s).

This is a typical entry calling point into this package when reusing an previously discovered root device.

func (*WANEthernetLinkConfig1) GetEthernetLinkStatus 

func (client *WANEthernetLinkConfig1) GetEthernetLinkStatus() (NewEthernetLinkStatus string, err error)

Return values:

* NewEthernetLinkStatus: allowed values: Up, Down

type WANIPConnection1 

type WANIPConnection1 struct {
	goupnp.ServiceClient
}

WANIPConnection1 is a client for UPnP SOAP service with URN "urn:schemas-upnp-org:service:WANIPConnection:1". See goupnp.ServiceClient, which contains RootDevice and Service attributes which are provided for informational value.

func NewWANIPConnection1Clients 

func NewWANIPConnection1Clients(ctx context.Context) (clients []*WANIPConnection1, errors []error, err error)

NewWANIPConnection1Clients discovers instances of the service on the network, and returns clients to any that are found. errors will contain an error for any devices that replied but which could not be queried, and err will be set if the discovery process failed outright.

This is a typical entry calling point into this package.

func NewWANIPConnection1ClientsByURL 

func NewWANIPConnection1ClientsByURL(loc *url.URL) ([]*WANIPConnection1, error)

NewWANIPConnection1ClientsByURL discovers instances of the service at the given URL, and returns clients to any that are found. An error is returned if there was an error probing the service.

This is a typical entry calling point into this package when reusing an previously discovered service URL.

func NewWANIPConnection1ClientsFromRootDevice 

func NewWANIPConnection1ClientsFromRootDevice(rootDevice *goupnp.RootDevice, loc *url.URL) ([]*WANIPConnection1, error)

NewWANIPConnection1ClientsFromRootDevice discovers instances of the service in a given root device, and returns clients to any that are found. An error is returned if there was not at least one instance of the service within the device. The location parameter is simply assigned to the Location attribute of the wrapped ServiceClient(s).

This is a typical entry calling point into this package when reusing an previously discovered root device.

func (*WANIPConnection1) AddPortMapping 

func (client *WANIPConnection1) AddPortMapping(NewRemoteHost string, NewExternalPort uint16, NewProtocol string, NewInternalPort uint16, NewInternalClient string, NewEnabled bool, NewPortMappingDescription string, NewLeaseDuration uint32) (err error)

func (*WANIPConnection1) DeletePortMapping 

func (client *WANIPConnection1) DeletePortMapping(NewRemoteHost string, NewExternalPort uint16, NewProtocol string) (err error)

func (*WANIPConnection1) ForceTermination 

func (client *WANIPConnection1) ForceTermination() (err error)

func (*WANIPConnection1) GetAutoDisconnectTime 

func (client *WANIPConnection1) GetAutoDisconnectTime() (NewAutoDisconnectTime uint32, err error)

func (*WANIPConnection1) GetConnectionTypeInfo 

func (client *WANIPConnection1) GetConnectionTypeInfo() (NewConnectionType string, NewPossibleConnectionTypes string, err error)

Return values:

* NewPossibleConnectionTypes: allowed values: Unconfigured, IP_Routed, IP_Bridged

func (*WANIPConnection1) GetExternalIPAddress 

func (client *WANIPConnection1) GetExternalIPAddress() (NewExternalIPAddress string, err error)

func (*WANIPConnection1) GetGenericPortMappingEntry 

func (client *WANIPConnection1) GetGenericPortMappingEntry(NewPortMappingIndex uint16) (NewRemoteHost string, NewExternalPort uint16, NewProtocol string, NewInternalPort uint16, NewInternalClient string, NewEnabled bool, NewPortMappingDescription string, NewLeaseDuration uint32, err error)

Return values:

* NewProtocol: allowed values: TCP, UDP

func (*WANIPConnection1) GetIdleDisconnectTime 

func (client *WANIPConnection1) GetIdleDisconnectTime() (NewIdleDisconnectTime uint32, err error)

func (*WANIPConnection1) GetNATRSIPStatus 

func (client *WANIPConnection1) GetNATRSIPStatus() (NewRSIPAvailable bool, NewNATEnabled bool, err error)

func (*WANIPConnection1) GetSpecificPortMappingEntry 

func (client *WANIPConnection1) GetSpecificPortMappingEntry(NewRemoteHost string, NewExternalPort uint16, NewProtocol string) (NewInternalPort uint16, NewInternalClient string, NewEnabled bool, NewPortMappingDescription string, NewLeaseDuration uint32, err error)

func (*WANIPConnection1) GetStatusInfo 

func (client *WANIPConnection1) GetStatusInfo() (NewConnectionStatus string, NewLastConnectionError string, NewUptime uint32, err error)

Return values:

* NewConnectionStatus: allowed values: Unconfigured, Connected, Disconnected

* NewLastConnectionError: allowed values: ERROR_NONE

func (*WANIPConnection1) GetWarnDisconnectDelay 

func (client *WANIPConnection1) GetWarnDisconnectDelay() (NewWarnDisconnectDelay uint32, err error)

func (*WANIPConnection1) RequestConnection 

func (client *WANIPConnection1) RequestConnection() (err error)

func (*WANIPConnection1) RequestTermination 

func (client *WANIPConnection1) RequestTermination() (err error)

func (*WANIPConnection1) SetAutoDisconnectTime 

func (client *WANIPConnection1) SetAutoDisconnectTime(NewAutoDisconnectTime uint32) (err error)

func (*WANIPConnection1) SetConnectionType 

func (client *WANIPConnection1) SetConnectionType(NewConnectionType string) (err error)

func (*WANIPConnection1) SetIdleDisconnectTime 

func (client *WANIPConnection1) SetIdleDisconnectTime(NewIdleDisconnectTime uint32) (err error)

func (*WANIPConnection1) SetWarnDisconnectDelay 

func (client *WANIPConnection1) SetWarnDisconnectDelay(NewWarnDisconnectDelay uint32) (err error)

type WANPOTSLinkConfig1 

type WANPOTSLinkConfig1 struct {
	goupnp.ServiceClient
}

WANPOTSLinkConfig1 is a client for UPnP SOAP service with URN "urn:schemas-upnp-org:service:WANPOTSLinkConfig:1". See goupnp.ServiceClient, which contains RootDevice and Service attributes which are provided for informational value.

func NewWANPOTSLinkConfig1Clients 

func NewWANPOTSLinkConfig1Clients() (clients []*WANPOTSLinkConfig1, errors []error, err error)

NewWANPOTSLinkConfig1Clients discovers instances of the service on the network, and returns clients to any that are found. errors will contain an error for any devices that replied but which could not be queried, and err will be set if the discovery process failed outright.

This is a typical entry calling point into this package.

func NewWANPOTSLinkConfig1ClientsByURL 

func NewWANPOTSLinkConfig1ClientsByURL(loc *url.URL) ([]*WANPOTSLinkConfig1, error)

NewWANPOTSLinkConfig1ClientsByURL discovers instances of the service at the given URL, and returns clients to any that are found. An error is returned if there was an error probing the service.

This is a typical entry calling point into this package when reusing an previously discovered service URL.

func NewWANPOTSLinkConfig1ClientsFromRootDevice 

func NewWANPOTSLinkConfig1ClientsFromRootDevice(rootDevice *goupnp.RootDevice, loc *url.URL) ([]*WANPOTSLinkConfig1, error)

NewWANPOTSLinkConfig1ClientsFromRootDevice discovers instances of the service in a given root device, and returns clients to any that are found. An error is returned if there was not at least one instance of the service within the device. The location parameter is simply assigned to the Location attribute of the wrapped ServiceClient(s).

This is a typical entry calling point into this package when reusing an previously discovered root device.

func (*WANPOTSLinkConfig1) GetCallRetryInfo 

func (client *WANPOTSLinkConfig1) GetCallRetryInfo() (NewNumberOfRetries uint32, NewDelayBetweenRetries uint32, err error)

func (*WANPOTSLinkConfig1) GetDataCompression 

func (client *WANPOTSLinkConfig1) GetDataCompression() (NewDataCompression string, err error)

func (*WANPOTSLinkConfig1) GetDataModulationSupported 

func (client *WANPOTSLinkConfig1) GetDataModulationSupported() (NewDataModulationSupported string, err error)

func (*WANPOTSLinkConfig1) GetDataProtocol 

func (client *WANPOTSLinkConfig1) GetDataProtocol() (NewDataProtocol string, err error)

func (*WANPOTSLinkConfig1) GetFclass 

func (client *WANPOTSLinkConfig1) GetFclass() (NewFclass string, err error)

func (*WANPOTSLinkConfig1) GetISPInfo 

func (client *WANPOTSLinkConfig1) GetISPInfo() (NewISPPhoneNumber string, NewISPInfo string, NewLinkType string, err error)

Return values:

* NewLinkType: allowed values: PPP_Dialup

func (*WANPOTSLinkConfig1) GetPlusVTRCommandSupported 

func (client *WANPOTSLinkConfig1) GetPlusVTRCommandSupported() (NewPlusVTRCommandSupported bool, err error)

func (*WANPOTSLinkConfig1) SetCallRetryInfo 

func (client *WANPOTSLinkConfig1) SetCallRetryInfo(NewNumberOfRetries uint32, NewDelayBetweenRetries uint32) (err error)

func (*WANPOTSLinkConfig1) SetISPInfo 

func (client *WANPOTSLinkConfig1) SetISPInfo(NewISPPhoneNumber string, NewISPInfo string, NewLinkType string) (err error)

type WANPPPConnection1 

type WANPPPConnection1 struct {
	goupnp.ServiceClient
}

WANPPPConnection1 is a client for UPnP SOAP service with URN "urn:schemas-upnp-org:service:WANPPPConnection:1". See goupnp.ServiceClient, which contains RootDevice and Service attributes which are provided for informational value.

func NewWANPPPConnection1Clients 

func NewWANPPPConnection1Clients(ctx context.Context) (clients []*WANPPPConnection1, errors []error, err error)

NewWANPPPConnection1Clients discovers instances of the service on the network, and returns clients to any that are found. errors will contain an error for any devices that replied but which could not be queried, and err will be set if the discovery process failed outright.

This is a typical entry calling point into this package.

func NewWANPPPConnection1ClientsByURL 

func NewWANPPPConnection1ClientsByURL(loc *url.URL) ([]*WANPPPConnection1, error)

NewWANPPPConnection1ClientsByURL discovers instances of the service at the given URL, and returns clients to any that are found. An error is returned if there was an error probing the service.

This is a typical entry calling point into this package when reusing an previously discovered service URL.

func NewWANPPPConnection1ClientsFromRootDevice 

func NewWANPPPConnection1ClientsFromRootDevice(rootDevice *goupnp.RootDevice, loc *url.URL) ([]*WANPPPConnection1, error)

NewWANPPPConnection1ClientsFromRootDevice discovers instances of the service in a given root device, and returns clients to any that are found. An error is returned if there was not at least one instance of the service within the device. The location parameter is simply assigned to the Location attribute of the wrapped ServiceClient(s).

This is a typical entry calling point into this package when reusing an previously discovered root device.

func (*WANPPPConnection1) AddPortMapping 

func (client *WANPPPConnection1) AddPortMapping(NewRemoteHost string, NewExternalPort uint16, NewProtocol string, NewInternalPort uint16, NewInternalClient string, NewEnabled bool, NewPortMappingDescription string, NewLeaseDuration uint32) (err error)

func (*WANPPPConnection1) ConfigureConnection 

func (client *WANPPPConnection1) ConfigureConnection(NewUserName string, NewPassword string) (err error)

func (*WANPPPConnection1) DeletePortMapping 

func (client *WANPPPConnection1) DeletePortMapping(NewRemoteHost string, NewExternalPort uint16, NewProtocol string) (err error)

func (*WANPPPConnection1) ForceTermination 

func (client *WANPPPConnection1) ForceTermination() (err error)

func (*WANPPPConnection1) GetAutoDisconnectTime 

func (client *WANPPPConnection1) GetAutoDisconnectTime() (NewAutoDisconnectTime uint32, err error)

func (*WANPPPConnection1) GetConnectionTypeInfo 

func (client *WANPPPConnection1) GetConnectionTypeInfo() (NewConnectionType string, NewPossibleConnectionTypes string, err error)

Return values:

* NewPossibleConnectionTypes: allowed values: Unconfigured, IP_Routed, DHCP_Spoofed, PPPoE_Bridged, PPTP_Relay, L2TP_Relay, PPPoE_Relay

func (*WANPPPConnection1) GetExternalIPAddress 

func (client *WANPPPConnection1) GetExternalIPAddress() (NewExternalIPAddress string, err error)

func (*WANPPPConnection1) GetGenericPortMappingEntry 

func (client *WANPPPConnection1) GetGenericPortMappingEntry(NewPortMappingIndex uint16) (NewRemoteHost string, NewExternalPort uint16, NewProtocol string, NewInternalPort uint16, NewInternalClient string, NewEnabled bool, NewPortMappingDescription string, NewLeaseDuration uint32, err error)

Return values:

* NewProtocol: allowed values: TCP, UDP

func (*WANPPPConnection1) GetIdleDisconnectTime 

func (client *WANPPPConnection1) GetIdleDisconnectTime() (NewIdleDisconnectTime uint32, err error)

func (*WANPPPConnection1) GetLinkLayerMaxBitRates 

func (client *WANPPPConnection1) GetLinkLayerMaxBitRates() (NewUpstreamMaxBitRate uint32, NewDownstreamMaxBitRate uint32, err error)

func (*WANPPPConnection1) GetNATRSIPStatus 

func (client *WANPPPConnection1) GetNATRSIPStatus() (NewRSIPAvailable bool, NewNATEnabled bool, err error)

func (*WANPPPConnection1) GetPPPAuthenticationProtocol 

func (client *WANPPPConnection1) GetPPPAuthenticationProtocol() (NewPPPAuthenticationProtocol string, err error)

func (*WANPPPConnection1) GetPPPCompressionProtocol 

func (client *WANPPPConnection1) GetPPPCompressionProtocol() (NewPPPCompressionProtocol string, err error)

func (*WANPPPConnection1) GetPPPEncryptionProtocol 

func (client *WANPPPConnection1) GetPPPEncryptionProtocol() (NewPPPEncryptionProtocol string, err error)

func (*WANPPPConnection1) GetPassword 

func (client *WANPPPConnection1) GetPassword() (NewPassword string, err error)

func (*WANPPPConnection1) GetSpecificPortMappingEntry 

func (client *WANPPPConnection1) GetSpecificPortMappingEntry(NewRemoteHost string, NewExternalPort uint16, NewProtocol string) (NewInternalPort uint16, NewInternalClient string, NewEnabled bool, NewPortMappingDescription string, NewLeaseDuration uint32, err error)

func (*WANPPPConnection1) GetStatusInfo 

func (client *WANPPPConnection1) GetStatusInfo() (NewConnectionStatus string, NewLastConnectionError string, NewUptime uint32, err error)

Return values:

* NewConnectionStatus: allowed values: Unconfigured, Connected, Disconnected

* NewLastConnectionError: allowed values: ERROR_NONE

func (*WANPPPConnection1) GetUserName 

func (client *WANPPPConnection1) GetUserName() (NewUserName string, err error)

func (*WANPPPConnection1) GetWarnDisconnectDelay 

func (client *WANPPPConnection1) GetWarnDisconnectDelay() (NewWarnDisconnectDelay uint32, err error)

func (*WANPPPConnection1) RequestConnection 

func (client *WANPPPConnection1) RequestConnection() (err error)

func (*WANPPPConnection1) RequestTermination 

func (client *WANPPPConnection1) RequestTermination() (err error)

func (*WANPPPConnection1) SetAutoDisconnectTime 

func (client *WANPPPConnection1) SetAutoDisconnectTime(NewAutoDisconnectTime uint32) (err error)

func (*WANPPPConnection1) SetConnectionType 

func (client *WANPPPConnection1) SetConnectionType(NewConnectionType string) (err error)

func (*WANPPPConnection1) SetIdleDisconnectTime 

func (client *WANPPPConnection1) SetIdleDisconnectTime(NewIdleDisconnectTime uint32) (err error)

func (*WANPPPConnection1) SetWarnDisconnectDelay 

func (client *WANPPPConnection1) SetWarnDisconnectDelay(NewWarnDisconnectDelay uint32) (err error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.