internetgateway2

package
v0.9.25 Latest Latest
Warning

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

Go to latest
Published: May 27, 2015 License: BSD-2-Clause, LGPL-2.1-or-later Imports: 3 Imported by: 0

Documentation

Overview

Client for UPnP Device Control Protocol Internet Gateway Device v2.

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

Typically, use one of the New* functions to discover services on the local network.

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_WANConnectionDevice_2 = "urn:schemas-upnp-org:device:WANConnectionDevice:2"
	URN_WANDevice_1           = "urn:schemas-upnp-org:device:WANDevice:1"
	URN_WANDevice_2           = "urn:schemas-upnp-org:device:WANDevice:2"
)

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_WANIPConnection_2          = "urn:schemas-upnp-org:service:WANIPConnection:2"
	URN_WANIPv6FirewallControl_1   = "urn:schemas-upnp-org:service:WANIPv6FirewallControl: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 (*LANHostConfigManagement1) DeleteDNSServer

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

Arguments:

* NewDNSServers:

func (*LANHostConfigManagement1) DeleteIPRouter

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

Arguments:

* NewIPRouters:

func (*LANHostConfigManagement1) DeleteReservedAddress

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

Arguments:

* NewReservedAddresses:

func (*LANHostConfigManagement1) GetAddressRange

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

Return values:

* NewMinAddress:

* NewMaxAddress:

func (*LANHostConfigManagement1) GetDHCPRelay

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

Return values:

* NewDHCPRelay:

func (*LANHostConfigManagement1) GetDHCPServerConfigurable

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

Return values:

* NewDHCPServerConfigurable:

func (*LANHostConfigManagement1) GetDNSServers

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

Return values:

* NewDNSServers:

func (*LANHostConfigManagement1) GetDomainName

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

Return values:

* NewDomainName:

func (*LANHostConfigManagement1) GetIPRoutersList

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

Return values:

* NewIPRouters:

func (*LANHostConfigManagement1) GetReservedAddresses

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

Return values:

* NewReservedAddresses:

func (*LANHostConfigManagement1) GetSubnetMask

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

Return values:

* NewSubnetMask:

func (*LANHostConfigManagement1) SetAddressRange

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

Arguments:

* NewMinAddress:

* NewMaxAddress:

func (*LANHostConfigManagement1) SetDHCPRelay

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

Arguments:

* NewDHCPRelay:

func (*LANHostConfigManagement1) SetDHCPServerConfigurable

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

Arguments:

* NewDHCPServerConfigurable:

func (*LANHostConfigManagement1) SetDNSServer

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

Arguments:

* NewDNSServers:

func (*LANHostConfigManagement1) SetDomainName

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

Arguments:

* NewDomainName:

func (*LANHostConfigManagement1) SetIPRouter

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

Arguments:

* NewIPRouters:

func (*LANHostConfigManagement1) SetReservedAddress

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

Arguments:

* NewReservedAddresses:

func (*LANHostConfigManagement1) SetSubnetMask

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

Arguments:

* NewSubnetMask:

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 (*Layer3Forwarding1) GetDefaultConnectionService

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

Return values:

* NewDefaultConnectionService:

func (*Layer3Forwarding1) SetDefaultConnectionService

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

Arguments:

* NewDefaultConnectionService:

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 (*WANCableLinkConfig1) GetBPIEncryptionEnabled

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

Return values:

* NewBPIEncryptionEnabled:

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)

Return values:

* NewConfigFile:

func (*WANCableLinkConfig1) GetDownstreamFrequency

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

Return values:

* NewDownstreamFrequency:

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)

Return values:

* NewTFTPServer:

func (*WANCableLinkConfig1) GetUpstreamChannelID

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

Return values:

* NewUpstreamChannelID:

func (*WANCableLinkConfig1) GetUpstreamFrequency

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

Return values:

* NewUpstreamFrequency:

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)

Return values:

* NewUpstreamPowerLevel:

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 (*WANCommonInterfaceConfig1) GetActiveConnection

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

Arguments:

* NewActiveConnectionIndex:

Return values:

* NewActiveConnDeviceContainer:

