The OS specific implementation of an INetworkDiscoverer More...

Inheritance diagram for LinkOS.Plugin.NetworkDiscovererImplementation:

Public Member Functions
void	DirectedBroadcast (IDiscoveryHandler discoveryHandler, string ipAddress, int waitForResponsesTimeout=3000)
	Sends a directed broadcast discovery packet to the subnet specified by ipAddress. This method will wait up to waitForResponsesTimeout milliseconds determining that there are no more discovery responses. Directed broadcasts are defined by the first three subnet octets, followed by 255, such as 192.168.2.255. This method accepts IP addresses of the form, assuming a subnet of 192.168.2: 192.168.2.255 192.168.2.1 (last octet will be replaced with 255) 192.168.2 (will append 255 for the last octet) 192.168.2. (will append 255 for the last octet) This method will invoke the DiscoveryHandler.OnFoundPrinter method for each printer that is found during discovery. DiscoveryHandler.OnDiscoveryFinished will be invoked when the discovery is finished and DiscoveryHandler.OnDiscoveryError will be invoked when any errors are encountered during discovery. If a printer responds to the discovery request more than once, the DiscoveryHandler.OnFoundPrinter event will only be invoked on the first occurrence. More...

void	FindPrinters (IDiscoveryHandler discoveryHandler)
	This method will search the network using a combination of discovery methods to find printers on the network. This is a convenience method that can be used as an alternative to the other discovery methods (e.g. multicast) This method will invoke the DiscoveryHandler.OnFoundPrinter event for each printer that is found during discovery. DiscoveryHandler.OnDiscoveryFinished will be invoked when the discovery is finished and DiscoveryHandler.OnDiscoveryError will be invoked when any errors are encountered during discovery. When DiscoveryHandler.OnDiscoveryError is invoked, the discovery will be canceled and DiscoveryHandler.OnDiscoveryFinished will not be invoked. If a printer responds to the discovery request more than once, the DiscoveryHandler.OnFoundPrinter event will only be invoked on the first occurrence. More...

void	FindPrinters (IDiscoveryHandler discoveryHandler, string[] printersToFind, int waitForResponsesTimeout=3000)
	Sends a discovery request to the list of printer DNS names or IPs in printersToFind. This method will invoke the DiscoveryHandler.OnFoundPrinter method for each printer that is found during discovery. DiscoveryHandler.OnDiscoveryFinished will be invoked when the discovery is finished and DiscoveryHandler.OnDiscoveryError will be invoked when any errors are encountered during discovery. If a printer responds to the discovery request more than once, the DiscoveryHandler.OnFoundPrinter event will only be invoked on the first occurrence. More...

void	LocalBroadcast (IDiscoveryHandler discoveryHandler, int waitForResponsesTimeout=3000)
	Sends a local broadcast packet. This method will wait up to waitForResponsesTimeout milliseconds determining that there are no more discovery responses. This method will invoke the DiscoveryHandler.OnFoundPrinter event for each printer that is found during discovery. DiscoveryHandler.OnDiscoveryFinished will be invoked when the discovery is finished and DiscoveryHandler.OnDiscoveryError will be invoked when any errors are encountered during discovery. When DiscoveryHandler.OnDiscoveryError is invoked, the discovery will be canceled and DiscoveryHandler.OnDiscoveryFinished will not be invoked. If a printer responds to the discovery request more than once, the DiscoveryHandler.OnFoundPrinter event will only be invoked on the first occurrence. More...

void	Multicast (IDiscoveryHandler discoveryHandler, int hops, object androidContext, int waitForResponsesTimeout=3000)
	Sends a multicast discovery packet. This method will wait up to waitForResponsesTimeout milliseconds determining that there are no more discovery responses. If a printer responds to the discovery request more than once, the DiscoveryHandler.OnFoundPrinter event will only be invoked on the first occurrence. More...

