Interface IRemoteServerBuilder
Interface for a remote server builder. Since 6.7.
A builder of this type may be created using
Namespace: PushTechnology.ClientInterface.Client.Features.Control.Clients
Assembly: Diffusion.Client.dll
Syntax
public interface IRemoteServerBuilder
Methods
ConnectionOption(RemoteServerConnectionOption, String)
Specifies a single connection option.
Declaration
IRemoteServerBuilder 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 |
---|---|
IRemoteServerBuilder | This builder. |
ConnectionOptions(Dictionary<RemoteServerConnectionOption, String>)
Specifies a dictionary of RemoteServerConnectionOption settings.
Declaration
IRemoteServerBuilder ConnectionOptions(Dictionary<RemoteServerConnectionOption, string> connectionOptions)
Parameters
Type | Name | Description |
---|---|---|
Dictionary<RemoteServerConnectionOption, String> | connectionOptions | Dictionary of options. |
Returns
Type | Description |
---|---|
IRemoteServerBuilder | This builder. |
Create(String, String)
Creates a remote server object using the current values known to this builder.
Declaration
IRemoteServer Create(string name, string url)
Parameters
Type | Name | Description |
---|---|---|
String | name | The name of the remote server. |
String | url | The URL to use to connect to the primary server. |
Returns
Type | Description |
---|---|
IRemoteServer | A new remote server instance. |
Credentials(ICredentials)
Specifies the credentials to use when connecting to the primary server.
Declaration
IRemoteServerBuilder Credentials(ICredentials credentials)
Parameters
Type | Name | Description |
---|---|---|
ICredentials | credentials | The credentials to use. |
Returns
Type | Description |
---|---|
IRemoteServerBuilder | This builder. |
MissingTopicNotificationFilter(String)
Specifies a topic selector expression which will filter missing topic notifications propagated from secondary to primary server.
Declaration
IRemoteServerBuilder 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 |
---|---|
IRemoteServerBuilder | This builder. |
Principal(String)
Specifies the name of a principal used by the remote server to connect to the primary server.
Declaration
IRemoteServerBuilder Principal(string principal)
Parameters
Type | Name | Description |
---|---|---|
String | principal | Principal name or a zero length string to indicate an anonymous connection. |
Returns
Type | Description |
---|---|
IRemoteServerBuilder | This builder. |
Reset()
Reset the builder.
Declaration
IRemoteServerBuilder Reset()
Returns
Type | Description |
---|---|
IRemoteServerBuilder | This builder. |