* NewActiveConnectionServiceID:

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

* NewLayer1UpstreamMaxBitRate:

* NewLayer1DownstreamMaxBitRate:

* NewPhysicalLinkStatus: allowed values: Up, Down

func (*WANCommonInterfaceConfig1) GetEnabledForInternet

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

Return values:

* NewEnabledForInternet:

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)

Return values:

* NewTotalBytesReceived:

func (*WANCommonInterfaceConfig1) GetTotalBytesSent

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

Return values:

* NewTotalBytesSent:

func (*WANCommonInterfaceConfig1) GetTotalPacketsReceived

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

Return values:

* NewTotalPacketsReceived:

func (*WANCommonInterfaceConfig1) GetTotalPacketsSent

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

Return values:

* NewTotalPacketsSent:

func (*WANCommonInterfaceConfig1) GetWANAccessProvider

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

Return values:

* NewWANAccessProvider:

func (*WANCommonInterfaceConfig1) SetEnabledForInternet

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

Arguments:

* NewEnabledForInternet:

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 (*WANDSLLinkConfig1) GetATMEncapsulation

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

Return values:

* NewATMEncapsulation:

func (*WANDSLLinkConfig1) GetAutoConfig

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

Return values:

* NewAutoConfig:

func (*WANDSLLinkConfig1) GetDSLLinkInfo

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

Return values:

* NewLinkType:

* NewLinkStatus: allowed values: Up, Down

func (*WANDSLLinkConfig1) GetDestinationAddress

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

Return values:

* NewDestinationAddress:

func (*WANDSLLinkConfig1) GetFCSPreserved

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

Return values:

* NewFCSPreserved:

func (*WANDSLLinkConfig1) GetModulationType

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

Return values:

* NewModulationType:

func (*WANDSLLinkConfig1) SetATMEncapsulation

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

Arguments:

* NewATMEncapsulation:

func (*WANDSLLinkConfig1) SetDSLLinkType

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

Arguments:

* NewLinkType:

func (*WANDSLLinkConfig1) SetDestinationAddress

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

Arguments:

* NewDestinationAddress:

func (*WANDSLLinkConfig1) SetFCSPreserved

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

Arguments:

* NewFCSPreserved:

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 (*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() (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 (*WANIPConnection1) AddPortMapping

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

Arguments:

* NewRemoteHost:

* NewExternalPort:

* NewProtocol: allowed values: TCP, UDP

* NewInternalPort:

* NewInternalClient:

* NewEnabled:

* NewPortMappingDescription:

* NewLeaseDuration:

func (*WANIPConnection1) DeletePortMapping

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

Arguments:

* NewRemoteHost:

* NewExternalPort:

* NewProtocol: allowed values: TCP, UDP

func (*WANIPConnection1) ForceTermination

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

func (*WANIPConnection1) GetAutoDisconnectTime

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

Return values:

* NewAutoDisconnectTime:

func (*WANIPConnection1) GetConnectionTypeInfo

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

Return values:

* NewConnectionType:

* NewPossibleConnectionTypes: allowed values: Unconfigured, IP_Routed, IP_Bridged

func (*WANIPConnection1) GetExternalIPAddress

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

Return values:

* NewExternalIPAddress:

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)

Arguments:

* NewPortMappingIndex:

Return values:

* NewRemoteHost:

* NewExternalPort:

* NewProtocol: allowed values: TCP, UDP

* NewInternalPort:

* NewInternalClient:

* NewEnabled:

* NewPortMappingDescription:

* NewLeaseDuration:

func (*WANIPConnection1) GetIdleDisconnectTime

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

Return values:

* NewIdleDisconnectTime:

func (*WANIPConnection1) GetNATRSIPStatus

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

Return values:

* NewRSIPAvailable:

* NewNATEnabled:

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)

Arguments:

* NewRemoteHost:

* NewExternalPort:

* NewProtocol: allowed values: TCP, UDP

Return values:

* NewInternalPort:

* NewInternalClient:

* NewEnabled:

* NewPortMappingDescription:

* NewLeaseDuration:

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

* NewUptime:

func (*WANIPConnection1) GetWarnDisconnectDelay

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

