 |
Diffusion Apple API
6.9.0
Unified Client Library for iOS, tvOS and OS X / macOS
|
|
Diffusion Apple API
6.9.0
Unified Client Library for iOS, tvOS and OS X / macOS
|
A Remote Server builder.
A builder of this type is used to create instances of PTDiffusionRemoteServer that can be supplied to createRemoteServer:.
Instance Methods | |
| (instancetype) | - reset |
| (instancetype) | - principal: |
| (instancetype) | - credentials: |
| (instancetype) | - connectionOptions: |
| (instancetype) | - connectionOption:withValue: |
| (instancetype) | - missingTopicNotificationFilter: |
| (PTDiffusionRemoteServer *) | - createWithName:andURL: |
| - (instancetype) connectionOption: | (PTDiffusionRemoteServerConnectionOption *) | option | |
| withValue: | (NSString *_Nullable) | value | |
Specifies a single connection option.
This will add to the options currently specified to the builder, or replace a value if it has already been specified.
| option | the connection option. |
| value | the connection option value or null to remove the option. |
| - (instancetype) connectionOptions: | (NSDictionary< PTDiffusionRemoteServerConnectionOption *, NSString * > *_Nullable) | connectionOptions |
Specifies a map of PTDiffusionRermoteServerConnectionOption settings.
This will replace any options currently set for the builder.
Any options not supplied will take their default values.
If no connection options are specified, either using this method or PTDiffusionRemoteServerBuilder#connectionOption:withValue: then all options will take their default values.
| connectionOptions | the map of options. |
| - (PTDiffusionRemoteServer *) createWithName: | (NSString *) | name | |
| andURL: | (NSString *) | url | |
Creates a remote server object using the current values known to this builder.
| name | the name of the remote server. |
| url | the URL to use to connect to the primary server. |
| - (instancetype) credentials: | (PTDiffusionCredentials *_Nullable) | credentials |
Specifies the credentials to use when connecting to the primary server.
The default, if not specified, is PTDiffusionCredentials.noCredentials.
| credentials | the credentials to use. |
| - (instancetype) missingTopicNotificationFilter: | (NSString *_Nullable) | filter |
Specifies a topic selector expression which will filter missing topic notifications propagated from secondary to primary servers.
PTDiffusionMissingTopicNotifications are notified when a client subscribes using a topic selector that matches no existing topics. By specifying a missing topic notification filter, all notifications that match the filter on the secondary server will be propagated to the primary server.
A match occurs if the path prefix of the subscription selector matches the path prefix of the specified selector.
If no filter is specified then no missing topic notifications will be propagated.
The special selector expression *.* may be used to indicate that all missing topic notifications should be propagated.
Only the path prefix of the specified selector(s) is considered when matching therefore, any use of regular expressions would be ignored.
| filter | a topic selector expression specifying the filter to apply or null to remove any existing filter. |
| - (instancetype) principal: | (NSString *_Nullable) | principal |
Specifies the name of a principal used by the remote server to connect to the primary server.
The default, if not specified, is the anonymous principal.
| principal | principal name of a zero length string to indicate an anonymous connection. |
| - (instancetype) reset |
Reset the builder.
1.8.5
