Custom Proxy Filter initialization

[philips77]

This PR tries to solve #386 in a way proposed in #386 (comment).

Alternative solution have been proposed in #387 and #388.

Pros of proposed solution:

• Does not require extending ProxyFilter with own implementation, and still allows setting .inclusionList or .exclusionList with custom addresses.
• Comparing to original version, a custom init state of Proxy Filter can be set.

Cons:

• I can imaging a custom implementation can have more features.

Breaking change

• The proxyFilter member of MeshNetworkManager has been changed from Optional to Non-Optional.

Other

• A bug has been fixed where network manager and proxy filter had strong references to each other.

[philips77]

@bspinner @Eklow02 @adriansergheev
Any comments? There are now 3 PRs solving the same issue :)

[philips77]

Note: This has not been tested yet, as I don't have my DK with me today.

[adriansergheev]

I could not figure it out, but it seems that it is still needed to call setType on ProxyFilter instance which is not optimal. I don't see at a quick glance how to make it initialized with .exclusionList for example,
Thanks,

[philips77]

let manager = MeshNetworkManager(...)
manager.proxyFilter.initialState = .exclusionList([])

IOS-nRF-Mesh-Library/nRFMeshProvision/Classes/ProxyFilter.swift

Line 135 in e37bd83

public var initialState: ProxyFilterSetup = .automatic

[philips77]

The initial state can be changed many times and it's read each time the phone connects to a new Proxy Node.

[adriansergheev]

thanks a lot for the tip, I thought I saw private(set) in there,
tested with empty exclusion list, works as expected.

[bspinner]

@philips77 Sorry for late reply.

We are just about to up our usage of group addresses and will have to change the proxy filter more often.
Being able to do so without having to reconnect would be nice.
Since I don't know whether this is a special requirement or not, I would welcome the ability to define custom proxy filter behaviour, as implemented in #388.

[philips77]

With the proposed changes you may set initial setup to required value and change it whenever you want. It will be applied to each new connected node after the setup has changed.
During a connection you may modify the proxy filter with already existing methods, like add or remove.

I understand you need to know when the proxy gets disconnected/a new proxy gets connected so you could assign the right list?

[bspinner]

Ah, sorry, I forgot about add/remove. I'll try to integrate and test this PR with our app.

[bspinner]

@philips77 I tried to migrate to this solution today. One thing I'm missing from #388 is a new callback of ProxyFilterDelegate:

https://github.com/bspinner/IOS-nRF-Mesh-Library/blob/allow_custom_proxyfilter_implementations/nRFMeshProvision/Classes/ProxyFilter/ProxyFilter.swift#L66

It gets called when the proxy node acknowledged the proxy configuration message.
If I recall correctly, the already existing proxyFilterUpdated callback is triggered earlier, i.e. when the message has been sent but not yet acknowledged.

In my PR the new callback is called in two places:
https://github.com/bspinner/IOS-nRF-Mesh-Library/blob/allow_custom_proxyfilter_implementations/nRFMeshProvision/Classes/ProxyFilter/DefaultProxyFilter.swift#L299
https://github.com/bspinner/IOS-nRF-Mesh-Library/blob/allow_custom_proxyfilter_implementations/nRFMeshProvision/Classes/ProxyFilter/DefaultProxyFilter.swift#L334

I didn't want to break behaviour for existing users of ProxyFilterDelegate and therefore added a function.
So maybe we can just modify handling of proxyFilterUpdated instead of adding a new callback?

[bspinner]

@philips77 Any thoughts?

[philips77]

Hello, sorry, I was busy with other project. I don't see reason why not to add such callback.
I'll resume working on mesh in few weeks, hopefully. You may try creating a PR to this PR with desired changes, which may be quicker.

[philips77]

OK, I'm on it. I shall release this week.