Return values:

* NewWarnDisconnectDelay:

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)

Arguments:

* NewAutoDisconnectTime:

func (*WANIPConnection1) SetConnectionType

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

Arguments:

* NewConnectionType:

func (*WANIPConnection1) SetIdleDisconnectTime

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

Arguments:

* NewIdleDisconnectTime:

func (*WANIPConnection1) SetWarnDisconnectDelay

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

Arguments:

* NewWarnDisconnectDelay:

type WANIPConnection2

type WANIPConnection2 struct {
	goupnp.ServiceClient
}

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

func NewWANIPConnection2Clients

func NewWANIPConnection2Clients() (clients []*WANIPConnection2, errors []error, err error)

NewWANIPConnection2Clients 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 (*WANIPConnection2) AddAnyPortMapping

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

Arguments:

* NewRemoteHost:

* NewExternalPort:

* NewProtocol: allowed values: TCP, UDP

* NewInternalPort: allowed value range: minimum=1, maximum=65535

* NewInternalClient:

* NewEnabled:

* NewPortMappingDescription:

* NewLeaseDuration: allowed value range: minimum=0, maximum=604800

Return values:

* NewReservedPort:

func (*WANIPConnection2) AddPortMapping

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

Arguments:

* NewRemoteHost:

* NewExternalPort:

* NewProtocol: allowed values: TCP, UDP

* NewInternalPort: allowed value range: minimum=1, maximum=65535

* NewInternalClient:

* NewEnabled:

* NewPortMappingDescription:

* NewLeaseDuration: allowed value range: minimum=0, maximum=604800

func (*WANIPConnection2) DeletePortMapping

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

Arguments:

* NewRemoteHost:

* NewExternalPort:

* NewProtocol: allowed values: TCP, UDP

func (*WANIPConnection2) DeletePortMappingRange

func (client *WANIPConnection2) DeletePortMappingRange(NewStartPort uint16, NewEndPort uint16, NewProtocol string, NewManage bool) (err error)

Arguments:

* NewStartPort:

* NewEndPort:

* NewProtocol: allowed values: TCP, UDP

* NewManage:

func (*WANIPConnection2) ForceTermination

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

func (*WANIPConnection2) GetAutoDisconnectTime

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

Return values:

* NewAutoDisconnectTime:

func (*WANIPConnection2) GetConnectionTypeInfo

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

Return values:

* NewConnectionType: allowed values: Unconfigured, IP_Routed, IP_Bridged

* NewPossibleConnectionTypes:

func (*WANIPConnection2) GetExternalIPAddress

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

Return values:

* NewExternalIPAddress:

func (*WANIPConnection2) GetGenericPortMappingEntry

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

Arguments:

* NewPortMappingIndex:

Return values:

* NewRemoteHost:

* NewExternalPort:

* NewProtocol: allowed values: TCP, UDP

* NewInternalPort: allowed value range: minimum=1, maximum=65535

* NewInternalClient:

* NewEnabled:

* NewPortMappingDescription:

* NewLeaseDuration: allowed value range: minimum=0, maximum=604800

func (*WANIPConnection2) GetIdleDisconnectTime

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

Return values:

* NewIdleDisconnectTime:

func (*WANIPConnection2) GetListOfPortMappings

func (client *WANIPConnection2) GetListOfPortMappings(NewStartPort uint16, NewEndPort uint16, NewProtocol string, NewManage bool, NewNumberOfPorts uint16) (NewPortListing string, err error)

Arguments:

* NewStartPort:

* NewEndPort:

* NewProtocol: allowed values: TCP, UDP

* NewManage:

* NewNumberOfPorts:

Return values:

* NewPortListing:

func (*WANIPConnection2) GetNATRSIPStatus

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

Return values:

* NewRSIPAvailable:

* NewNATEnabled:

func (*WANIPConnection2) GetSpecificPortMappingEntry

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

Arguments:

* NewRemoteHost:

* NewExternalPort:

* NewProtocol: allowed values: TCP, UDP

Return values:

* NewInternalPort: allowed value range: minimum=1, maximum=65535

* NewInternalClient:

