HostInfo IP MembersNetworkComms.Net Help
The HostInfo IP type exposes the following members.
Methods

  NameDescription
Public methodStatic memberAverageNetworkLoadIncoming
Returns the averaged value of CurrentNetworkLoadIncoming, as a value between 0 and 1, for a time window of up to 254 seconds. Triggers load analysis upon first call.
Public methodStatic memberAverageNetworkLoadOutgoing
Returns the averaged value of CurrentNetworkLoadIncoming, as a value between 0 and 1, for a time window of up to 254 seconds. Triggers load analysis upon first call.
Public methodStatic memberFilteredLocalAddresses 
Returns all allowed local IP addresses. Caches results for up to 5 second since the previous refresh. If RestrictLocalAdaptorNames has been set only returns IP addresses corresponding with specified adaptors. If RestrictLocalAddressRanges has been set only returns matching addresses ordered in descending preference. i.e. Most preferred at [0].
Public methodStatic memberFilteredLocalAddresses(Boolean)
Returns all allowed local IP addresses. Caches results for up to 5 second since the previous refresh unless forceCacheUpdate is true. If RestrictLocalAdaptorNames has been set only returns IP addresses corresponding with specified adaptors. If RestrictLocalAddressRanges has been set only returns matching addresses ordered in descending preference. i.e. Most preferred at [0].
Back to Top
Properties

  NameDescription
Public propertyStatic memberCurrentNetworkLoadIncoming
Returns the current instance network usage, as a value between 0 and 1. Returns the largest value for any available network adaptor. Triggers load analysis upon first call.
Public propertyStatic memberCurrentNetworkLoadOutgoing
Returns the current instance network usage, as a value between 0 and 1. Returns the largest value for any available network adaptor. Triggers load analysis upon first call.
Public propertyStatic memberInterfaceLinkSpeed
The interface link speed in bits/sec used for network load calculations. Default is 100Mb/sec
Public propertyStatic memberNetworkLoadUpdateWindowMS
The number of milliseconds over which to take an instance load (CurrentNetworkLoad) to be used in averaged values (AverageNetworkLoad). Default is 2000ms. Shorter values can be used but less than 200ms may cause significant errors in the value of returned value, especially in mono environments.
Public propertyStatic memberRestrictLocalAddressRanges
Restricts the IPAdddresses that are returned by FilteredLocalAddresses . If using StartListening overrides that do not take IPEndPoints NetworkComms.Net will only listen on IP Addresses within provided ranges. Also see RestrictLocalAdaptorNames. The order of provided ranges determines the order of IPAddresses returned by FilteredLocalAddresses .
Back to Top
See Also