Interface ISecondaryBuilder<T>
Base builder interface for ISecondaryServer.
A builder of this type cannot be instantiated.
Inherited Members
Namespace: PushTechnology.ClientInterface.Client.Features.Control.Clients
Assembly: Diffusion.Client.dll
Syntax
public interface ISecondaryBuilder<T> : IRemoteServerBuilder<T>
Type Parameters
Name | Description |
---|---|
T | The builder type. |
Methods
ConnectionOption(RemoteServerConnectionOption, String)
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.
Not all remote server types support all options. See RemoteServerConnectionOption for details.
Declaration
T ConnectionOption(RemoteServerConnectionOption connectionOption, string value)
Parameters
Type | Name | Description |
---|---|---|
RemoteServerConnectionOption | connectionOption | The connection option. |
String | value | The connection option value or null to remove the option. |
Returns
Type | Description |
---|---|
T | This builder. |
ConnectionOptions(Dictionary<RemoteServerConnectionOption, String>)
Specifies a dictionary of RemoteServerConnectionOption 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 RemoteServerConnectionOption then all options will take their default value.
Not all remote server types support all options. See RemoteServerConnectionOption for details.
Declaration
T ConnectionOptions(Dictionary<RemoteServerConnectionOption, string> connectionOptions)
Parameters
Type | Name | Description |
---|---|---|
Dictionary<RemoteServerConnectionOption, String> | connectionOptions | Dictionary of options. |
Returns
Type | Description |
---|---|
T | This builder. |
Credentials(ICredentials)
Specifies the credentials to use to authenticate the connection.
The default, if not specified, is PushTechnology.DiffusionCore.Client.Types.Credentials.NO_CREDENTIALS.
This is used along with the specified principal Principal(String).
Declaration
T Credentials(ICredentials credentials)
Parameters
Type | Name | Description |
---|---|---|
ICredentials | credentials | The credentials to use. |
Returns
Type | Description |
---|---|
T | This builder. |
MissingTopicNotificationFilter(String)
Specifies a topic selector expression which will filter missing topic notifications propagated from secondary to primary server.
MissingTopicNotifications IMissingTopicNotification 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 the selector is a SELECTOR_SET_PREFIX then the notification will be propagated if it matches any selector in the set.
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.
Declaration
T MissingTopicNotificationFilter(string filter)
Parameters
Type | Name | Description |
---|---|---|
String | filter | A topic selector expression specifying the filter to apply or null to remove any existing filter. |
Returns
Type | Description |
---|---|
T | This builder. |
Principal(String)
Specifies the name of a principal to use for the connection.
This specifies the principal for the connection to the primary server and is authenticated at the primary.
The default, if not specified, is the anonymous principal.
Declaration
T Principal(string principal)
Parameters
Type | Name | Description |
---|---|---|
String | principal | Principal name or a zero length string to indicate an anonymous connection. |
Returns
Type | Description |
---|---|
T | This builder. |