* NewEnabled:

* NewPortMappingDescription:

* NewLeaseDuration: allowed value range: minimum=0, maximum=604800

func (*WANIPConnection2) GetStatusInfo

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

Return values:

* NewConnectionStatus: allowed values: Unconfigured, Connected, Disconnected

* NewLastConnectionError: allowed values: ERROR_NONE

* NewUptime:

func (*WANIPConnection2) GetWarnDisconnectDelay

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

Return values:

* NewWarnDisconnectDelay:

func (*WANIPConnection2) RequestConnection

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

func (*WANIPConnection2) RequestTermination

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

func (*WANIPConnection2) SetAutoDisconnectTime

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

Arguments:

* NewAutoDisconnectTime:

func (*WANIPConnection2) SetConnectionType

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

Arguments:

* NewConnectionType: allowed values: Unconfigured, IP_Routed, IP_Bridged

func (*WANIPConnection2) SetIdleDisconnectTime

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

Arguments:

* NewIdleDisconnectTime:

func (*WANIPConnection2) SetWarnDisconnectDelay

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

Arguments:

* NewWarnDisconnectDelay:

type WANIPv6FirewallControl1

type WANIPv6FirewallControl1 struct {
	goupnp.ServiceClient
}

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

func NewWANIPv6FirewallControl1Clients

func NewWANIPv6FirewallControl1Clients() (clients []*WANIPv6FirewallControl1, errors []error, err error)

NewWANIPv6FirewallControl1Clients 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 (*WANIPv6FirewallControl1) AddPinhole

func (client *WANIPv6FirewallControl1) AddPinhole(RemoteHost string, RemotePort uint16, InternalClient string, InternalPort uint16, Protocol uint16, LeaseTime uint32) (UniqueID uint16, err error)

Arguments:

* RemoteHost:

* RemotePort:

* InternalClient:

* InternalPort:

* Protocol:

* LeaseTime: allowed value range: minimum=1, maximum=86400

Return values:

* UniqueID:

func (*WANIPv6FirewallControl1) CheckPinholeWorking

func (client *WANIPv6FirewallControl1) CheckPinholeWorking(UniqueID uint16) (IsWorking bool, err error)

Arguments:

* UniqueID:

Return values:

* IsWorking:

func (*WANIPv6FirewallControl1) DeletePinhole

func (client *WANIPv6FirewallControl1) DeletePinhole(UniqueID uint16) (err error)

Arguments:

* UniqueID:

func (*WANIPv6FirewallControl1) GetFirewallStatus

func (client *WANIPv6FirewallControl1) GetFirewallStatus() (FirewallEnabled bool, InboundPinholeAllowed bool, err error)

Return values:

* FirewallEnabled:

* InboundPinholeAllowed:

func (*WANIPv6FirewallControl1) GetOutboundPinholeTimeout

func (client *WANIPv6FirewallControl1) GetOutboundPinholeTimeout(RemoteHost string, RemotePort uint16, InternalClient string, InternalPort uint16, Protocol uint16) (OutboundPinholeTimeout uint32, err error)

Arguments:

* RemoteHost:

* RemotePort:

* InternalClient:

* InternalPort:

* Protocol:

Return values:

* OutboundPinholeTimeout:

func (*WANIPv6FirewallControl1) GetPinholePackets

func (client *WANIPv6FirewallControl1) GetPinholePackets(UniqueID uint16) (PinholePackets uint32, err error)

Arguments:

* UniqueID:

Return values:

* PinholePackets:

func (*WANIPv6FirewallControl1) UpdatePinhole

func (client *WANIPv6FirewallControl1) UpdatePinhole(UniqueID uint16, NewLeaseTime uint32) (err error)

Arguments:

* UniqueID:

* NewLeaseTime: allowed value range: minimum=1, maximum=86400

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 (*WANPOTSLinkConfig1) GetCallRetryInfo

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

Return values:

* NewNumberOfRetries:

* NewDelayBetweenRetries:

func (*WANPOTSLinkConfig1) GetDataCompression

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

Return values:

* NewDataCompression:

func (*WANPOTSLinkConfig1) GetDataModulationSupported

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