void	SubnetSearch (IDiscoveryHandler discoveryHandler, string subnetRange, int waitForResponsesTimeout=3000)
	Sends a discovery packet to the IPs specified in the subnetRange. This method will wait up to waitForResponsesTimeout milliseconds determining that there are no more discovery responses. Subnet searches are defined by the first three subnet octets, followed by a range, such as 192.168.2. This method accepts IP addresses of the form, assuming a subnet of 192.168.2: 192.168.2.254 (will send a discovery packet to 192.168.2.254) 192.168.2.* (will send a discovery packet for the range 192.168.2.1 - 192.168.2.254) 192.168.2.8-* (will send a discovery packet for the range 192.168.2.8 - 192.168.2.254) 192.168.2.37-42 (will send a discovery packet for the range 192.168.2.37 - 192.168.2.42) This method will invoke the DiscoveryHandler.OnFoundPrinter method for each printer that is found during discovery. DiscoveryHandler.OnDiscoveryFinished will be invoked when the discovery is finished and DiscoveryHandler.OnDiscoveryError will be invoked when any errors are encountered during discovery. If a printer responds to the discovery request more than once, the DiscoveryHandler.OnFoundPrinter event will only be invoked on the first occurrence. More...

Detailed Description

The OS specific implementation of an INetworkDiscoverer

Member Function Documentation

void LinkOS.Plugin.NetworkDiscovererImplementation.DirectedBroadcast	(	IDiscoveryHandler	discoveryHandler,
		string	ipAddress,
		int	waitForResponsesTimeout = `3000`
	)

inline

Sends a directed broadcast discovery packet to the subnet specified by ipAddress. This method will wait up to waitForResponsesTimeout milliseconds determining that there are no more discovery responses. Directed broadcasts are defined by the first three subnet octets, followed by 255, such as 192.168.2.255. This method accepts IP addresses of the form, assuming a subnet of 192.168.2: 192.168.2.255 192.168.2.1 (last octet will be replaced with 255) 192.168.2 (will append 255 for the last octet) 192.168.2. (will append 255 for the last octet) This method will invoke the DiscoveryHandler.OnFoundPrinter method for each printer that is found during discovery. DiscoveryHandler.OnDiscoveryFinished will be invoked when the discovery is finished and DiscoveryHandler.OnDiscoveryError will be invoked when any errors are encountered during discovery. If a printer responds to the discovery request more than once, the DiscoveryHandler.OnFoundPrinter event will only be invoked on the first occurrence.

Parameters

discoveryHandler	a DiscoveryHandler instance that is used to handle discovery events (e.g. found a printer, errors, discovery finished).
ipAddress	the IP address of the subnet.
waitForResponsesTimeout	time to wait, in milliseconds, before determining that there are no more discovery responses.

Implements LinkOS.Plugin.Abstractions.INetworkDiscoverer.

void LinkOS.Plugin.NetworkDiscovererImplementation.FindPrinters ( IDiscoveryHandler discoveryHandler )

inline

This method will search the network using a combination of discovery methods to find printers on the network. This is a convenience method that can be used as an alternative to the other discovery methods (e.g. multicast) This method will invoke the DiscoveryHandler.OnFoundPrinter event for each printer that is found during discovery. DiscoveryHandler.OnDiscoveryFinished will be invoked when the discovery is finished and DiscoveryHandler.OnDiscoveryError will be invoked when any errors are encountered during discovery. When DiscoveryHandler.OnDiscoveryError is invoked, the discovery will be canceled and DiscoveryHandler.OnDiscoveryFinished will not be invoked. If a printer responds to the discovery request more than once, the DiscoveryHandler.OnFoundPrinter event will only be invoked on the first occurrence.

Parameters

discoveryHandler a DiscoveryHandler instance that is used to handle discovery events (e.g. found a printer, errors, discovery finished).

Implements LinkOS.Plugin.Abstractions.INetworkDiscoverer.

void LinkOS.Plugin.NetworkDiscovererImplementation.FindPrinters	(	IDiscoveryHandler	discoveryHandler,
		string[]	printersToFind,
		int	waitForResponsesTimeout = `3000`
	)

inline

Sends a discovery request to the list of printer DNS names or IPs in printersToFind. This method will invoke the DiscoveryHandler.OnFoundPrinter method for each printer that is found during discovery. DiscoveryHandler.OnDiscoveryFinished will be invoked when the discovery is finished and DiscoveryHandler.OnDiscoveryError will be invoked when any errors are encountered during discovery. If a printer responds to the discovery request more than once, the DiscoveryHandler.OnFoundPrinter event will only be invoked on the first occurrence.

Parameters