Return values:

* NewDataModulationSupported:

func (*WANPOTSLinkConfig1) GetDataProtocol

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

Return values:

* NewDataProtocol:

func (*WANPOTSLinkConfig1) GetFclass

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

Return values:

* NewFclass:

func (*WANPOTSLinkConfig1) GetISPInfo

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

Return values:

* NewISPPhoneNumber:

* NewISPInfo:

* NewLinkType: allowed values: PPP_Dialup

func (*WANPOTSLinkConfig1) GetPlusVTRCommandSupported

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

Return values:

* NewPlusVTRCommandSupported:

func (*WANPOTSLinkConfig1) SetCallRetryInfo

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

Arguments:

* NewNumberOfRetries:

* NewDelayBetweenRetries:

func (*WANPOTSLinkConfig1) SetISPInfo

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

Arguments:

* NewISPPhoneNumber:

* NewISPInfo:

* NewLinkType: allowed values: PPP_Dialup

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() (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 (*WANPPPConnection1) AddPortMapping

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

Arguments:

* NewRemoteHost:

* NewExternalPort:

* NewProtocol: allowed values: TCP, UDP

* NewInternalPort:

* NewInternalClient:

* NewEnabled:

* NewPortMappingDescription:

* NewLeaseDuration:

func (*WANPPPConnection1) ConfigureConnection

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

Arguments:

* NewUserName:

* NewPassword:

func (*WANPPPConnection1) DeletePortMapping

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

Arguments:

* NewRemoteHost:

* NewExternalPort:

* NewProtocol: allowed values: TCP, UDP

func (*WANPPPConnection1) ForceTermination

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

func (*WANPPPConnection1) GetAutoDisconnectTime

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

Return values:

* NewAutoDisconnectTime:

func (*WANPPPConnection1) GetConnectionTypeInfo

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

Return values:

* NewConnectionType:

* 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)

Return values:

* NewExternalIPAddress:

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)

Arguments:

* NewPortMappingIndex:

Return values:

* NewRemoteHost:

* NewExternalPort:

* NewProtocol: allowed values: TCP, UDP

* NewInternalPort:

* NewInternalClient:

* NewEnabled:

* NewPortMappingDescription:

* NewLeaseDuration:

func (*WANPPPConnection1) GetIdleDisconnectTime

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

Return values:

* NewIdleDisconnectTime:

func (*WANPPPConnection1) GetLinkLayerMaxBitRates

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

Return values:

* NewUpstreamMaxBitRate:

* NewDownstreamMaxBitRate:

func (*WANPPPConnection1) GetNATRSIPStatus

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

Return values:

* NewRSIPAvailable:

* NewNATEnabled:

func (*WANPPPConnection1) GetPPPAuthenticationProtocol

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

Return values:

* NewPPPAuthenticationProtocol:

func (*WANPPPConnection1) GetPPPCompressionProtocol

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

Return values:

* NewPPPCompressionProtocol:

func (*WANPPPConnection1) GetPPPEncryptionProtocol

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

Return values:

* NewPPPEncryptionProtocol:

func (*WANPPPConnection1) GetPassword

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

Return values:

* NewPassword:

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)

Arguments:

* NewRemoteHost:

* NewExternalPort:

* NewProtocol: allowed values: TCP, UDP

Return values:

* NewInternalPort:

* NewInternalClient:

* NewEnabled:

* NewPortMappingDescription:

* NewLeaseDuration:

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

* NewUptime:

func (*WANPPPConnection1) GetUserName

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

Return values:

* NewUserName:

func (*WANPPPConnection1) GetWarnDisconnectDelay

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

Return values:

* NewWarnDisconnectDelay:

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)

Arguments:

* NewAutoDisconnectTime:

func (*WANPPPConnection1) SetConnectionType

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

Arguments:

* NewConnectionType:

func (*WANPPPConnection1) SetIdleDisconnectTime

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

Arguments:

* NewIdleDisconnectTime:

func (*WANPPPConnection1) SetWarnDisconnectDelay

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

Arguments:

* NewWarnDisconnectDelay:

Jump to

Keyboard shortcuts

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