discoveryHandler	a DiscoveryHandler instance that is used to handle discovery events (e.g. found a printer, errors, discovery finished).
printersToFind	A list of IP addresses or DNS names for the printers to be discovered.
waitForResponsesTimeout	time to wait, in milliseconds, before determining that there are no more discovery responses.

Implements LinkOS.Plugin.Abstractions.INetworkDiscoverer.

void LinkOS.Plugin.NetworkDiscovererImplementation.LocalBroadcast	(	IDiscoveryHandler	discoveryHandler,
		int	waitForResponsesTimeout = `3000`
	)

inline

Sends a local broadcast packet. This method will wait up to waitForResponsesTimeout milliseconds determining that there are no more discovery responses. This method will invoke the DiscoveryHandler.OnFoundPrinter event for each printer that is found during discovery. DiscoveryHandler.OnDiscoveryFinished will be invoked when the discovery is finished and DiscoveryHandler.OnDiscoveryError will be invoked when any errors are encountered during discovery. When DiscoveryHandler.OnDiscoveryError is invoked, the discovery will be canceled and DiscoveryHandler.OnDiscoveryFinished will not be invoked. If a printer responds to the discovery request more than once, the DiscoveryHandler.OnFoundPrinter event will only be invoked on the first occurrence.

Parameters

discoveryHandler	a DiscoveryHandler instance that is used to handle discovery events (e.g. found a printer, errors, discovery finished).
waitForResponsesTimeout	time to wait, in milliseconds, before determining that there are no more discovery responses.

Implements LinkOS.Plugin.Abstractions.INetworkDiscoverer.

void LinkOS.Plugin.NetworkDiscovererImplementation.Multicast	(	IDiscoveryHandler	discoveryHandler,
		int	hops,
		object	androidContext,
		int	waitForResponsesTimeout = `3000`
	)

inline

Sends a multicast discovery packet. This method will wait up to waitForResponsesTimeout milliseconds determining that there are no more discovery responses. If a printer responds to the discovery request more than once, the DiscoveryHandler.OnFoundPrinter event will only be invoked on the first occurrence.

Parameters

discoveryHandler	a DiscoveryHandler instance that is used to handle discovery events (e.g. found a printer, errors, discovery finished).
hops	number of hops.
androidContext	the Android context, set to null in iOS
waitForResponsesTimeout	time to wait, in milliseconds, before determining that there are no more discovery responses.

Implements LinkOS.Plugin.Abstractions.INetworkDiscoverer.

void LinkOS.Plugin.NetworkDiscovererImplementation.SubnetSearch	(	IDiscoveryHandler	discoveryHandler,
		string	subnetRange,
		int	waitForResponsesTimeout = `3000`
	)

inline

Sends a discovery packet to the IPs specified in the subnetRange. This method will wait up to waitForResponsesTimeout milliseconds determining that there are no more discovery responses. Subnet searches are defined by the first three subnet octets, followed by a range, such as 192.168.2. This method accepts IP addresses of the form, assuming a subnet of 192.168.2: 192.168.2.254 (will send a discovery packet to 192.168.2.254) 192.168.2.* (will send a discovery packet for the range 192.168.2.1 - 192.168.2.254) 192.168.2.8-* (will send a discovery packet for the range 192.168.2.8 - 192.168.2.254) 192.168.2.37-42 (will send a discovery packet for the range 192.168.2.37 - 192.168.2.42) This method will invoke the DiscoveryHandler.OnFoundPrinter method for each printer that is found during discovery. DiscoveryHandler.OnDiscoveryFinished will be invoked when the discovery is finished and DiscoveryHandler.OnDiscoveryError will be invoked when any errors are encountered during discovery. If a printer responds to the discovery request more than once, the DiscoveryHandler.OnFoundPrinter event will only be invoked on the first occurrence.

Parameters

discoveryHandler	a DiscoveryHandler instance that is used to handle discovery events (e.g. found a printer, errors, discovery finished).
subnetRange	the subnet search range
waitForResponsesTimeout	time to wait, in milliseconds, before determining that there are no more discovery responses.

Implements LinkOS.Plugin.Abstractions.INetworkDiscoverer.

The documentation for this class was generated from the following file:

C:/repos/xamarin-sdk/Link_OS_SDK_for_Xamarin_Portable/LinkOS/LinkOS.Plugin.Android/NetworkDiscovererImplementation.cs

Public Member Functions

Detailed Description

Member Function Documentation